blob: 1fe938f06c438bc8566af12b10f669f0a4d90bef [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
1048 if not self:
1049 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001050 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001051 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001052 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001053
1054 if context is None:
1055 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001056 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001057
1058 def __pos__(self, context=None):
1059 """Returns a copy, unless it is a sNaN.
1060
1061 Rounds the number (if more then precision digits)
1062 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001063 if self._is_special:
1064 ans = self._check_nans(context=context)
1065 if ans:
1066 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001067
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001068 if not self:
1069 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001070 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001071 else:
1072 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001073
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001074 if context is None:
1075 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001076 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001077
Christian Heimes2c181612007-12-17 20:04:13 +00001078 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001079 """Returns the absolute value of self.
1080
Christian Heimes2c181612007-12-17 20:04:13 +00001081 If the keyword argument 'round' is false, do not round. The
1082 expression self.__abs__(round=False) is equivalent to
1083 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001084 """
Christian Heimes2c181612007-12-17 20:04:13 +00001085 if not round:
1086 return self.copy_abs()
1087
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001088 if self._is_special:
1089 ans = self._check_nans(context=context)
1090 if ans:
1091 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001092
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001093 if self._sign:
1094 ans = self.__neg__(context=context)
1095 else:
1096 ans = self.__pos__(context=context)
1097
1098 return ans
1099
1100 def __add__(self, other, context=None):
1101 """Returns self + other.
1102
1103 -INF + INF (or the reverse) cause InvalidOperation errors.
1104 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001105 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001106 if other is NotImplemented:
1107 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001108
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001109 if context is None:
1110 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._is_special or other._is_special:
1113 ans = self._check_nans(other, context)
1114 if ans:
1115 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001117 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001119 if self._sign != other._sign and other._isinfinity():
1120 return context._raise_error(InvalidOperation, '-INF + INF')
1121 return Decimal(self)
1122 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001123 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001125 exp = min(self._exp, other._exp)
1126 negativezero = 0
1127 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001128 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001129 negativezero = 1
1130
1131 if not self and not other:
1132 sign = min(self._sign, other._sign)
1133 if negativezero:
1134 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001135 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001136 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001137 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001138 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001139 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001140 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001141 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142 return ans
1143 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001144 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001145 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001146 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147 return ans
1148
1149 op1 = _WorkRep(self)
1150 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001151 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152
1153 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001154 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001156 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001157 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001158 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001159 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001160 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001162 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001163 if op1.sign == 1:
1164 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 op1.sign, op2.sign = op2.sign, op1.sign
1166 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001167 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001168 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001169 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001171 op1.sign, op2.sign = (0, 0)
1172 else:
1173 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001174 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
Raymond Hettinger17931de2004-10-27 06:21:46 +00001176 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001177 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001179 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001180
1181 result.exp = op1.exp
1182 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001183 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001184 return ans
1185
1186 __radd__ = __add__
1187
1188 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001189 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001190 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001191 if other is NotImplemented:
1192 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001194 if self._is_special or other._is_special:
1195 ans = self._check_nans(other, context=context)
1196 if ans:
1197 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001198
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001199 # self - other is computed as self + other.copy_negate()
1200 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
1202 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001203 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001204 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001205 if other is NotImplemented:
1206 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001208 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001209
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001210 def __mul__(self, other, context=None):
1211 """Return self * other.
1212
1213 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1214 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001215 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001216 if other is NotImplemented:
1217 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001218
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219 if context is None:
1220 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001222 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001223
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001224 if self._is_special or other._is_special:
1225 ans = self._check_nans(other, context)
1226 if ans:
1227 return ans
1228
1229 if self._isinfinity():
1230 if not other:
1231 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001232 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001233
1234 if other._isinfinity():
1235 if not self:
1236 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001237 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001238
1239 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001240
1241 # Special case for multiplying by zero
1242 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001243 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001244 # Fixing in case the exponent is out of bounds
1245 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001246 return ans
1247
1248 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001249 if self._int == '1':
1250 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001251 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001252 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001253 if other._int == '1':
1254 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001255 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001256 return ans
1257
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001258 op1 = _WorkRep(self)
1259 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001260
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001261 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001262 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263
1264 return ans
1265 __rmul__ = __mul__
1266
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001267 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001268 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001269 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001270 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001271 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273 if context is None:
1274 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001275
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001276 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001277
1278 if self._is_special or other._is_special:
1279 ans = self._check_nans(other, context)
1280 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001281 return ans
1282
1283 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001284 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001285
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001287 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001288
1289 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001290 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001291 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292
1293 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001294 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001295 if not self:
1296 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001297 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001298
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001299 if not self:
1300 exp = self._exp - other._exp
1301 coeff = 0
1302 else:
1303 # OK, so neither = 0, INF or NaN
1304 shift = len(other._int) - len(self._int) + context.prec + 1
1305 exp = self._exp - other._exp - shift
1306 op1 = _WorkRep(self)
1307 op2 = _WorkRep(other)
1308 if shift >= 0:
1309 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1310 else:
1311 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1312 if remainder:
1313 # result is not exact; adjust to ensure correct rounding
1314 if coeff % 5 == 0:
1315 coeff += 1
1316 else:
1317 # result is exact; get as close to ideal exponent as possible
1318 ideal_exp = self._exp - other._exp
1319 while exp < ideal_exp and coeff % 10 == 0:
1320 coeff //= 10
1321 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001322
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001323 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001325
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001326 def _divide(self, other, context):
1327 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001328
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001329 Assumes that neither self nor other is a NaN, that self is not
1330 infinite and that other is nonzero.
1331 """
1332 sign = self._sign ^ other._sign
1333 if other._isinfinity():
1334 ideal_exp = self._exp
1335 else:
1336 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001337
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001338 expdiff = self.adjusted() - other.adjusted()
1339 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001340 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001341 self._rescale(ideal_exp, context.rounding))
1342 if expdiff <= context.prec:
1343 op1 = _WorkRep(self)
1344 op2 = _WorkRep(other)
1345 if op1.exp >= op2.exp:
1346 op1.int *= 10**(op1.exp - op2.exp)
1347 else:
1348 op2.int *= 10**(op2.exp - op1.exp)
1349 q, r = divmod(op1.int, op2.int)
1350 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001351 return (_dec_from_triple(sign, str(q), 0),
1352 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001353
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001354 # Here the quotient is too large to be representable
1355 ans = context._raise_error(DivisionImpossible,
1356 'quotient too large in //, % or divmod')
1357 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001358
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001359 def __rtruediv__(self, other, context=None):
1360 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001361 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001362 if other is NotImplemented:
1363 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001364 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001365
1366 def __divmod__(self, other, context=None):
1367 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001368 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001369 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001370 other = _convert_other(other)
1371 if other is NotImplemented:
1372 return other
1373
1374 if context is None:
1375 context = getcontext()
1376
1377 ans = self._check_nans(other, context)
1378 if ans:
1379 return (ans, ans)
1380
1381 sign = self._sign ^ other._sign
1382 if self._isinfinity():
1383 if other._isinfinity():
1384 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1385 return ans, ans
1386 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001387 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001388 context._raise_error(InvalidOperation, 'INF % x'))
1389
1390 if not other:
1391 if not self:
1392 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1393 return ans, ans
1394 else:
1395 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1396 context._raise_error(InvalidOperation, 'x % 0'))
1397
1398 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001399 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001400 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001401
1402 def __rdivmod__(self, other, context=None):
1403 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001404 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001405 if other is NotImplemented:
1406 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001407 return other.__divmod__(self, context=context)
1408
1409 def __mod__(self, other, context=None):
1410 """
1411 self % other
1412 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001413 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001414 if other is NotImplemented:
1415 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001416
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001417 if context is None:
1418 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001419
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001420 ans = self._check_nans(other, context)
1421 if ans:
1422 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001423
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001424 if self._isinfinity():
1425 return context._raise_error(InvalidOperation, 'INF % x')
1426 elif not other:
1427 if self:
1428 return context._raise_error(InvalidOperation, 'x % 0')
1429 else:
1430 return context._raise_error(DivisionUndefined, '0 % 0')
1431
1432 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001433 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001434 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001435
1436 def __rmod__(self, other, context=None):
1437 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001438 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001439 if other is NotImplemented:
1440 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001441 return other.__mod__(self, context=context)
1442
1443 def remainder_near(self, other, context=None):
1444 """
1445 Remainder nearest to 0- abs(remainder-near) <= other/2
1446 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001447 if context is None:
1448 context = getcontext()
1449
1450 other = _convert_other(other, raiseit=True)
1451
1452 ans = self._check_nans(other, context)
1453 if ans:
1454 return ans
1455
1456 # self == +/-infinity -> InvalidOperation
1457 if self._isinfinity():
1458 return context._raise_error(InvalidOperation,
1459 'remainder_near(infinity, x)')
1460
1461 # other == 0 -> either InvalidOperation or DivisionUndefined
1462 if not other:
1463 if self:
1464 return context._raise_error(InvalidOperation,
1465 'remainder_near(x, 0)')
1466 else:
1467 return context._raise_error(DivisionUndefined,
1468 'remainder_near(0, 0)')
1469
1470 # other = +/-infinity -> remainder = self
1471 if other._isinfinity():
1472 ans = Decimal(self)
1473 return ans._fix(context)
1474
1475 # self = 0 -> remainder = self, with ideal exponent
1476 ideal_exponent = min(self._exp, other._exp)
1477 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001478 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001479 return ans._fix(context)
1480
1481 # catch most cases of large or small quotient
1482 expdiff = self.adjusted() - other.adjusted()
1483 if expdiff >= context.prec + 1:
1484 # expdiff >= prec+1 => abs(self/other) > 10**prec
1485 return context._raise_error(DivisionImpossible)
1486 if expdiff <= -2:
1487 # expdiff <= -2 => abs(self/other) < 0.1
1488 ans = self._rescale(ideal_exponent, context.rounding)
1489 return ans._fix(context)
1490
1491 # adjust both arguments to have the same exponent, then divide
1492 op1 = _WorkRep(self)
1493 op2 = _WorkRep(other)
1494 if op1.exp >= op2.exp:
1495 op1.int *= 10**(op1.exp - op2.exp)
1496 else:
1497 op2.int *= 10**(op2.exp - op1.exp)
1498 q, r = divmod(op1.int, op2.int)
1499 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1500 # 10**ideal_exponent. Apply correction to ensure that
1501 # abs(remainder) <= abs(other)/2
1502 if 2*r + (q&1) > op2.int:
1503 r -= op2.int
1504 q += 1
1505
1506 if q >= 10**context.prec:
1507 return context._raise_error(DivisionImpossible)
1508
1509 # result has same sign as self unless r is negative
1510 sign = self._sign
1511 if r < 0:
1512 sign = 1-sign
1513 r = -r
1514
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001515 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001516 return ans._fix(context)
1517
1518 def __floordiv__(self, other, context=None):
1519 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001520 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001521 if other is NotImplemented:
1522 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001524 if context is None:
1525 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001526
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001527 ans = self._check_nans(other, context)
1528 if ans:
1529 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001530
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001531 if self._isinfinity():
1532 if other._isinfinity():
1533 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001534 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001535 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001536
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001537 if not other:
1538 if self:
1539 return context._raise_error(DivisionByZero, 'x // 0',
1540 self._sign ^ other._sign)
1541 else:
1542 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001544 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001545
1546 def __rfloordiv__(self, other, context=None):
1547 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001548 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001549 if other is NotImplemented:
1550 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001551 return other.__floordiv__(self, context=context)
1552
1553 def __float__(self):
1554 """Float representation."""
1555 return float(str(self))
1556
1557 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001558 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001559 if self._is_special:
1560 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001561 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001562 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001563 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001564 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001565 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001566 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001567 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001568 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001569
Christian Heimes969fe572008-01-25 11:23:10 +00001570 __trunc__ = __int__
1571
Christian Heimes0bd4e112008-02-12 22:59:25 +00001572 def real(self):
1573 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001574 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001575
Christian Heimes0bd4e112008-02-12 22:59:25 +00001576 def imag(self):
1577 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001578 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001579
1580 def conjugate(self):
1581 return self
1582
1583 def __complex__(self):
1584 return complex(float(self))
1585
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001586 def _fix_nan(self, context):
1587 """Decapitate the payload of a NaN to fit the context"""
1588 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001589
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001590 # maximum length of payload is precision if clamp=0,
1591 # precision-1 if clamp=1.
1592 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001593 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001594 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1595 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001596 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001598 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001599 """Round if it is necessary to keep self within prec precision.
1600
1601 Rounds and fixes the exponent. Does not raise on a sNaN.
1602
1603 Arguments:
1604 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001605 context - context used.
1606 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001607
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001608 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001609 if self._isnan():
1610 # decapitate payload if necessary
1611 return self._fix_nan(context)
1612 else:
1613 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001614 return Decimal(self)
1615
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001617 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001618 Etiny = context.Etiny()
1619 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001620 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001621 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001622 new_exp = min(max(self._exp, Etiny), exp_max)
1623 if new_exp != self._exp:
1624 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001625 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001626 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001627 return Decimal(self)
1628
1629 # exp_min is the smallest allowable exponent of the result,
1630 # equal to max(self.adjusted()-context.prec+1, Etiny)
1631 exp_min = len(self._int) + self._exp - context.prec
1632 if exp_min > Etop:
1633 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001634 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001635 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001636 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001637 return ans
1638
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001639 self_is_subnormal = exp_min < Etiny
1640 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001641 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001642
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001643 # round if self has too many digits
1644 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001645 digits = len(self._int) + self._exp - exp_min
1646 if digits < 0:
1647 self = _dec_from_triple(self._sign, '1', exp_min-1)
1648 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001649 rounding_method = self._pick_rounding_function[context.rounding]
1650 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001651 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001652 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001653 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001654 if len(coeff) > context.prec:
1655 coeff = coeff[:-1]
1656 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001657
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001658 # check whether the rounding pushed the exponent out of range
1659 if exp_min > Etop:
1660 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1661 else:
1662 ans = _dec_from_triple(self._sign, coeff, exp_min)
1663
1664 # raise the appropriate signals, taking care to respect
1665 # the precedence described in the specification
1666 if changed and self_is_subnormal:
1667 context._raise_error(Underflow)
1668 if self_is_subnormal:
1669 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001670 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001671 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001672 context._raise_error(Rounded)
1673 if not ans:
1674 # raise Clamped on underflow to 0
1675 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001676 return ans
1677
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001678 if self_is_subnormal:
1679 context._raise_error(Subnormal)
1680
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001681 # fold down if clamp == 1 and self has too few digits
1682 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001683 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001684 self_padded = self._int + '0'*(self._exp - Etop)
1685 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001686
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001687 # here self was representable to begin with; return unchanged
1688 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001689
1690 _pick_rounding_function = {}
1691
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001692 # for each of the rounding functions below:
1693 # self is a finite, nonzero Decimal
1694 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001695 #
1696 # each function returns either -1, 0, or 1, as follows:
1697 # 1 indicates that self should be rounded up (away from zero)
1698 # 0 indicates that self should be truncated, and that all the
1699 # digits to be truncated are zeros (so the value is unchanged)
1700 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001701
1702 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001703 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001704 if _all_zeros(self._int, prec):
1705 return 0
1706 else:
1707 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001708
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001709 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001711 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001713 def _round_half_up(self, prec):
1714 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001715 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001716 return 1
1717 elif _all_zeros(self._int, prec):
1718 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001719 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001720 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001721
1722 def _round_half_down(self, prec):
1723 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001724 if _exact_half(self._int, prec):
1725 return -1
1726 else:
1727 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001728
1729 def _round_half_even(self, prec):
1730 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001731 if _exact_half(self._int, prec) and \
1732 (prec == 0 or self._int[prec-1] in '02468'):
1733 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001734 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001735 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001736
1737 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001738 """Rounds up (not away from 0 if negative.)"""
1739 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001740 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001742 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001744 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001745 """Rounds down (not towards 0 if negative)"""
1746 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001747 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001749 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001750
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001751 def _round_05up(self, prec):
1752 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001753 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001754 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001755 else:
1756 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001757
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001758 def __round__(self, n=None):
1759 """Round self to the nearest integer, or to a given precision.
1760
1761 If only one argument is supplied, round a finite Decimal
1762 instance self to the nearest integer. If self is infinite or
1763 a NaN then a Python exception is raised. If self is finite
1764 and lies exactly halfway between two integers then it is
1765 rounded to the integer with even last digit.
1766
1767 >>> round(Decimal('123.456'))
1768 123
1769 >>> round(Decimal('-456.789'))
1770 -457
1771 >>> round(Decimal('-3.0'))
1772 -3
1773 >>> round(Decimal('2.5'))
1774 2
1775 >>> round(Decimal('3.5'))
1776 4
1777 >>> round(Decimal('Inf'))
1778 Traceback (most recent call last):
1779 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001780 OverflowError: cannot round an infinity
1781 >>> round(Decimal('NaN'))
1782 Traceback (most recent call last):
1783 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001784 ValueError: cannot round a NaN
1785
1786 If a second argument n is supplied, self is rounded to n
1787 decimal places using the rounding mode for the current
1788 context.
1789
1790 For an integer n, round(self, -n) is exactly equivalent to
1791 self.quantize(Decimal('1En')).
1792
1793 >>> round(Decimal('123.456'), 0)
1794 Decimal('123')
1795 >>> round(Decimal('123.456'), 2)
1796 Decimal('123.46')
1797 >>> round(Decimal('123.456'), -2)
1798 Decimal('1E+2')
1799 >>> round(Decimal('-Infinity'), 37)
1800 Decimal('NaN')
1801 >>> round(Decimal('sNaN123'), 0)
1802 Decimal('NaN123')
1803
1804 """
1805 if n is not None:
1806 # two-argument form: use the equivalent quantize call
1807 if not isinstance(n, int):
1808 raise TypeError('Second argument to round should be integral')
1809 exp = _dec_from_triple(0, '1', -n)
1810 return self.quantize(exp)
1811
1812 # one-argument form
1813 if self._is_special:
1814 if self.is_nan():
1815 raise ValueError("cannot round a NaN")
1816 else:
1817 raise OverflowError("cannot round an infinity")
1818 return int(self._rescale(0, ROUND_HALF_EVEN))
1819
1820 def __floor__(self):
1821 """Return the floor of self, as an integer.
1822
1823 For a finite Decimal instance self, return the greatest
1824 integer n such that n <= self. If self is infinite or a NaN
1825 then a Python exception is raised.
1826
1827 """
1828 if self._is_special:
1829 if self.is_nan():
1830 raise ValueError("cannot round a NaN")
1831 else:
1832 raise OverflowError("cannot round an infinity")
1833 return int(self._rescale(0, ROUND_FLOOR))
1834
1835 def __ceil__(self):
1836 """Return the ceiling of self, as an integer.
1837
1838 For a finite Decimal instance self, return the least integer n
1839 such that n >= self. If self is infinite or a NaN then a
1840 Python exception is raised.
1841
1842 """
1843 if self._is_special:
1844 if self.is_nan():
1845 raise ValueError("cannot round a NaN")
1846 else:
1847 raise OverflowError("cannot round an infinity")
1848 return int(self._rescale(0, ROUND_CEILING))
1849
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001850 def fma(self, other, third, context=None):
1851 """Fused multiply-add.
1852
1853 Returns self*other+third with no rounding of the intermediate
1854 product self*other.
1855
1856 self and other are multiplied together, with no rounding of
1857 the result. The third operand is then added to the result,
1858 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001859 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001860
1861 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001862
1863 # compute product; raise InvalidOperation if either operand is
1864 # a signaling NaN or if the product is zero times infinity.
1865 if self._is_special or other._is_special:
1866 if context is None:
1867 context = getcontext()
1868 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001869 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001870 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001871 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001872 if self._exp == 'n':
1873 product = self
1874 elif other._exp == 'n':
1875 product = other
1876 elif self._exp == 'F':
1877 if not other:
1878 return context._raise_error(InvalidOperation,
1879 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001880 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001881 elif other._exp == 'F':
1882 if not self:
1883 return context._raise_error(InvalidOperation,
1884 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001885 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001886 else:
1887 product = _dec_from_triple(self._sign ^ other._sign,
1888 str(int(self._int) * int(other._int)),
1889 self._exp + other._exp)
1890
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001891 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001892 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001893
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001894 def _power_modulo(self, other, modulo, context=None):
1895 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001896
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001897 # if can't convert other and modulo to Decimal, raise
1898 # TypeError; there's no point returning NotImplemented (no
1899 # equivalent of __rpow__ for three argument pow)
1900 other = _convert_other(other, raiseit=True)
1901 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001902
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001903 if context is None:
1904 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001905
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001906 # deal with NaNs: if there are any sNaNs then first one wins,
1907 # (i.e. behaviour for NaNs is identical to that of fma)
1908 self_is_nan = self._isnan()
1909 other_is_nan = other._isnan()
1910 modulo_is_nan = modulo._isnan()
1911 if self_is_nan or other_is_nan or modulo_is_nan:
1912 if self_is_nan == 2:
1913 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001914 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001915 if other_is_nan == 2:
1916 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001917 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918 if modulo_is_nan == 2:
1919 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001920 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001921 if self_is_nan:
1922 return self._fix_nan(context)
1923 if other_is_nan:
1924 return other._fix_nan(context)
1925 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001926
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001927 # check inputs: we apply same restrictions as Python's pow()
1928 if not (self._isinteger() and
1929 other._isinteger() and
1930 modulo._isinteger()):
1931 return context._raise_error(InvalidOperation,
1932 'pow() 3rd argument not allowed '
1933 'unless all arguments are integers')
1934 if other < 0:
1935 return context._raise_error(InvalidOperation,
1936 'pow() 2nd argument cannot be '
1937 'negative when 3rd argument specified')
1938 if not modulo:
1939 return context._raise_error(InvalidOperation,
1940 'pow() 3rd argument cannot be 0')
1941
1942 # additional restriction for decimal: the modulus must be less
1943 # than 10**prec in absolute value
1944 if modulo.adjusted() >= context.prec:
1945 return context._raise_error(InvalidOperation,
1946 'insufficient precision: pow() 3rd '
1947 'argument must not have more than '
1948 'precision digits')
1949
1950 # define 0**0 == NaN, for consistency with two-argument pow
1951 # (even though it hurts!)
1952 if not other and not self:
1953 return context._raise_error(InvalidOperation,
1954 'at least one of pow() 1st argument '
1955 'and 2nd argument must be nonzero ;'
1956 '0**0 is not defined')
1957
1958 # compute sign of result
1959 if other._iseven():
1960 sign = 0
1961 else:
1962 sign = self._sign
1963
1964 # convert modulo to a Python integer, and self and other to
1965 # Decimal integers (i.e. force their exponents to be >= 0)
1966 modulo = abs(int(modulo))
1967 base = _WorkRep(self.to_integral_value())
1968 exponent = _WorkRep(other.to_integral_value())
1969
1970 # compute result using integer pow()
1971 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1972 for i in range(exponent.exp):
1973 base = pow(base, 10, modulo)
1974 base = pow(base, exponent.int, modulo)
1975
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001976 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001977
1978 def _power_exact(self, other, p):
1979 """Attempt to compute self**other exactly.
1980
1981 Given Decimals self and other and an integer p, attempt to
1982 compute an exact result for the power self**other, with p
1983 digits of precision. Return None if self**other is not
1984 exactly representable in p digits.
1985
1986 Assumes that elimination of special cases has already been
1987 performed: self and other must both be nonspecial; self must
1988 be positive and not numerically equal to 1; other must be
1989 nonzero. For efficiency, other._exp should not be too large,
1990 so that 10**abs(other._exp) is a feasible calculation."""
1991
1992 # In the comments below, we write x for the value of self and
1993 # y for the value of other. Write x = xc*10**xe and y =
1994 # yc*10**ye.
1995
1996 # The main purpose of this method is to identify the *failure*
1997 # of x**y to be exactly representable with as little effort as
1998 # possible. So we look for cheap and easy tests that
1999 # eliminate the possibility of x**y being exact. Only if all
2000 # these tests are passed do we go on to actually compute x**y.
2001
2002 # Here's the main idea. First normalize both x and y. We
2003 # express y as a rational m/n, with m and n relatively prime
2004 # and n>0. Then for x**y to be exactly representable (at
2005 # *any* precision), xc must be the nth power of a positive
2006 # integer and xe must be divisible by n. If m is negative
2007 # then additionally xc must be a power of either 2 or 5, hence
2008 # a power of 2**n or 5**n.
2009 #
2010 # There's a limit to how small |y| can be: if y=m/n as above
2011 # then:
2012 #
2013 # (1) if xc != 1 then for the result to be representable we
2014 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2015 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2016 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2017 # representable.
2018 #
2019 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2020 # |y| < 1/|xe| then the result is not representable.
2021 #
2022 # Note that since x is not equal to 1, at least one of (1) and
2023 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2024 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2025 #
2026 # There's also a limit to how large y can be, at least if it's
2027 # positive: the normalized result will have coefficient xc**y,
2028 # so if it's representable then xc**y < 10**p, and y <
2029 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2030 # not exactly representable.
2031
2032 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2033 # so |y| < 1/xe and the result is not representable.
2034 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2035 # < 1/nbits(xc).
2036
2037 x = _WorkRep(self)
2038 xc, xe = x.int, x.exp
2039 while xc % 10 == 0:
2040 xc //= 10
2041 xe += 1
2042
2043 y = _WorkRep(other)
2044 yc, ye = y.int, y.exp
2045 while yc % 10 == 0:
2046 yc //= 10
2047 ye += 1
2048
2049 # case where xc == 1: result is 10**(xe*y), with xe*y
2050 # required to be an integer
2051 if xc == 1:
Mark Dickinsona1236312010-07-08 19:03:34 +00002052 xe *= yc
2053 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2054 while xe % 10 == 0:
2055 xe //= 10
2056 ye += 1
2057 if ye < 0:
2058 return None
2059 exponent = xe * 10**ye
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002060 if y.sign == 1:
2061 exponent = -exponent
2062 # if other is a nonnegative integer, use ideal exponent
2063 if other._isinteger() and other._sign == 0:
2064 ideal_exponent = self._exp*int(other)
2065 zeros = min(exponent-ideal_exponent, p-1)
2066 else:
2067 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002068 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002069
2070 # case where y is negative: xc must be either a power
2071 # of 2 or a power of 5.
2072 if y.sign == 1:
2073 last_digit = xc % 10
2074 if last_digit in (2,4,6,8):
2075 # quick test for power of 2
2076 if xc & -xc != xc:
2077 return None
2078 # now xc is a power of 2; e is its exponent
2079 e = _nbits(xc)-1
2080 # find e*y and xe*y; both must be integers
2081 if ye >= 0:
2082 y_as_int = yc*10**ye
2083 e = e*y_as_int
2084 xe = xe*y_as_int
2085 else:
2086 ten_pow = 10**-ye
2087 e, remainder = divmod(e*yc, ten_pow)
2088 if remainder:
2089 return None
2090 xe, remainder = divmod(xe*yc, ten_pow)
2091 if remainder:
2092 return None
2093
2094 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2095 return None
2096 xc = 5**e
2097
2098 elif last_digit == 5:
2099 # e >= log_5(xc) if xc is a power of 5; we have
2100 # equality all the way up to xc=5**2658
2101 e = _nbits(xc)*28//65
2102 xc, remainder = divmod(5**e, xc)
2103 if remainder:
2104 return None
2105 while xc % 5 == 0:
2106 xc //= 5
2107 e -= 1
2108 if ye >= 0:
2109 y_as_integer = yc*10**ye
2110 e = e*y_as_integer
2111 xe = xe*y_as_integer
2112 else:
2113 ten_pow = 10**-ye
2114 e, remainder = divmod(e*yc, ten_pow)
2115 if remainder:
2116 return None
2117 xe, remainder = divmod(xe*yc, ten_pow)
2118 if remainder:
2119 return None
2120 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2121 return None
2122 xc = 2**e
2123 else:
2124 return None
2125
2126 if xc >= 10**p:
2127 return None
2128 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002129 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002130
2131 # now y is positive; find m and n such that y = m/n
2132 if ye >= 0:
2133 m, n = yc*10**ye, 1
2134 else:
2135 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2136 return None
2137 xc_bits = _nbits(xc)
2138 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2139 return None
2140 m, n = yc, 10**(-ye)
2141 while m % 2 == n % 2 == 0:
2142 m //= 2
2143 n //= 2
2144 while m % 5 == n % 5 == 0:
2145 m //= 5
2146 n //= 5
2147
2148 # compute nth root of xc*10**xe
2149 if n > 1:
2150 # if 1 < xc < 2**n then xc isn't an nth power
2151 if xc != 1 and xc_bits <= n:
2152 return None
2153
2154 xe, rem = divmod(xe, n)
2155 if rem != 0:
2156 return None
2157
2158 # compute nth root of xc using Newton's method
2159 a = 1 << -(-_nbits(xc)//n) # initial estimate
2160 while True:
2161 q, r = divmod(xc, a**(n-1))
2162 if a <= q:
2163 break
2164 else:
2165 a = (a*(n-1) + q)//n
2166 if not (a == q and r == 0):
2167 return None
2168 xc = a
2169
2170 # now xc*10**xe is the nth root of the original xc*10**xe
2171 # compute mth power of xc*10**xe
2172
2173 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2174 # 10**p and the result is not representable.
2175 if xc > 1 and m > p*100//_log10_lb(xc):
2176 return None
2177 xc = xc**m
2178 xe *= m
2179 if xc > 10**p:
2180 return None
2181
2182 # by this point the result *is* exactly representable
2183 # adjust the exponent to get as close as possible to the ideal
2184 # exponent, if necessary
2185 str_xc = str(xc)
2186 if other._isinteger() and other._sign == 0:
2187 ideal_exponent = self._exp*int(other)
2188 zeros = min(xe-ideal_exponent, p-len(str_xc))
2189 else:
2190 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002191 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002192
2193 def __pow__(self, other, modulo=None, context=None):
2194 """Return self ** other [ % modulo].
2195
2196 With two arguments, compute self**other.
2197
2198 With three arguments, compute (self**other) % modulo. For the
2199 three argument form, the following restrictions on the
2200 arguments hold:
2201
2202 - all three arguments must be integral
2203 - other must be nonnegative
2204 - either self or other (or both) must be nonzero
2205 - modulo must be nonzero and must have at most p digits,
2206 where p is the context precision.
2207
2208 If any of these restrictions is violated the InvalidOperation
2209 flag is raised.
2210
2211 The result of pow(self, other, modulo) is identical to the
2212 result that would be obtained by computing (self**other) %
2213 modulo with unbounded precision, but is computed more
2214 efficiently. It is always exact.
2215 """
2216
2217 if modulo is not None:
2218 return self._power_modulo(other, modulo, context)
2219
2220 other = _convert_other(other)
2221 if other is NotImplemented:
2222 return other
2223
2224 if context is None:
2225 context = getcontext()
2226
2227 # either argument is a NaN => result is NaN
2228 ans = self._check_nans(other, context)
2229 if ans:
2230 return ans
2231
2232 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2233 if not other:
2234 if not self:
2235 return context._raise_error(InvalidOperation, '0 ** 0')
2236 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002237 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002238
2239 # result has sign 1 iff self._sign is 1 and other is an odd integer
2240 result_sign = 0
2241 if self._sign == 1:
2242 if other._isinteger():
2243 if not other._iseven():
2244 result_sign = 1
2245 else:
2246 # -ve**noninteger = NaN
2247 # (-0)**noninteger = 0**noninteger
2248 if self:
2249 return context._raise_error(InvalidOperation,
2250 'x ** y with x negative and y not an integer')
2251 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002252 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002253
2254 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2255 if not self:
2256 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002257 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002259 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002260
2261 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002262 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002263 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002264 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002265 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002266 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002267
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002268 # 1**other = 1, but the choice of exponent and the flags
2269 # depend on the exponent of self, and on whether other is a
2270 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002271 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002272 if other._isinteger():
2273 # exp = max(self._exp*max(int(other), 0),
2274 # 1-context.prec) but evaluating int(other) directly
2275 # is dangerous until we know other is small (other
2276 # could be 1e999999999)
2277 if other._sign == 1:
2278 multiplier = 0
2279 elif other > context.prec:
2280 multiplier = context.prec
2281 else:
2282 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002283
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002284 exp = self._exp * multiplier
2285 if exp < 1-context.prec:
2286 exp = 1-context.prec
2287 context._raise_error(Rounded)
2288 else:
2289 context._raise_error(Inexact)
2290 context._raise_error(Rounded)
2291 exp = 1-context.prec
2292
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002293 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002294
2295 # compute adjusted exponent of self
2296 self_adj = self.adjusted()
2297
2298 # self ** infinity is infinity if self > 1, 0 if self < 1
2299 # self ** -infinity is infinity if self < 1, 0 if self > 1
2300 if other._isinfinity():
2301 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002302 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002303 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002304 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002305
2306 # from here on, the result always goes through the call
2307 # to _fix at the end of this function.
2308 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002309 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002310
2311 # crude test to catch cases of extreme overflow/underflow. If
2312 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2313 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2314 # self**other >= 10**(Emax+1), so overflow occurs. The test
2315 # for underflow is similar.
2316 bound = self._log10_exp_bound() + other.adjusted()
2317 if (self_adj >= 0) == (other._sign == 0):
2318 # self > 1 and other +ve, or self < 1 and other -ve
2319 # possibility of overflow
2320 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002321 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002322 else:
2323 # self > 1 and other -ve, or self < 1 and other +ve
2324 # possibility of underflow to 0
2325 Etiny = context.Etiny()
2326 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002327 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002328
2329 # try for an exact result with precision +1
2330 if ans is None:
2331 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone42f1bb2010-07-08 19:09:16 +00002332 if ans is not None:
2333 if result_sign == 1:
2334 ans = _dec_from_triple(1, ans._int, ans._exp)
2335 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002336
2337 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2338 if ans is None:
2339 p = context.prec
2340 x = _WorkRep(self)
2341 xc, xe = x.int, x.exp
2342 y = _WorkRep(other)
2343 yc, ye = y.int, y.exp
2344 if y.sign == 1:
2345 yc = -yc
2346
2347 # compute correctly rounded result: start with precision +3,
2348 # then increase precision until result is unambiguously roundable
2349 extra = 3
2350 while True:
2351 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2352 if coeff % (5*10**(len(str(coeff))-p-1)):
2353 break
2354 extra += 3
2355
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002356 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002358 # unlike exp, ln and log10, the power function respects the
2359 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2360
2361 # There's a difficulty here when 'other' is not an integer and
2362 # the result is exact. In this case, the specification
2363 # requires that the Inexact flag be raised (in spite of
2364 # exactness), but since the result is exact _fix won't do this
2365 # for us. (Correspondingly, the Underflow signal should also
2366 # be raised for subnormal results.) We can't directly raise
2367 # these signals either before or after calling _fix, since
2368 # that would violate the precedence for signals. So we wrap
2369 # the ._fix call in a temporary context, and reraise
2370 # afterwards.
2371 if exact and not other._isinteger():
2372 # pad with zeros up to length context.prec+1 if necessary; this
2373 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002374 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002375 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002376 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2377 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002378
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002379 # create a copy of the current context, with cleared flags/traps
2380 newcontext = context.copy()
2381 newcontext.clear_flags()
2382 for exception in _signals:
2383 newcontext.traps[exception] = 0
2384
2385 # round in the new context
2386 ans = ans._fix(newcontext)
2387
2388 # raise Inexact, and if necessary, Underflow
2389 newcontext._raise_error(Inexact)
2390 if newcontext.flags[Subnormal]:
2391 newcontext._raise_error(Underflow)
2392
2393 # propagate signals to the original context; _fix could
2394 # have raised any of Overflow, Underflow, Subnormal,
2395 # Inexact, Rounded, Clamped. Overflow needs the correct
2396 # arguments. Note that the order of the exceptions is
2397 # important here.
2398 if newcontext.flags[Overflow]:
2399 context._raise_error(Overflow, 'above Emax', ans._sign)
2400 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2401 if newcontext.flags[exception]:
2402 context._raise_error(exception)
2403
2404 else:
2405 ans = ans._fix(context)
2406
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002407 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002408
2409 def __rpow__(self, other, context=None):
2410 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002411 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002412 if other is NotImplemented:
2413 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002414 return other.__pow__(self, context=context)
2415
2416 def normalize(self, context=None):
2417 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002418
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002419 if context is None:
2420 context = getcontext()
2421
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002422 if self._is_special:
2423 ans = self._check_nans(context=context)
2424 if ans:
2425 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002426
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002427 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002428 if dup._isinfinity():
2429 return dup
2430
2431 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002432 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002433 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002434 end = len(dup._int)
2435 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002436 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437 exp += 1
2438 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002439 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002440
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002441 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002442 """Quantize self so its exponent is the same as that of exp.
2443
2444 Similar to self._rescale(exp._exp) but with error checking.
2445 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002446 exp = _convert_other(exp, raiseit=True)
2447
2448 if context is None:
2449 context = getcontext()
2450 if rounding is None:
2451 rounding = context.rounding
2452
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002453 if self._is_special or exp._is_special:
2454 ans = self._check_nans(exp, context)
2455 if ans:
2456 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002457
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002458 if exp._isinfinity() or self._isinfinity():
2459 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002460 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002461 return context._raise_error(InvalidOperation,
2462 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002463
2464 # if we're not watching exponents, do a simple rescale
2465 if not watchexp:
2466 ans = self._rescale(exp._exp, rounding)
2467 # raise Inexact and Rounded where appropriate
2468 if ans._exp > self._exp:
2469 context._raise_error(Rounded)
2470 if ans != self:
2471 context._raise_error(Inexact)
2472 return ans
2473
2474 # exp._exp should be between Etiny and Emax
2475 if not (context.Etiny() <= exp._exp <= context.Emax):
2476 return context._raise_error(InvalidOperation,
2477 'target exponent out of bounds in quantize')
2478
2479 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002480 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002481 return ans._fix(context)
2482
2483 self_adjusted = self.adjusted()
2484 if self_adjusted > context.Emax:
2485 return context._raise_error(InvalidOperation,
2486 'exponent of quantize result too large for current context')
2487 if self_adjusted - exp._exp + 1 > context.prec:
2488 return context._raise_error(InvalidOperation,
2489 'quantize result has too many digits for current context')
2490
2491 ans = self._rescale(exp._exp, rounding)
2492 if ans.adjusted() > context.Emax:
2493 return context._raise_error(InvalidOperation,
2494 'exponent of quantize result too large for current context')
2495 if len(ans._int) > context.prec:
2496 return context._raise_error(InvalidOperation,
2497 'quantize result has too many digits for current context')
2498
2499 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002500 if ans and ans.adjusted() < context.Emin:
2501 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002502 if ans._exp > self._exp:
2503 if ans != self:
2504 context._raise_error(Inexact)
2505 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002506
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002507 # call to fix takes care of any necessary folddown, and
2508 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002509 ans = ans._fix(context)
2510 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002511
2512 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002513 """Return True if self and other have the same exponent; otherwise
2514 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002516 If either operand is a special value, the following rules are used:
2517 * return True if both operands are infinities
2518 * return True if both operands are NaNs
2519 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002521 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002522 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002523 return (self.is_nan() and other.is_nan() or
2524 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002525 return self._exp == other._exp
2526
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002527 def _rescale(self, exp, rounding):
2528 """Rescale self so that the exponent is exp, either by padding with zeros
2529 or by truncating digits, using the given rounding mode.
2530
2531 Specials are returned without change. This operation is
2532 quiet: it raises no flags, and uses no information from the
2533 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534
2535 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002536 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002538 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002539 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002540 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002541 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 if self._exp >= exp:
2544 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002545 return _dec_from_triple(self._sign,
2546 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002547
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002548 # too many digits; round and lose data. If self.adjusted() <
2549 # exp-1, replace self by 10**(exp-1) before rounding
2550 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002551 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002552 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002553 digits = 0
2554 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002555 changed = this_function(digits)
2556 coeff = self._int[:digits] or '0'
2557 if changed == 1:
2558 coeff = str(int(coeff)+1)
2559 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002560
Christian Heimesf16baeb2008-02-29 14:57:44 +00002561 def _round(self, places, rounding):
2562 """Round a nonzero, nonspecial Decimal to a fixed number of
2563 significant figures, using the given rounding mode.
2564
2565 Infinities, NaNs and zeros are returned unaltered.
2566
2567 This operation is quiet: it raises no flags, and uses no
2568 information from the context.
2569
2570 """
2571 if places <= 0:
2572 raise ValueError("argument should be at least 1 in _round")
2573 if self._is_special or not self:
2574 return Decimal(self)
2575 ans = self._rescale(self.adjusted()+1-places, rounding)
2576 # it can happen that the rescale alters the adjusted exponent;
2577 # for example when rounding 99.97 to 3 significant figures.
2578 # When this happens we end up with an extra 0 at the end of
2579 # the number; a second rescale fixes this.
2580 if ans.adjusted() != self.adjusted():
2581 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2582 return ans
2583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002584 def to_integral_exact(self, rounding=None, context=None):
2585 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002586
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002587 If no rounding mode is specified, take the rounding mode from
2588 the context. This method raises the Rounded and Inexact flags
2589 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002590
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002591 See also: to_integral_value, which does exactly the same as
2592 this method except that it doesn't raise Inexact or Rounded.
2593 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002594 if self._is_special:
2595 ans = self._check_nans(context=context)
2596 if ans:
2597 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002598 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002600 return Decimal(self)
2601 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002602 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002603 if context is None:
2604 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 if rounding is None:
2606 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002607 ans = self._rescale(0, rounding)
2608 if ans != self:
2609 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002610 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002611 return ans
2612
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002613 def to_integral_value(self, rounding=None, context=None):
2614 """Rounds to the nearest integer, without raising inexact, rounded."""
2615 if context is None:
2616 context = getcontext()
2617 if rounding is None:
2618 rounding = context.rounding
2619 if self._is_special:
2620 ans = self._check_nans(context=context)
2621 if ans:
2622 return ans
2623 return Decimal(self)
2624 if self._exp >= 0:
2625 return Decimal(self)
2626 else:
2627 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002628
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002629 # the method name changed, but we provide also the old one, for compatibility
2630 to_integral = to_integral_value
2631
2632 def sqrt(self, context=None):
2633 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002634 if context is None:
2635 context = getcontext()
2636
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002637 if self._is_special:
2638 ans = self._check_nans(context=context)
2639 if ans:
2640 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002642 if self._isinfinity() and self._sign == 0:
2643 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002644
2645 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002646 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002647 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002648 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
2650 if self._sign == 1:
2651 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2652
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002653 # At this point self represents a positive number. Let p be
2654 # the desired precision and express self in the form c*100**e
2655 # with c a positive real number and e an integer, c and e
2656 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2657 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2658 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2659 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2660 # the closest integer to sqrt(c) with the even integer chosen
2661 # in the case of a tie.
2662 #
2663 # To ensure correct rounding in all cases, we use the
2664 # following trick: we compute the square root to an extra
2665 # place (precision p+1 instead of precision p), rounding down.
2666 # Then, if the result is inexact and its last digit is 0 or 5,
2667 # we increase the last digit to 1 or 6 respectively; if it's
2668 # exact we leave the last digit alone. Now the final round to
2669 # p places (or fewer in the case of underflow) will round
2670 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002671
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002672 # use an extra digit of precision
2673 prec = context.prec+1
2674
2675 # write argument in the form c*100**e where e = self._exp//2
2676 # is the 'ideal' exponent, to be used if the square root is
2677 # exactly representable. l is the number of 'digits' of c in
2678 # base 100, so that 100**(l-1) <= c < 100**l.
2679 op = _WorkRep(self)
2680 e = op.exp >> 1
2681 if op.exp & 1:
2682 c = op.int * 10
2683 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002684 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002685 c = op.int
2686 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002687
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002688 # rescale so that c has exactly prec base 100 'digits'
2689 shift = prec-l
2690 if shift >= 0:
2691 c *= 100**shift
2692 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002693 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002694 c, remainder = divmod(c, 100**-shift)
2695 exact = not remainder
2696 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002697
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002698 # find n = floor(sqrt(c)) using Newton's method
2699 n = 10**prec
2700 while True:
2701 q = c//n
2702 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002703 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002704 else:
2705 n = n + q >> 1
2706 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002707
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002708 if exact:
2709 # result is exact; rescale to use ideal exponent e
2710 if shift >= 0:
2711 # assert n % 10**shift == 0
2712 n //= 10**shift
2713 else:
2714 n *= 10**-shift
2715 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002716 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002717 # result is not exact; fix last digit as described above
2718 if n % 5 == 0:
2719 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002720
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002721 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002722
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002723 # round, and fit to current context
2724 context = context._shallow_copy()
2725 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002726 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002727 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002728
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002730
2731 def max(self, other, context=None):
2732 """Returns the larger value.
2733
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002734 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002735 NaN (and signals if one is sNaN). Also rounds.
2736 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002737 other = _convert_other(other, raiseit=True)
2738
2739 if context is None:
2740 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002741
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002742 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002743 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002744 # number is always returned
2745 sn = self._isnan()
2746 on = other._isnan()
2747 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002748 if on == 1 and sn == 0:
2749 return self._fix(context)
2750 if sn == 1 and on == 0:
2751 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002752 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002753
Christian Heimes77c02eb2008-02-09 02:18:51 +00002754 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002755 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002756 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002757 # then an ordering is applied:
2758 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002759 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002760 # positive sign and min returns the operand with the negative sign
2761 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002762 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002763 # the result. This is exactly the ordering used in compare_total.
2764 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002765
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002766 if c == -1:
2767 ans = other
2768 else:
2769 ans = self
2770
Christian Heimes2c181612007-12-17 20:04:13 +00002771 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002772
2773 def min(self, other, context=None):
2774 """Returns the smaller value.
2775
Guido van Rossumd8faa362007-04-27 19:54:29 +00002776 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002777 NaN (and signals if one is sNaN). Also rounds.
2778 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002779 other = _convert_other(other, raiseit=True)
2780
2781 if context is None:
2782 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002783
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002784 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002785 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002786 # number is always returned
2787 sn = self._isnan()
2788 on = other._isnan()
2789 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002790 if on == 1 and sn == 0:
2791 return self._fix(context)
2792 if sn == 1 and on == 0:
2793 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002794 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002795
Christian Heimes77c02eb2008-02-09 02:18:51 +00002796 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002797 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002798 c = self.compare_total(other)
2799
2800 if c == -1:
2801 ans = self
2802 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002803 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002804
Christian Heimes2c181612007-12-17 20:04:13 +00002805 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002806
2807 def _isinteger(self):
2808 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002809 if self._is_special:
2810 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002811 if self._exp >= 0:
2812 return True
2813 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002814 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002815
2816 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002817 """Returns True if self is even. Assumes self is an integer."""
2818 if not self or self._exp > 0:
2819 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002820 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002821
2822 def adjusted(self):
2823 """Return the adjusted exponent of self"""
2824 try:
2825 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002826 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002827 except TypeError:
2828 return 0
2829
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002830 def canonical(self, context=None):
2831 """Returns the same Decimal object.
2832
2833 As we do not have different encodings for the same number, the
2834 received object already is in its canonical form.
2835 """
2836 return self
2837
2838 def compare_signal(self, other, context=None):
2839 """Compares self to the other operand numerically.
2840
2841 It's pretty much like compare(), but all NaNs signal, with signaling
2842 NaNs taking precedence over quiet NaNs.
2843 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002844 other = _convert_other(other, raiseit = True)
2845 ans = self._compare_check_nans(other, context)
2846 if ans:
2847 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002848 return self.compare(other, context=context)
2849
2850 def compare_total(self, other):
2851 """Compares self to other using the abstract representations.
2852
2853 This is not like the standard compare, which use their numerical
2854 value. Note that a total ordering is defined for all possible abstract
2855 representations.
2856 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002857 other = _convert_other(other, raiseit=True)
2858
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859 # if one is negative and the other is positive, it's easy
2860 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002861 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002862 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002863 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002864 sign = self._sign
2865
2866 # let's handle both NaN types
2867 self_nan = self._isnan()
2868 other_nan = other._isnan()
2869 if self_nan or other_nan:
2870 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002871 # compare payloads as though they're integers
2872 self_key = len(self._int), self._int
2873 other_key = len(other._int), other._int
2874 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002875 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002876 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002877 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002878 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002879 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002881 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002882 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002883 return _One
2884 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002885
2886 if sign:
2887 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002888 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002889 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002890 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002891 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002892 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002893 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002894 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002895 else:
2896 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002897 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002898 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002899 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002900 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002901 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002902 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002903 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002904
2905 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002906 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002907 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002908 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002909
2910 if self._exp < other._exp:
2911 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002912 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002913 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002914 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002915 if self._exp > other._exp:
2916 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002917 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002918 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002919 return _One
2920 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002921
2922
2923 def compare_total_mag(self, other):
2924 """Compares self to other using abstract repr., ignoring sign.
2925
2926 Like compare_total, but with operand's sign ignored and assumed to be 0.
2927 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002928 other = _convert_other(other, raiseit=True)
2929
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002930 s = self.copy_abs()
2931 o = other.copy_abs()
2932 return s.compare_total(o)
2933
2934 def copy_abs(self):
2935 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002936 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002937
2938 def copy_negate(self):
2939 """Returns a copy with the sign inverted."""
2940 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002941 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002942 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002943 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002944
2945 def copy_sign(self, other):
2946 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002947 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002948 return _dec_from_triple(other._sign, self._int,
2949 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002950
2951 def exp(self, context=None):
2952 """Returns e ** self."""
2953
2954 if context is None:
2955 context = getcontext()
2956
2957 # exp(NaN) = NaN
2958 ans = self._check_nans(context=context)
2959 if ans:
2960 return ans
2961
2962 # exp(-Infinity) = 0
2963 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002964 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002965
2966 # exp(0) = 1
2967 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002968 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002969
2970 # exp(Infinity) = Infinity
2971 if self._isinfinity() == 1:
2972 return Decimal(self)
2973
2974 # the result is now guaranteed to be inexact (the true
2975 # mathematical result is transcendental). There's no need to
2976 # raise Rounded and Inexact here---they'll always be raised as
2977 # a result of the call to _fix.
2978 p = context.prec
2979 adj = self.adjusted()
2980
2981 # we only need to do any computation for quite a small range
2982 # of adjusted exponents---for example, -29 <= adj <= 10 for
2983 # the default context. For smaller exponent the result is
2984 # indistinguishable from 1 at the given precision, while for
2985 # larger exponent the result either overflows or underflows.
2986 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2987 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002988 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002989 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2990 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002991 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002992 elif self._sign == 0 and adj < -p:
2993 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002994 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002995 elif self._sign == 1 and adj < -p-1:
2996 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002997 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002998 # general case
2999 else:
3000 op = _WorkRep(self)
3001 c, e = op.int, op.exp
3002 if op.sign == 1:
3003 c = -c
3004
3005 # compute correctly rounded result: increase precision by
3006 # 3 digits at a time until we get an unambiguously
3007 # roundable result
3008 extra = 3
3009 while True:
3010 coeff, exp = _dexp(c, e, p+extra)
3011 if coeff % (5*10**(len(str(coeff))-p-1)):
3012 break
3013 extra += 3
3014
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003015 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003016
3017 # at this stage, ans should round correctly with *any*
3018 # rounding mode, not just with ROUND_HALF_EVEN
3019 context = context._shallow_copy()
3020 rounding = context._set_rounding(ROUND_HALF_EVEN)
3021 ans = ans._fix(context)
3022 context.rounding = rounding
3023
3024 return ans
3025
3026 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003027 """Return True if self is canonical; otherwise return False.
3028
3029 Currently, the encoding of a Decimal instance is always
3030 canonical, so this method returns True for any Decimal.
3031 """
3032 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003033
3034 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003035 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003036
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003037 A Decimal instance is considered finite if it is neither
3038 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003039 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003040 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003041
3042 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003043 """Return True if self is infinite; otherwise return False."""
3044 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003045
3046 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003047 """Return True if self is a qNaN or sNaN; otherwise return False."""
3048 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003049
3050 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003051 """Return True if self is a normal number; otherwise return False."""
3052 if self._is_special or not self:
3053 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003054 if context is None:
3055 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003056 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003057
3058 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003059 """Return True if self is a quiet NaN; otherwise return False."""
3060 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003061
3062 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003063 """Return True if self is negative; otherwise return False."""
3064 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003065
3066 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003067 """Return True if self is a signaling NaN; otherwise return False."""
3068 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003069
3070 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003071 """Return True if self is subnormal; otherwise return False."""
3072 if self._is_special or not self:
3073 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003074 if context is None:
3075 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003076 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003077
3078 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003079 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003080 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003081
3082 def _ln_exp_bound(self):
3083 """Compute a lower bound for the adjusted exponent of self.ln().
3084 In other words, compute r such that self.ln() >= 10**r. Assumes
3085 that self is finite and positive and that self != 1.
3086 """
3087
3088 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3089 adj = self._exp + len(self._int) - 1
3090 if adj >= 1:
3091 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3092 return len(str(adj*23//10)) - 1
3093 if adj <= -2:
3094 # argument <= 0.1
3095 return len(str((-1-adj)*23//10)) - 1
3096 op = _WorkRep(self)
3097 c, e = op.int, op.exp
3098 if adj == 0:
3099 # 1 < self < 10
3100 num = str(c-10**-e)
3101 den = str(c)
3102 return len(num) - len(den) - (num < den)
3103 # adj == -1, 0.1 <= self < 1
3104 return e + len(str(10**-e - c)) - 1
3105
3106
3107 def ln(self, context=None):
3108 """Returns the natural (base e) logarithm of self."""
3109
3110 if context is None:
3111 context = getcontext()
3112
3113 # ln(NaN) = NaN
3114 ans = self._check_nans(context=context)
3115 if ans:
3116 return ans
3117
3118 # ln(0.0) == -Infinity
3119 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003120 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003121
3122 # ln(Infinity) = Infinity
3123 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003124 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003125
3126 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003127 if self == _One:
3128 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003129
3130 # ln(negative) raises InvalidOperation
3131 if self._sign == 1:
3132 return context._raise_error(InvalidOperation,
3133 'ln of a negative value')
3134
3135 # result is irrational, so necessarily inexact
3136 op = _WorkRep(self)
3137 c, e = op.int, op.exp
3138 p = context.prec
3139
3140 # correctly rounded result: repeatedly increase precision by 3
3141 # until we get an unambiguously roundable result
3142 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3143 while True:
3144 coeff = _dlog(c, e, places)
3145 # assert len(str(abs(coeff)))-p >= 1
3146 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3147 break
3148 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003149 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003150
3151 context = context._shallow_copy()
3152 rounding = context._set_rounding(ROUND_HALF_EVEN)
3153 ans = ans._fix(context)
3154 context.rounding = rounding
3155 return ans
3156
3157 def _log10_exp_bound(self):
3158 """Compute a lower bound for the adjusted exponent of self.log10().
3159 In other words, find r such that self.log10() >= 10**r.
3160 Assumes that self is finite and positive and that self != 1.
3161 """
3162
3163 # For x >= 10 or x < 0.1 we only need a bound on the integer
3164 # part of log10(self), and this comes directly from the
3165 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3166 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3167 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3168
3169 adj = self._exp + len(self._int) - 1
3170 if adj >= 1:
3171 # self >= 10
3172 return len(str(adj))-1
3173 if adj <= -2:
3174 # self < 0.1
3175 return len(str(-1-adj))-1
3176 op = _WorkRep(self)
3177 c, e = op.int, op.exp
3178 if adj == 0:
3179 # 1 < self < 10
3180 num = str(c-10**-e)
3181 den = str(231*c)
3182 return len(num) - len(den) - (num < den) + 2
3183 # adj == -1, 0.1 <= self < 1
3184 num = str(10**-e-c)
3185 return len(num) + e - (num < "231") - 1
3186
3187 def log10(self, context=None):
3188 """Returns the base 10 logarithm of self."""
3189
3190 if context is None:
3191 context = getcontext()
3192
3193 # log10(NaN) = NaN
3194 ans = self._check_nans(context=context)
3195 if ans:
3196 return ans
3197
3198 # log10(0.0) == -Infinity
3199 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003200 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003201
3202 # log10(Infinity) = Infinity
3203 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003204 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003205
3206 # log10(negative or -Infinity) raises InvalidOperation
3207 if self._sign == 1:
3208 return context._raise_error(InvalidOperation,
3209 'log10 of a negative value')
3210
3211 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003212 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003213 # answer may need rounding
3214 ans = Decimal(self._exp + len(self._int) - 1)
3215 else:
3216 # result is irrational, so necessarily inexact
3217 op = _WorkRep(self)
3218 c, e = op.int, op.exp
3219 p = context.prec
3220
3221 # correctly rounded result: repeatedly increase precision
3222 # until result is unambiguously roundable
3223 places = p-self._log10_exp_bound()+2
3224 while True:
3225 coeff = _dlog10(c, e, places)
3226 # assert len(str(abs(coeff)))-p >= 1
3227 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3228 break
3229 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003230 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003231
3232 context = context._shallow_copy()
3233 rounding = context._set_rounding(ROUND_HALF_EVEN)
3234 ans = ans._fix(context)
3235 context.rounding = rounding
3236 return ans
3237
3238 def logb(self, context=None):
3239 """ Returns the exponent of the magnitude of self's MSD.
3240
3241 The result is the integer which is the exponent of the magnitude
3242 of the most significant digit of self (as though it were truncated
3243 to a single digit while maintaining the value of that digit and
3244 without limiting the resulting exponent).
3245 """
3246 # logb(NaN) = NaN
3247 ans = self._check_nans(context=context)
3248 if ans:
3249 return ans
3250
3251 if context is None:
3252 context = getcontext()
3253
3254 # logb(+/-Inf) = +Inf
3255 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003256 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003257
3258 # logb(0) = -Inf, DivisionByZero
3259 if not self:
3260 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3261
3262 # otherwise, simply return the adjusted exponent of self, as a
3263 # Decimal. Note that no attempt is made to fit the result
3264 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003265 ans = Decimal(self.adjusted())
3266 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003267
3268 def _islogical(self):
3269 """Return True if self is a logical operand.
3270
Christian Heimes679db4a2008-01-18 09:56:22 +00003271 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003272 an exponent of 0, and a coefficient whose digits must all be
3273 either 0 or 1.
3274 """
3275 if self._sign != 0 or self._exp != 0:
3276 return False
3277 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003278 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003279 return False
3280 return True
3281
3282 def _fill_logical(self, context, opa, opb):
3283 dif = context.prec - len(opa)
3284 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003285 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003286 elif dif < 0:
3287 opa = opa[-context.prec:]
3288 dif = context.prec - len(opb)
3289 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003290 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003291 elif dif < 0:
3292 opb = opb[-context.prec:]
3293 return opa, opb
3294
3295 def logical_and(self, other, context=None):
3296 """Applies an 'and' operation between self and other's digits."""
3297 if context is None:
3298 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003299
3300 other = _convert_other(other, raiseit=True)
3301
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003302 if not self._islogical() or not other._islogical():
3303 return context._raise_error(InvalidOperation)
3304
3305 # fill to context.prec
3306 (opa, opb) = self._fill_logical(context, self._int, other._int)
3307
3308 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003309 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3310 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003311
3312 def logical_invert(self, context=None):
3313 """Invert all its digits."""
3314 if context is None:
3315 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003316 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3317 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003318
3319 def logical_or(self, other, context=None):
3320 """Applies an 'or' operation between self and other's digits."""
3321 if context is None:
3322 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003323
3324 other = _convert_other(other, raiseit=True)
3325
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003326 if not self._islogical() or not other._islogical():
3327 return context._raise_error(InvalidOperation)
3328
3329 # fill to context.prec
3330 (opa, opb) = self._fill_logical(context, self._int, other._int)
3331
3332 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003333 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003334 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003335
3336 def logical_xor(self, other, context=None):
3337 """Applies an 'xor' operation between self and other's digits."""
3338 if context is None:
3339 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003340
3341 other = _convert_other(other, raiseit=True)
3342
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003343 if not self._islogical() or not other._islogical():
3344 return context._raise_error(InvalidOperation)
3345
3346 # fill to context.prec
3347 (opa, opb) = self._fill_logical(context, self._int, other._int)
3348
3349 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003350 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003351 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003352
3353 def max_mag(self, other, context=None):
3354 """Compares the values numerically with their sign ignored."""
3355 other = _convert_other(other, raiseit=True)
3356
3357 if context is None:
3358 context = getcontext()
3359
3360 if self._is_special or other._is_special:
3361 # If one operand is a quiet NaN and the other is number, then the
3362 # number is always returned
3363 sn = self._isnan()
3364 on = other._isnan()
3365 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003366 if on == 1 and sn == 0:
3367 return self._fix(context)
3368 if sn == 1 and on == 0:
3369 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003370 return self._check_nans(other, context)
3371
Christian Heimes77c02eb2008-02-09 02:18:51 +00003372 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003373 if c == 0:
3374 c = self.compare_total(other)
3375
3376 if c == -1:
3377 ans = other
3378 else:
3379 ans = self
3380
Christian Heimes2c181612007-12-17 20:04:13 +00003381 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003382
3383 def min_mag(self, other, context=None):
3384 """Compares the values numerically with their sign ignored."""
3385 other = _convert_other(other, raiseit=True)
3386
3387 if context is None:
3388 context = getcontext()
3389
3390 if self._is_special or other._is_special:
3391 # If one operand is a quiet NaN and the other is number, then the
3392 # number is always returned
3393 sn = self._isnan()
3394 on = other._isnan()
3395 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003396 if on == 1 and sn == 0:
3397 return self._fix(context)
3398 if sn == 1 and on == 0:
3399 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003400 return self._check_nans(other, context)
3401
Christian Heimes77c02eb2008-02-09 02:18:51 +00003402 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003403 if c == 0:
3404 c = self.compare_total(other)
3405
3406 if c == -1:
3407 ans = self
3408 else:
3409 ans = other
3410
Christian Heimes2c181612007-12-17 20:04:13 +00003411 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003412
3413 def next_minus(self, context=None):
3414 """Returns the largest representable number smaller than itself."""
3415 if context is None:
3416 context = getcontext()
3417
3418 ans = self._check_nans(context=context)
3419 if ans:
3420 return ans
3421
3422 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003423 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003424 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003425 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003426
3427 context = context.copy()
3428 context._set_rounding(ROUND_FLOOR)
3429 context._ignore_all_flags()
3430 new_self = self._fix(context)
3431 if new_self != self:
3432 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003433 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3434 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003435
3436 def next_plus(self, context=None):
3437 """Returns the smallest representable number larger than itself."""
3438 if context is None:
3439 context = getcontext()
3440
3441 ans = self._check_nans(context=context)
3442 if ans:
3443 return ans
3444
3445 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003446 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003447 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003448 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003449
3450 context = context.copy()
3451 context._set_rounding(ROUND_CEILING)
3452 context._ignore_all_flags()
3453 new_self = self._fix(context)
3454 if new_self != self:
3455 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003456 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3457 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003458
3459 def next_toward(self, other, context=None):
3460 """Returns the number closest to self, in the direction towards other.
3461
3462 The result is the closest representable number to self
3463 (excluding self) that is in the direction towards other,
3464 unless both have the same value. If the two operands are
3465 numerically equal, then the result is a copy of self with the
3466 sign set to be the same as the sign of other.
3467 """
3468 other = _convert_other(other, raiseit=True)
3469
3470 if context is None:
3471 context = getcontext()
3472
3473 ans = self._check_nans(other, context)
3474 if ans:
3475 return ans
3476
Christian Heimes77c02eb2008-02-09 02:18:51 +00003477 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003478 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003479 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003480
3481 if comparison == -1:
3482 ans = self.next_plus(context)
3483 else: # comparison == 1
3484 ans = self.next_minus(context)
3485
3486 # decide which flags to raise using value of ans
3487 if ans._isinfinity():
3488 context._raise_error(Overflow,
3489 'Infinite result from next_toward',
3490 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003491 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003492 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003493 elif ans.adjusted() < context.Emin:
3494 context._raise_error(Underflow)
3495 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003496 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003497 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003498 # if precision == 1 then we don't raise Clamped for a
3499 # result 0E-Etiny.
3500 if not ans:
3501 context._raise_error(Clamped)
3502
3503 return ans
3504
3505 def number_class(self, context=None):
3506 """Returns an indication of the class of self.
3507
3508 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003509 sNaN
3510 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003511 -Infinity
3512 -Normal
3513 -Subnormal
3514 -Zero
3515 +Zero
3516 +Subnormal
3517 +Normal
3518 +Infinity
3519 """
3520 if self.is_snan():
3521 return "sNaN"
3522 if self.is_qnan():
3523 return "NaN"
3524 inf = self._isinfinity()
3525 if inf == 1:
3526 return "+Infinity"
3527 if inf == -1:
3528 return "-Infinity"
3529 if self.is_zero():
3530 if self._sign:
3531 return "-Zero"
3532 else:
3533 return "+Zero"
3534 if context is None:
3535 context = getcontext()
3536 if self.is_subnormal(context=context):
3537 if self._sign:
3538 return "-Subnormal"
3539 else:
3540 return "+Subnormal"
3541 # just a normal, regular, boring number, :)
3542 if self._sign:
3543 return "-Normal"
3544 else:
3545 return "+Normal"
3546
3547 def radix(self):
3548 """Just returns 10, as this is Decimal, :)"""
3549 return Decimal(10)
3550
3551 def rotate(self, other, context=None):
3552 """Returns a rotated copy of self, value-of-other times."""
3553 if context is None:
3554 context = getcontext()
3555
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003556 other = _convert_other(other, raiseit=True)
3557
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003558 ans = self._check_nans(other, context)
3559 if ans:
3560 return ans
3561
3562 if other._exp != 0:
3563 return context._raise_error(InvalidOperation)
3564 if not (-context.prec <= int(other) <= context.prec):
3565 return context._raise_error(InvalidOperation)
3566
3567 if self._isinfinity():
3568 return Decimal(self)
3569
3570 # get values, pad if necessary
3571 torot = int(other)
3572 rotdig = self._int
3573 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003574 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003575 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003576 elif topad < 0:
3577 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003578
3579 # let's rotate!
3580 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003581 return _dec_from_triple(self._sign,
3582 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003583
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003584 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003585 """Returns self operand after adding the second value to its exp."""
3586 if context is None:
3587 context = getcontext()
3588
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003589 other = _convert_other(other, raiseit=True)
3590
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003591 ans = self._check_nans(other, context)
3592 if ans:
3593 return ans
3594
3595 if other._exp != 0:
3596 return context._raise_error(InvalidOperation)
3597 liminf = -2 * (context.Emax + context.prec)
3598 limsup = 2 * (context.Emax + context.prec)
3599 if not (liminf <= int(other) <= limsup):
3600 return context._raise_error(InvalidOperation)
3601
3602 if self._isinfinity():
3603 return Decimal(self)
3604
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003605 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003606 d = d._fix(context)
3607 return d
3608
3609 def shift(self, other, context=None):
3610 """Returns a shifted copy of self, value-of-other times."""
3611 if context is None:
3612 context = getcontext()
3613
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003614 other = _convert_other(other, raiseit=True)
3615
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003616 ans = self._check_nans(other, context)
3617 if ans:
3618 return ans
3619
3620 if other._exp != 0:
3621 return context._raise_error(InvalidOperation)
3622 if not (-context.prec <= int(other) <= context.prec):
3623 return context._raise_error(InvalidOperation)
3624
3625 if self._isinfinity():
3626 return Decimal(self)
3627
3628 # get values, pad if necessary
3629 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003630 rotdig = self._int
3631 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003632 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003633 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003634 elif topad < 0:
3635 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003636
3637 # let's shift!
3638 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003639 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003640 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003641 shifted = rotdig + '0'*torot
3642 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003643
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003644 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003645 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003646
Guido van Rossumd8faa362007-04-27 19:54:29 +00003647 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003648 def __reduce__(self):
3649 return (self.__class__, (str(self),))
3650
3651 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003652 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003653 return self # I'm immutable; therefore I am my own clone
3654 return self.__class__(str(self))
3655
3656 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003657 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003658 return self # My components are also immutable
3659 return self.__class__(str(self))
3660
Mark Dickinson79f52032009-03-17 23:12:51 +00003661 # PEP 3101 support. the _localeconv keyword argument should be
3662 # considered private: it's provided for ease of testing only.
3663 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003664 """Format a Decimal instance according to the given specifier.
3665
3666 The specifier should be a standard format specifier, with the
3667 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003668 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3669 type is omitted it defaults to 'g' or 'G', depending on the
3670 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003671 """
3672
3673 # Note: PEP 3101 says that if the type is not present then
3674 # there should be at least one digit after the decimal point.
3675 # We take the liberty of ignoring this requirement for
3676 # Decimal---it's presumably there to make sure that
3677 # format(float, '') behaves similarly to str(float).
3678 if context is None:
3679 context = getcontext()
3680
Mark Dickinson79f52032009-03-17 23:12:51 +00003681 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003682
Mark Dickinson79f52032009-03-17 23:12:51 +00003683 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003684 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003685 sign = _format_sign(self._sign, spec)
3686 body = str(self.copy_abs())
3687 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003688
3689 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003690 if spec['type'] is None:
3691 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003692
3693 # if type is '%', adjust exponent of self accordingly
3694 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003695 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3696
3697 # round if necessary, taking rounding mode from the context
3698 rounding = context.rounding
3699 precision = spec['precision']
3700 if precision is not None:
3701 if spec['type'] in 'eE':
3702 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003703 elif spec['type'] in 'fF%':
3704 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003705 elif spec['type'] in 'gG' and len(self._int) > precision:
3706 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003707 # special case: zeros with a positive exponent can't be
3708 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003709 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003710 self = self._rescale(0, rounding)
3711
3712 # figure out placement of the decimal point
3713 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003714 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003715 if not self and precision is not None:
3716 dotplace = 1 - precision
3717 else:
3718 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003719 elif spec['type'] in 'fF%':
3720 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003721 elif spec['type'] in 'gG':
3722 if self._exp <= 0 and leftdigits > -6:
3723 dotplace = leftdigits
3724 else:
3725 dotplace = 1
3726
Mark Dickinson79f52032009-03-17 23:12:51 +00003727 # find digits before and after decimal point, and get exponent
3728 if dotplace < 0:
3729 intpart = '0'
3730 fracpart = '0'*(-dotplace) + self._int
3731 elif dotplace > len(self._int):
3732 intpart = self._int + '0'*(dotplace-len(self._int))
3733 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003734 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003735 intpart = self._int[:dotplace] or '0'
3736 fracpart = self._int[dotplace:]
3737 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003738
Mark Dickinson79f52032009-03-17 23:12:51 +00003739 # done with the decimal-specific stuff; hand over the rest
3740 # of the formatting to the _format_number function
3741 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003742
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003743def _dec_from_triple(sign, coefficient, exponent, special=False):
3744 """Create a decimal instance directly, without any validation,
3745 normalization (e.g. removal of leading zeros) or argument
3746 conversion.
3747
3748 This function is for *internal use only*.
3749 """
3750
3751 self = object.__new__(Decimal)
3752 self._sign = sign
3753 self._int = coefficient
3754 self._exp = exponent
3755 self._is_special = special
3756
3757 return self
3758
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003759# Register Decimal as a kind of Number (an abstract base class).
3760# However, do not register it as Real (because Decimals are not
3761# interoperable with floats).
3762_numbers.Number.register(Decimal)
3763
3764
Guido van Rossumd8faa362007-04-27 19:54:29 +00003765##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003766
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003767
3768# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003769rounding_functions = [name for name in Decimal.__dict__.keys()
3770 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003771for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003772 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003773 globalname = name[1:].upper()
3774 val = globals()[globalname]
3775 Decimal._pick_rounding_function[val] = name
3776
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003777del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003778
Thomas Wouters89f507f2006-12-13 04:49:30 +00003779class _ContextManager(object):
3780 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003781
Thomas Wouters89f507f2006-12-13 04:49:30 +00003782 Sets a copy of the supplied context in __enter__() and restores
3783 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003784 """
3785 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003786 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003787 def __enter__(self):
3788 self.saved_context = getcontext()
3789 setcontext(self.new_context)
3790 return self.new_context
3791 def __exit__(self, t, v, tb):
3792 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003793
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003794class Context(object):
3795 """Contains the context for a Decimal instance.
3796
3797 Contains:
3798 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003799 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003800 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003801 raised when it is caused. Otherwise, a value is
3802 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003803 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003804 (Whether or not the trap_enabler is set)
3805 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003806 Emin - Minimum exponent
3807 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003808 capitals - If 1, 1*10^1 is printed as 1E+1.
3809 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003810 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003811 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003812
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003813 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003814 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003815 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003816 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003817 _ignored_flags=None):
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003818 # Set defaults; for everything except flags and _ignored_flags,
3819 # inherit from DefaultContext.
3820 try:
3821 dc = DefaultContext
3822 except NameError:
3823 pass
3824
3825 self.prec = prec if prec is not None else dc.prec
3826 self.rounding = rounding if rounding is not None else dc.rounding
3827 self.Emin = Emin if Emin is not None else dc.Emin
3828 self.Emax = Emax if Emax is not None else dc.Emax
3829 self.capitals = capitals if capitals is not None else dc.capitals
3830 self.clamp = clamp if clamp is not None else dc.clamp
3831
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003832 if _ignored_flags is None:
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003833 self._ignored_flags = []
3834 else:
3835 self._ignored_flags = _ignored_flags
3836
3837 if traps is None:
3838 self.traps = dc.traps.copy()
3839 elif not isinstance(traps, dict):
3840 self.traps = dict((s, int(s in traps)) for s in _signals)
3841 else:
3842 self.traps = traps
3843
3844 if flags is None:
3845 self.flags = dict.fromkeys(_signals, 0)
3846 elif not isinstance(flags, dict):
3847 self.flags = dict((s, int(s in flags)) for s in _signals)
3848 else:
3849 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003850
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003851 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003852 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003853 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003854 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003855 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3856 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003857 % vars(self))
3858 names = [f.__name__ for f, v in self.flags.items() if v]
3859 s.append('flags=[' + ', '.join(names) + ']')
3860 names = [t.__name__ for t, v in self.traps.items() if v]
3861 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003862 return ', '.join(s) + ')'
3863
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003864 def clear_flags(self):
3865 """Reset all flags to zero"""
3866 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003867 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003868
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003869 def _shallow_copy(self):
3870 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003871 nc = Context(self.prec, self.rounding, self.traps,
3872 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003873 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003874 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003875
3876 def copy(self):
3877 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003878 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003879 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003880 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003881 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003882 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003883
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003884 # _clamp is provided for backwards compatibility with third-party
3885 # code. May be removed in Python >= 3.3.
3886 def _get_clamp(self):
3887 "_clamp mirrors the clamp attribute. Its use is deprecated."
3888 import warnings
3889 warnings.warn('Use of the _clamp attribute is deprecated. '
3890 'Please use clamp instead.',
3891 DeprecationWarning)
3892 return self.clamp
3893
3894 def _set_clamp(self, clamp):
3895 "_clamp mirrors the clamp attribute. Its use is deprecated."
3896 import warnings
3897 warnings.warn('Use of the _clamp attribute is deprecated. '
3898 'Please use clamp instead.',
3899 DeprecationWarning)
3900 self.clamp = clamp
3901
3902 # don't bother with _del_clamp; no sane 3rd party code should
3903 # be deleting the _clamp attribute
3904 _clamp = property(_get_clamp, _set_clamp)
3905
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
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005532def _sqrt_nearest(n, a):
5533 """Closest integer to the square root of the positive integer n. a is
5534 an initial approximation to the square root. Any positive integer
5535 will do for a, but the closer a is to the square root of n the
5536 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005537
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005538 """
5539 if n <= 0 or a <= 0:
5540 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5541
5542 b=0
5543 while a != b:
5544 b, a = a, a--n//a>>1
5545 return a
5546
5547def _rshift_nearest(x, shift):
5548 """Given an integer x and a nonnegative integer shift, return closest
5549 integer to x / 2**shift; use round-to-even in case of a tie.
5550
5551 """
5552 b, q = 1 << shift, x >> shift
5553 return q + (2*(x & (b-1)) + (q&1) > b)
5554
5555def _div_nearest(a, b):
5556 """Closest integer to a/b, a and b positive integers; rounds to even
5557 in the case of a tie.
5558
5559 """
5560 q, r = divmod(a, b)
5561 return q + (2*r + (q&1) > b)
5562
5563def _ilog(x, M, L = 8):
5564 """Integer approximation to M*log(x/M), with absolute error boundable
5565 in terms only of x/M.
5566
5567 Given positive integers x and M, return an integer approximation to
5568 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5569 between the approximation and the exact result is at most 22. For
5570 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5571 both cases these are upper bounds on the error; it will usually be
5572 much smaller."""
5573
5574 # The basic algorithm is the following: let log1p be the function
5575 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5576 # the reduction
5577 #
5578 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5579 #
5580 # repeatedly until the argument to log1p is small (< 2**-L in
5581 # absolute value). For small y we can use the Taylor series
5582 # expansion
5583 #
5584 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5585 #
5586 # truncating at T such that y**T is small enough. The whole
5587 # computation is carried out in a form of fixed-point arithmetic,
5588 # with a real number z being represented by an integer
5589 # approximation to z*M. To avoid loss of precision, the y below
5590 # is actually an integer approximation to 2**R*y*M, where R is the
5591 # number of reductions performed so far.
5592
5593 y = x-M
5594 # argument reduction; R = number of reductions performed
5595 R = 0
5596 while (R <= L and abs(y) << L-R >= M or
5597 R > L and abs(y) >> R-L >= M):
5598 y = _div_nearest((M*y) << 1,
5599 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5600 R += 1
5601
5602 # Taylor series with T terms
5603 T = -int(-10*len(str(M))//(3*L))
5604 yshift = _rshift_nearest(y, R)
5605 w = _div_nearest(M, T)
5606 for k in range(T-1, 0, -1):
5607 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5608
5609 return _div_nearest(w*y, M)
5610
5611def _dlog10(c, e, p):
5612 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5613 approximation to 10**p * log10(c*10**e), with an absolute error of
5614 at most 1. Assumes that c*10**e is not exactly 1."""
5615
5616 # increase precision by 2; compensate for this by dividing
5617 # final result by 100
5618 p += 2
5619
5620 # write c*10**e as d*10**f with either:
5621 # f >= 0 and 1 <= d <= 10, or
5622 # f <= 0 and 0.1 <= d <= 1.
5623 # Thus for c*10**e close to 1, f = 0
5624 l = len(str(c))
5625 f = e+l - (e+l >= 1)
5626
5627 if p > 0:
5628 M = 10**p
5629 k = e+p-f
5630 if k >= 0:
5631 c *= 10**k
5632 else:
5633 c = _div_nearest(c, 10**-k)
5634
5635 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005636 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005637 log_d = _div_nearest(log_d*M, log_10)
5638 log_tenpower = f*M # exact
5639 else:
5640 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005641 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005642
5643 return _div_nearest(log_tenpower+log_d, 100)
5644
5645def _dlog(c, e, p):
5646 """Given integers c, e and p with c > 0, compute an integer
5647 approximation to 10**p * log(c*10**e), with an absolute error of
5648 at most 1. Assumes that c*10**e is not exactly 1."""
5649
5650 # Increase precision by 2. The precision increase is compensated
5651 # for at the end with a division by 100.
5652 p += 2
5653
5654 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5655 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5656 # as 10**p * log(d) + 10**p*f * log(10).
5657 l = len(str(c))
5658 f = e+l - (e+l >= 1)
5659
5660 # compute approximation to 10**p*log(d), with error < 27
5661 if p > 0:
5662 k = e+p-f
5663 if k >= 0:
5664 c *= 10**k
5665 else:
5666 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5667
5668 # _ilog magnifies existing error in c by a factor of at most 10
5669 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5670 else:
5671 # p <= 0: just approximate the whole thing by 0; error < 2.31
5672 log_d = 0
5673
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005674 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005675 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005676 extra = len(str(abs(f)))-1
5677 if p + extra >= 0:
5678 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5679 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5680 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005681 else:
5682 f_log_ten = 0
5683 else:
5684 f_log_ten = 0
5685
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005686 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005687 return _div_nearest(f_log_ten + log_d, 100)
5688
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005689class _Log10Memoize(object):
5690 """Class to compute, store, and allow retrieval of, digits of the
5691 constant log(10) = 2.302585.... This constant is needed by
5692 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5693 def __init__(self):
5694 self.digits = "23025850929940456840179914546843642076011014886"
5695
5696 def getdigits(self, p):
5697 """Given an integer p >= 0, return floor(10**p)*log(10).
5698
5699 For example, self.getdigits(3) returns 2302.
5700 """
5701 # digits are stored as a string, for quick conversion to
5702 # integer in the case that we've already computed enough
5703 # digits; the stored digits should always be correct
5704 # (truncated, not rounded to nearest).
5705 if p < 0:
5706 raise ValueError("p should be nonnegative")
5707
5708 if p >= len(self.digits):
5709 # compute p+3, p+6, p+9, ... digits; continue until at
5710 # least one of the extra digits is nonzero
5711 extra = 3
5712 while True:
5713 # compute p+extra digits, correct to within 1ulp
5714 M = 10**(p+extra+2)
5715 digits = str(_div_nearest(_ilog(10*M, M), 100))
5716 if digits[-extra:] != '0'*extra:
5717 break
5718 extra += 3
5719 # keep all reliable digits so far; remove trailing zeros
5720 # and next nonzero digit
5721 self.digits = digits.rstrip('0')[:-1]
5722 return int(self.digits[:p+1])
5723
5724_log10_digits = _Log10Memoize().getdigits
5725
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005726def _iexp(x, M, L=8):
5727 """Given integers x and M, M > 0, such that x/M is small in absolute
5728 value, compute an integer approximation to M*exp(x/M). For 0 <=
5729 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5730 is usually much smaller)."""
5731
5732 # Algorithm: to compute exp(z) for a real number z, first divide z
5733 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5734 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5735 # series
5736 #
5737 # expm1(x) = x + x**2/2! + x**3/3! + ...
5738 #
5739 # Now use the identity
5740 #
5741 # expm1(2x) = expm1(x)*(expm1(x)+2)
5742 #
5743 # R times to compute the sequence expm1(z/2**R),
5744 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5745
5746 # Find R such that x/2**R/M <= 2**-L
5747 R = _nbits((x<<L)//M)
5748
5749 # Taylor series. (2**L)**T > M
5750 T = -int(-10*len(str(M))//(3*L))
5751 y = _div_nearest(x, T)
5752 Mshift = M<<R
5753 for i in range(T-1, 0, -1):
5754 y = _div_nearest(x*(Mshift + y), Mshift * i)
5755
5756 # Expansion
5757 for k in range(R-1, -1, -1):
5758 Mshift = M<<(k+2)
5759 y = _div_nearest(y*(y+Mshift), Mshift)
5760
5761 return M+y
5762
5763def _dexp(c, e, p):
5764 """Compute an approximation to exp(c*10**e), with p decimal places of
5765 precision.
5766
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005767 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005768
5769 10**(p-1) <= d <= 10**p, and
5770 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5771
5772 In other words, d*10**f is an approximation to exp(c*10**e) with p
5773 digits of precision, and with an error in d of at most 1. This is
5774 almost, but not quite, the same as the error being < 1ulp: when d
5775 = 10**(p-1) the error could be up to 10 ulp."""
5776
5777 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5778 p += 2
5779
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005780 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005781 extra = max(0, e + len(str(c)) - 1)
5782 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005783
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005784 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005785 # rounding down
5786 shift = e+q
5787 if shift >= 0:
5788 cshift = c*10**shift
5789 else:
5790 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005791 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005792
5793 # reduce remainder back to original precision
5794 rem = _div_nearest(rem, 10**extra)
5795
5796 # error in result of _iexp < 120; error after division < 0.62
5797 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5798
5799def _dpower(xc, xe, yc, ye, p):
5800 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5801 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5802
5803 10**(p-1) <= c <= 10**p, and
5804 (c-1)*10**e < x**y < (c+1)*10**e
5805
5806 in other words, c*10**e is an approximation to x**y with p digits
5807 of precision, and with an error in c of at most 1. (This is
5808 almost, but not quite, the same as the error being < 1ulp: when c
5809 == 10**(p-1) we can only guarantee error < 10ulp.)
5810
5811 We assume that: x is positive and not equal to 1, and y is nonzero.
5812 """
5813
5814 # Find b such that 10**(b-1) <= |y| <= 10**b
5815 b = len(str(abs(yc))) + ye
5816
5817 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5818 lxc = _dlog(xc, xe, p+b+1)
5819
5820 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5821 shift = ye-b
5822 if shift >= 0:
5823 pc = lxc*yc*10**shift
5824 else:
5825 pc = _div_nearest(lxc*yc, 10**-shift)
5826
5827 if pc == 0:
5828 # we prefer a result that isn't exactly 1; this makes it
5829 # easier to compute a correctly rounded result in __pow__
5830 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5831 coeff, exp = 10**(p-1)+1, 1-p
5832 else:
5833 coeff, exp = 10**p-1, -p
5834 else:
5835 coeff, exp = _dexp(pc, -(p+1), p+1)
5836 coeff = _div_nearest(coeff, 10)
5837 exp += 1
5838
5839 return coeff, exp
5840
5841def _log10_lb(c, correction = {
5842 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5843 '6': 23, '7': 16, '8': 10, '9': 5}):
5844 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5845 if c <= 0:
5846 raise ValueError("The argument to _log10_lb should be nonnegative.")
5847 str_c = str(c)
5848 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005849
Guido van Rossumd8faa362007-04-27 19:54:29 +00005850##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005851
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005852def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005853 """Convert other to Decimal.
5854
5855 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005856 If allow_float is true, allow conversion from float; this
5857 is used in the comparison methods (__eq__ and friends).
5858
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005859 """
5860 if isinstance(other, Decimal):
5861 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005862 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005863 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005864 if allow_float and isinstance(other, float):
5865 return Decimal.from_float(other)
5866
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005867 if raiseit:
5868 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005869 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005870
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005871def _convert_for_comparison(self, other, equality_op=False):
5872 """Given a Decimal instance self and a Python object other, return
Mark Dickinson1c164a62010-06-11 16:49:20 +00005873 a pair (s, o) of Decimal instances such that "s op o" is
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005874 equivalent to "self op other" for any of the 6 comparison
5875 operators "op".
5876
5877 """
5878 if isinstance(other, Decimal):
5879 return self, other
5880
5881 # Comparison with a Rational instance (also includes integers):
5882 # self op n/d <=> self*d op n (for n and d integers, d positive).
5883 # A NaN or infinity can be left unchanged without affecting the
5884 # comparison result.
5885 if isinstance(other, _numbers.Rational):
5886 if not self._is_special:
5887 self = _dec_from_triple(self._sign,
5888 str(int(self._int) * other.denominator),
5889 self._exp)
5890 return self, Decimal(other.numerator)
5891
5892 # Comparisons with float and complex types. == and != comparisons
5893 # with complex numbers should succeed, returning either True or False
5894 # as appropriate. Other comparisons return NotImplemented.
5895 if equality_op and isinstance(other, _numbers.Complex) and other.imag == 0:
5896 other = other.real
5897 if isinstance(other, float):
5898 return self, Decimal.from_float(other)
5899 return NotImplemented, NotImplemented
5900
5901
Guido van Rossumd8faa362007-04-27 19:54:29 +00005902##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005903
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005904# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005905# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005906
5907DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005908 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005909 traps=[DivisionByZero, Overflow, InvalidOperation],
5910 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005911 Emax=999999999,
5912 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005913 capitals=1,
5914 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005915)
5916
5917# Pre-made alternate contexts offered by the specification
5918# Don't change these; the user should be able to select these
5919# contexts and be able to reproduce results from other implementations
5920# of the spec.
5921
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005922BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005923 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005924 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5925 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005926)
5927
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005928ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005929 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005930 traps=[],
5931 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005932)
5933
5934
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005935##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005936#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005937# Regular expression used for parsing numeric strings. Additional
5938# comments:
5939#
5940# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5941# whitespace. But note that the specification disallows whitespace in
5942# a numeric string.
5943#
5944# 2. For finite numbers (not infinities and NaNs) the body of the
5945# number between the optional sign and the optional exponent must have
5946# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005947# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005948
5949import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005950_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005951# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005952 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005953 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005954 (?=\d|\.\d) # ...a number (with at least one digit)
5955 (?P<int>\d*) # having a (possibly empty) integer part
5956 (\.(?P<frac>\d*))? # followed by an optional fractional part
5957 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005958 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005959 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005960 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005961 (?P<signal>s)? # ...an (optionally signaling)
5962 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005963 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005964 )
5965# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005966 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005967""", re.VERBOSE | re.IGNORECASE).match
5968
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005969_all_zeros = re.compile('0*$').match
5970_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005971
5972##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005973# The functions in this section have little to do with the Decimal
5974# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005975# Python numeric classes that want to implement __format__
5976#
5977# A format specifier for Decimal looks like:
5978#
Eric Smith984bb582010-11-25 16:08:06 +00005979# [[fill]align][sign][#][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005980
5981_parse_format_specifier_regex = re.compile(r"""\A
5982(?:
5983 (?P<fill>.)?
5984 (?P<align>[<>=^])
5985)?
5986(?P<sign>[-+ ])?
Eric Smith984bb582010-11-25 16:08:06 +00005987(?P<alt>\#)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005988(?P<zeropad>0)?
5989(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005990(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005991(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005992(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005993\Z
5994""", re.VERBOSE)
5995
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005996del re
5997
Mark Dickinson79f52032009-03-17 23:12:51 +00005998# The locale module is only needed for the 'n' format specifier. The
5999# rest of the PEP 3101 code functions quite happily without it, so we
6000# don't care too much if locale isn't present.
6001try:
6002 import locale as _locale
6003except ImportError:
6004 pass
6005
6006def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00006007 """Parse and validate a format specifier.
6008
6009 Turns a standard numeric format specifier into a dict, with the
6010 following entries:
6011
6012 fill: fill character to pad field to minimum width
6013 align: alignment type, either '<', '>', '=' or '^'
6014 sign: either '+', '-' or ' '
6015 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006016 zeropad: boolean, indicating whether to pad with zeros
6017 thousands_sep: string to use as thousands separator, or ''
6018 grouping: grouping for thousands separators, in format
6019 used by localeconv
6020 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006021 precision: nonnegative integer giving precision, or None
6022 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006023
6024 """
6025 m = _parse_format_specifier_regex.match(format_spec)
6026 if m is None:
6027 raise ValueError("Invalid format specifier: " + format_spec)
6028
6029 # get the dictionary
6030 format_dict = m.groupdict()
6031
Mark Dickinson79f52032009-03-17 23:12:51 +00006032 # zeropad; defaults for fill and alignment. If zero padding
6033 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006034 fill = format_dict['fill']
6035 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006036 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6037 if format_dict['zeropad']:
6038 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006039 raise ValueError("Fill character conflicts with '0'"
6040 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006041 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006042 raise ValueError("Alignment conflicts with '0' in "
6043 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006044 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006045 # PEP 3101 originally specified that the default alignment should
6046 # be left; it was later agreed that right-aligned makes more sense
6047 # for numeric types. See http://bugs.python.org/issue6857.
6048 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006049
Mark Dickinson79f52032009-03-17 23:12:51 +00006050 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006051 if format_dict['sign'] is None:
6052 format_dict['sign'] = '-'
6053
Christian Heimesf16baeb2008-02-29 14:57:44 +00006054 # minimumwidth defaults to 0; precision remains None if not given
6055 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6056 if format_dict['precision'] is not None:
6057 format_dict['precision'] = int(format_dict['precision'])
6058
6059 # if format type is 'g' or 'G' then a precision of 0 makes little
6060 # sense; convert it to 1. Same if format type is unspecified.
6061 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006062 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006063 format_dict['precision'] = 1
6064
Mark Dickinson79f52032009-03-17 23:12:51 +00006065 # determine thousands separator, grouping, and decimal separator, and
6066 # add appropriate entries to format_dict
6067 if format_dict['type'] == 'n':
6068 # apart from separators, 'n' behaves just like 'g'
6069 format_dict['type'] = 'g'
6070 if _localeconv is None:
6071 _localeconv = _locale.localeconv()
6072 if format_dict['thousands_sep'] is not None:
6073 raise ValueError("Explicit thousands separator conflicts with "
6074 "'n' type in format specifier: " + format_spec)
6075 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6076 format_dict['grouping'] = _localeconv['grouping']
6077 format_dict['decimal_point'] = _localeconv['decimal_point']
6078 else:
6079 if format_dict['thousands_sep'] is None:
6080 format_dict['thousands_sep'] = ''
6081 format_dict['grouping'] = [3, 0]
6082 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006083
6084 return format_dict
6085
Mark Dickinson79f52032009-03-17 23:12:51 +00006086def _format_align(sign, body, spec):
6087 """Given an unpadded, non-aligned numeric string 'body' and sign
6088 string 'sign', add padding and aligment conforming to the given
6089 format specifier dictionary 'spec' (as produced by
6090 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006091
6092 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006093 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006094 minimumwidth = spec['minimumwidth']
6095 fill = spec['fill']
6096 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006097
Mark Dickinson79f52032009-03-17 23:12:51 +00006098 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006099 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006100 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006101 elif align == '>':
6102 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006103 elif align == '=':
6104 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006105 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006106 half = len(padding)//2
6107 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006108 else:
6109 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006110
Christian Heimesf16baeb2008-02-29 14:57:44 +00006111 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006112
Mark Dickinson79f52032009-03-17 23:12:51 +00006113def _group_lengths(grouping):
6114 """Convert a localeconv-style grouping into a (possibly infinite)
6115 iterable of integers representing group lengths.
6116
6117 """
6118 # The result from localeconv()['grouping'], and the input to this
6119 # function, should be a list of integers in one of the
6120 # following three forms:
6121 #
6122 # (1) an empty list, or
6123 # (2) nonempty list of positive integers + [0]
6124 # (3) list of positive integers + [locale.CHAR_MAX], or
6125
6126 from itertools import chain, repeat
6127 if not grouping:
6128 return []
6129 elif grouping[-1] == 0 and len(grouping) >= 2:
6130 return chain(grouping[:-1], repeat(grouping[-2]))
6131 elif grouping[-1] == _locale.CHAR_MAX:
6132 return grouping[:-1]
6133 else:
6134 raise ValueError('unrecognised format for grouping')
6135
6136def _insert_thousands_sep(digits, spec, min_width=1):
6137 """Insert thousands separators into a digit string.
6138
6139 spec is a dictionary whose keys should include 'thousands_sep' and
6140 'grouping'; typically it's the result of parsing the format
6141 specifier using _parse_format_specifier.
6142
6143 The min_width keyword argument gives the minimum length of the
6144 result, which will be padded on the left with zeros if necessary.
6145
6146 If necessary, the zero padding adds an extra '0' on the left to
6147 avoid a leading thousands separator. For example, inserting
6148 commas every three digits in '123456', with min_width=8, gives
6149 '0,123,456', even though that has length 9.
6150
6151 """
6152
6153 sep = spec['thousands_sep']
6154 grouping = spec['grouping']
6155
6156 groups = []
6157 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006158 if l <= 0:
6159 raise ValueError("group length should be positive")
6160 # max(..., 1) forces at least 1 digit to the left of a separator
6161 l = min(max(len(digits), min_width, 1), l)
6162 groups.append('0'*(l - len(digits)) + digits[-l:])
6163 digits = digits[:-l]
6164 min_width -= l
6165 if not digits and min_width <= 0:
6166 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006167 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006168 else:
6169 l = max(len(digits), min_width, 1)
6170 groups.append('0'*(l - len(digits)) + digits[-l:])
6171 return sep.join(reversed(groups))
6172
6173def _format_sign(is_negative, spec):
6174 """Determine sign character."""
6175
6176 if is_negative:
6177 return '-'
6178 elif spec['sign'] in ' +':
6179 return spec['sign']
6180 else:
6181 return ''
6182
6183def _format_number(is_negative, intpart, fracpart, exp, spec):
6184 """Format a number, given the following data:
6185
6186 is_negative: true if the number is negative, else false
6187 intpart: string of digits that must appear before the decimal point
6188 fracpart: string of digits that must come after the point
6189 exp: exponent, as an integer
6190 spec: dictionary resulting from parsing the format specifier
6191
6192 This function uses the information in spec to:
6193 insert separators (decimal separator and thousands separators)
6194 format the sign
6195 format the exponent
6196 add trailing '%' for the '%' type
6197 zero-pad if necessary
6198 fill and align if necessary
6199 """
6200
6201 sign = _format_sign(is_negative, spec)
6202
Eric Smith984bb582010-11-25 16:08:06 +00006203 if fracpart or spec['alt']:
Mark Dickinson79f52032009-03-17 23:12:51 +00006204 fracpart = spec['decimal_point'] + fracpart
6205
6206 if exp != 0 or spec['type'] in 'eE':
6207 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6208 fracpart += "{0}{1:+}".format(echar, exp)
6209 if spec['type'] == '%':
6210 fracpart += '%'
6211
6212 if spec['zeropad']:
6213 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6214 else:
6215 min_width = 0
6216 intpart = _insert_thousands_sep(intpart, spec, min_width)
6217
6218 return _format_align(sign, intpart+fracpart, spec)
6219
6220
Guido van Rossumd8faa362007-04-27 19:54:29 +00006221##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006222
Guido van Rossumd8faa362007-04-27 19:54:29 +00006223# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006224_Infinity = Decimal('Inf')
6225_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006226_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006227_Zero = Decimal(0)
6228_One = Decimal(1)
6229_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006230
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006231# _SignedInfinity[sign] is infinity w/ that sign
6232_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006233
Mark Dickinsondc787d22010-05-23 13:33:13 +00006234# Constants related to the hash implementation; hash(x) is based
6235# on the reduction of x modulo _PyHASH_MODULUS
6236import sys
6237_PyHASH_MODULUS = sys.hash_info.modulus
6238# hash values to use for positive and negative infinities, and nans
6239_PyHASH_INF = sys.hash_info.inf
6240_PyHASH_NAN = sys.hash_info.nan
6241del sys
6242
6243# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6244_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006245
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006246
6247if __name__ == '__main__':
6248 import doctest, sys
6249 doctest.testmod(sys.modules[__name__])