blob: 71408a8e9edfe74a89662baeb7151ad24ab256f9 [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
135
Raymond Hettingereb260842005-06-07 18:52:34 +0000136import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000137import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000138import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000139
Christian Heimes25bb7832008-01-11 16:17:00 +0000140try:
141 from collections import namedtuple as _namedtuple
142 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
143except ImportError:
144 DecimalTuple = lambda *args: args
145
Guido van Rossumd8faa362007-04-27 19:54:29 +0000146# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000147ROUND_DOWN = 'ROUND_DOWN'
148ROUND_HALF_UP = 'ROUND_HALF_UP'
149ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
150ROUND_CEILING = 'ROUND_CEILING'
151ROUND_FLOOR = 'ROUND_FLOOR'
152ROUND_UP = 'ROUND_UP'
153ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000154ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000155
Guido van Rossumd8faa362007-04-27 19:54:29 +0000156# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000159 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161 Used exceptions derive from this.
162 If an exception derives from another exception besides this (such as
163 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
164 called if the others are present. This isn't actually used for
165 anything, though.
166
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000167 handle -- Called when context._raise_error is called and the
Stefan Krah2eb4a072010-05-19 15:52:31 +0000168 trap_enabler is not set. First argument is self, second is the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000169 context. More arguments can be given, those being after
170 the explanation in _raise_error (For example,
171 context._raise_error(NewError, '(-x)!', self._sign) would
172 call NewError().handle(context, self._sign).)
173
174 To define a new exception, it should be sufficient to have it derive
175 from DecimalException.
176 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 def handle(self, context, *args):
178 pass
179
180
181class Clamped(DecimalException):
182 """Exponent of a 0 changed to fit bounds.
183
184 This occurs and signals clamped if the exponent of a result has been
185 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000186 representation. This may occur when the exponent of a zero result would
187 be outside the bounds of a representation, or when a large normal
188 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000189 this latter case, the exponent is reduced to fit and the corresponding
190 number of zero digits are appended to the coefficient ("fold-down").
191 """
192
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000193class InvalidOperation(DecimalException):
194 """An invalid operation was performed.
195
196 Various bad things cause this:
197
198 Something creates a signaling NaN
199 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000200 0 * (+-)INF
201 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000202 x % 0
203 (+-)INF % x
204 x._rescale( non-integer )
205 sqrt(-x) , x > 0
206 0 ** 0
207 x ** (non-integer)
208 x ** (+-)INF
209 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000210
211 The result of the operation after these is a quiet positive NaN,
212 except when the cause is a signaling NaN, in which case the result is
213 also a quiet NaN, but with the original sign, and an optional
214 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000215 """
216 def handle(self, context, *args):
217 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000218 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
219 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000220 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000221
222class ConversionSyntax(InvalidOperation):
223 """Trying to convert badly formed string.
224
225 This occurs and signals invalid-operation if an string is being
226 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000227 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000229 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000230 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231
232class DivisionByZero(DecimalException, ZeroDivisionError):
233 """Division by 0.
234
235 This occurs and signals division-by-zero if division of a finite number
236 by zero was attempted (during a divide-integer or divide operation, or a
237 power operation with negative right-hand operand), and the dividend was
238 not zero.
239
240 The result of the operation is [sign,inf], where sign is the exclusive
241 or of the signs of the operands for divide, or is 1 for an odd power of
242 -0, for power.
243 """
244
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000245 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000246 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000247
248class DivisionImpossible(InvalidOperation):
249 """Cannot perform the division adequately.
250
251 This occurs and signals invalid-operation if the integer result of a
252 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000253 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000254 """
255
256 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000257 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000258
259class DivisionUndefined(InvalidOperation, ZeroDivisionError):
260 """Undefined result of division.
261
262 This occurs and signals invalid-operation if division by zero was
263 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000264 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000265 """
266
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000267 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000268 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000269
270class Inexact(DecimalException):
271 """Had to round, losing information.
272
273 This occurs and signals inexact whenever the result of an operation is
274 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000275 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000276 result in all cases is unchanged.
277
278 The inexact signal may be tested (or trapped) to determine if a given
279 operation (or sequence of operations) was inexact.
280 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000281
282class InvalidContext(InvalidOperation):
283 """Invalid context. Unknown rounding, for example.
284
285 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000286 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000287 on creation and either the precision exceeds the capability of the
288 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000289 was specified. These aspects of the context need only be checked when
290 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000291 """
292
293 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000294 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000295
296class Rounded(DecimalException):
297 """Number got rounded (not necessarily changed during rounding).
298
299 This occurs and signals rounded whenever the result of an operation is
300 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000301 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000302 result in all cases is unchanged.
303
304 The rounded signal may be tested (or trapped) to determine if a given
305 operation (or sequence of operations) caused a loss of precision.
306 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000307
308class Subnormal(DecimalException):
309 """Exponent < Emin before rounding.
310
311 This occurs and signals subnormal whenever the result of a conversion or
312 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000313 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000314
315 The subnormal signal may be tested (or trapped) to determine if a given
316 or operation (or sequence of operations) yielded a subnormal result.
317 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000318
319class Overflow(Inexact, Rounded):
320 """Numerical overflow.
321
322 This occurs and signals overflow if the adjusted exponent of a result
323 (from a conversion or from an operation that is not an attempt to divide
324 by zero), after rounding, would be greater than the largest value that
325 can be handled by the implementation (the value Emax).
326
327 The result depends on the rounding mode:
328
329 For round-half-up and round-half-even (and for round-half-down and
330 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000331 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000332 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000333 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000334 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000335 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000336 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000337 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000338 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000339 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000340
341 def handle(self, context, sign, *args):
342 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000343 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000347 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000348 return _dec_from_triple(sign, '9'*context.prec,
349 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000350 if sign == 1:
351 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000352 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000353 return _dec_from_triple(sign, '9'*context.prec,
354 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000355
356
357class Underflow(Inexact, Rounded, Subnormal):
358 """Numerical underflow with result rounded to 0.
359
360 This occurs and signals underflow if a result is inexact and the
361 adjusted exponent of the result would be smaller (more negative) than
362 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000363 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364
365 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000366 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367 in 0 with the sign of the intermediate result and an exponent of Etiny.
368
369 In all cases, Inexact, Rounded, and Subnormal will also be raised.
370 """
371
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000372# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000373_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000374 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000375
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000376# Map conditions (per the spec) to signals
377_condition_map = {ConversionSyntax:InvalidOperation,
378 DivisionImpossible:InvalidOperation,
379 DivisionUndefined:InvalidOperation,
380 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000381
Guido van Rossumd8faa362007-04-27 19:54:29 +0000382##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000383
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000384# The getcontext() and setcontext() function manage access to a thread-local
385# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000386# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000387# work for older Pythons. If threads are not part of the build, create a
388# mock threading object with threading.local() returning the module namespace.
389
390try:
391 import threading
392except ImportError:
393 # Python was compiled without threads; create a mock object instead
394 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000395 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000396 def local(self, sys=sys):
397 return sys.modules[__name__]
398 threading = MockThreading()
399 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401try:
402 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000405
Guido van Rossumd8faa362007-04-27 19:54:29 +0000406 # To fix reloading, force it to create a new context
407 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000408 if hasattr(threading.current_thread(), '__decimal_context__'):
409 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000410
411 def setcontext(context):
412 """Set this thread's context to context."""
413 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000414 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000415 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000416 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000417
418 def getcontext():
419 """Returns this thread's context.
420
421 If this thread does not yet have a context, returns
422 a new context and sets this thread's context.
423 New contexts are copies of DefaultContext.
424 """
425 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000426 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000427 except AttributeError:
428 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000429 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000430 return context
431
432else:
433
434 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000435 if hasattr(local, '__decimal_context__'):
436 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000437
438 def getcontext(_local=local):
439 """Returns this thread's context.
440
441 If this thread does not yet have a context, returns
442 a new context and sets this thread's context.
443 New contexts are copies of DefaultContext.
444 """
445 try:
446 return _local.__decimal_context__
447 except AttributeError:
448 context = Context()
449 _local.__decimal_context__ = context
450 return context
451
452 def setcontext(context, _local=local):
453 """Set this thread's context to context."""
454 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000455 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000456 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000457 _local.__decimal_context__ = context
458
459 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000460
Thomas Wouters89f507f2006-12-13 04:49:30 +0000461def localcontext(ctx=None):
462 """Return a context manager for a copy of the supplied context
463
464 Uses a copy of the current context if no context is specified
465 The returned context manager creates a local decimal context
466 in a with statement:
467 def sin(x):
468 with localcontext() as ctx:
469 ctx.prec += 2
470 # Rest of sin calculation algorithm
471 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000472 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000473
474 def sin(x):
475 with localcontext(ExtendedContext):
476 # Rest of sin calculation algorithm
477 # uses the Extended Context from the
478 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000479 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000480
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000481 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000482 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000483 28
484 >>> with localcontext():
485 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000486 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000487 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000488 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000489 30
490 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000491 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000492 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000493 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000494 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000495 28
496 """
497 if ctx is None: ctx = getcontext()
498 return _ContextManager(ctx)
499
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000500
Guido van Rossumd8faa362007-04-27 19:54:29 +0000501##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000502
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000503# Do not subclass Decimal from numbers.Real and do not register it as such
504# (because Decimals are not interoperable with floats). See the notes in
505# numbers.py for more detail.
506
507class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000508 """Floating point class for decimal arithmetic."""
509
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000510 __slots__ = ('_exp','_int','_sign', '_is_special')
511 # Generally, the value of the Decimal instance is given by
512 # (-1)**_sign * _int * 10**_exp
513 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000514
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000515 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000516 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000517 """Create a decimal point instance.
518
519 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000520 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000521 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000522 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000523 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000524 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000525 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000526 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000527 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000528 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000530
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000531 # Note that the coefficient, self._int, is actually stored as
532 # a string rather than as a tuple of digits. This speeds up
533 # the "digits to integer" and "integer to digits" conversions
534 # that are used in almost every arithmetic operation on
535 # Decimals. This is an internal detail: the as_tuple function
536 # and the Decimal constructor still deal with tuples of
537 # digits.
538
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000540
Christian Heimesd59c64c2007-11-30 19:27:20 +0000541 # From a string
542 # REs insist on real strings, so we can too.
543 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000544 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000545 if m is None:
546 if context is None:
547 context = getcontext()
548 return context._raise_error(ConversionSyntax,
549 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000550
Christian Heimesd59c64c2007-11-30 19:27:20 +0000551 if m.group('sign') == "-":
552 self._sign = 1
553 else:
554 self._sign = 0
555 intpart = m.group('int')
556 if intpart is not None:
557 # finite number
Mark Dickinson345adc42009-08-02 10:14:23 +0000558 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000559 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000560 self._int = str(int(intpart+fracpart))
561 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000562 self._is_special = False
563 else:
564 diag = m.group('diag')
565 if diag is not None:
566 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000567 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000568 if m.group('signal'):
569 self._exp = 'N'
570 else:
571 self._exp = 'n'
572 else:
573 # infinity
574 self._int = '0'
575 self._exp = 'F'
576 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 return self
578
579 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000580 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000581 if value >= 0:
582 self._sign = 0
583 else:
584 self._sign = 1
585 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000586 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000587 self._is_special = False
588 return self
589
590 # From another decimal
591 if isinstance(value, Decimal):
592 self._exp = value._exp
593 self._sign = value._sign
594 self._int = value._int
595 self._is_special = value._is_special
596 return self
597
598 # From an internal working value
599 if isinstance(value, _WorkRep):
600 self._sign = value.sign
601 self._int = str(value.int)
602 self._exp = int(value.exp)
603 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000604 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000605
606 # tuple/list conversion (possibly from as_tuple())
607 if isinstance(value, (list,tuple)):
608 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000609 raise ValueError('Invalid tuple size in creation of Decimal '
610 'from list or tuple. The list or tuple '
611 'should have exactly three elements.')
612 # process sign. The isinstance test rejects floats
613 if not (isinstance(value[0], int) and value[0] in (0,1)):
614 raise ValueError("Invalid sign. The first value in the tuple "
615 "should be an integer; either 0 for a "
616 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000618 if value[2] == 'F':
619 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000620 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000622 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000623 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000624 # process and validate the digits in value[1]
625 digits = []
626 for digit in value[1]:
627 if isinstance(digit, int) and 0 <= digit <= 9:
628 # skip leading zeros
629 if digits or digit != 0:
630 digits.append(digit)
631 else:
632 raise ValueError("The second value in the tuple must "
633 "be composed of integers in the range "
634 "0 through 9.")
635 if value[2] in ('n', 'N'):
636 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000637 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000638 self._exp = value[2]
639 self._is_special = True
640 elif isinstance(value[2], int):
641 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000642 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000643 self._exp = value[2]
644 self._is_special = False
645 else:
646 raise ValueError("The third value in the tuple must "
647 "be an integer, or one of the "
648 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000649 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000650
Raymond Hettingerbf440692004-07-10 14:14:37 +0000651 if isinstance(value, float):
Raymond Hettinger96798592010-04-02 16:58:27 +0000652 value = Decimal.from_float(value)
653 self._exp = value._exp
654 self._sign = value._sign
655 self._int = value._int
656 self._is_special = value._is_special
657 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000658
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000659 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000660
Mark Dickinsonba298e42009-01-04 21:17:43 +0000661 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
662 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000663 def from_float(cls, f):
664 """Converts a float to a decimal number, exactly.
665
666 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
667 Since 0.1 is not exactly representable in binary floating point, the
668 value is stored as the nearest representable value which is
669 0x1.999999999999ap-4. The exact equivalent of the value in decimal
670 is 0.1000000000000000055511151231257827021181583404541015625.
671
672 >>> Decimal.from_float(0.1)
673 Decimal('0.1000000000000000055511151231257827021181583404541015625')
674 >>> Decimal.from_float(float('nan'))
675 Decimal('NaN')
676 >>> Decimal.from_float(float('inf'))
677 Decimal('Infinity')
678 >>> Decimal.from_float(-float('inf'))
679 Decimal('-Infinity')
680 >>> Decimal.from_float(-0.0)
681 Decimal('-0')
682
683 """
684 if isinstance(f, int): # handle integer inputs
685 return cls(f)
686 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
687 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000688 if _math.copysign(1.0, f) == 1.0:
689 sign = 0
690 else:
691 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000692 n, d = abs(f).as_integer_ratio()
693 k = d.bit_length() - 1
694 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000695 if cls is Decimal:
696 return result
697 else:
698 return cls(result)
699 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000700
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 def _isnan(self):
702 """Returns whether the number is not actually one.
703
704 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000705 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000706 2 if sNaN
707 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000708 if self._is_special:
709 exp = self._exp
710 if exp == 'n':
711 return 1
712 elif exp == 'N':
713 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000714 return 0
715
716 def _isinfinity(self):
717 """Returns whether the number is infinite
718
719 0 if finite or not a number
720 1 if +INF
721 -1 if -INF
722 """
723 if self._exp == 'F':
724 if self._sign:
725 return -1
726 return 1
727 return 0
728
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000729 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000730 """Returns whether the number is not actually one.
731
732 if self, other are sNaN, signal
733 if self, other are NaN return nan
734 return 0
735
736 Done before operations.
737 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000738
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000739 self_is_nan = self._isnan()
740 if other is None:
741 other_is_nan = False
742 else:
743 other_is_nan = other._isnan()
744
745 if self_is_nan or other_is_nan:
746 if context is None:
747 context = getcontext()
748
749 if self_is_nan == 2:
750 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000751 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752 if other_is_nan == 2:
753 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000754 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000755 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000756 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000757
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000758 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000759 return 0
760
Christian Heimes77c02eb2008-02-09 02:18:51 +0000761 def _compare_check_nans(self, other, context):
762 """Version of _check_nans used for the signaling comparisons
763 compare_signal, __le__, __lt__, __ge__, __gt__.
764
765 Signal InvalidOperation if either self or other is a (quiet
766 or signaling) NaN. Signaling NaNs take precedence over quiet
767 NaNs.
768
769 Return 0 if neither operand is a NaN.
770
771 """
772 if context is None:
773 context = getcontext()
774
775 if self._is_special or other._is_special:
776 if self.is_snan():
777 return context._raise_error(InvalidOperation,
778 'comparison involving sNaN',
779 self)
780 elif other.is_snan():
781 return context._raise_error(InvalidOperation,
782 'comparison involving sNaN',
783 other)
784 elif self.is_qnan():
785 return context._raise_error(InvalidOperation,
786 'comparison involving NaN',
787 self)
788 elif other.is_qnan():
789 return context._raise_error(InvalidOperation,
790 'comparison involving NaN',
791 other)
792 return 0
793
Jack Diederich4dafcc42006-11-28 19:15:13 +0000794 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000795 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000797 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000798 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000799 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000800
Christian Heimes77c02eb2008-02-09 02:18:51 +0000801 def _cmp(self, other):
802 """Compare the two non-NaN decimal instances self and other.
803
804 Returns -1 if self < other, 0 if self == other and 1
805 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000806
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000807 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000808 self_inf = self._isinfinity()
809 other_inf = other._isinfinity()
810 if self_inf == other_inf:
811 return 0
812 elif self_inf < other_inf:
813 return -1
814 else:
815 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000816
Mark Dickinsone6aad752009-01-25 10:48:51 +0000817 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000818 if not self:
819 if not other:
820 return 0
821 else:
822 return -((-1)**other._sign)
823 if not other:
824 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000825
Guido van Rossumd8faa362007-04-27 19:54:29 +0000826 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000827 if other._sign < self._sign:
828 return -1
829 if self._sign < other._sign:
830 return 1
831
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000832 self_adjusted = self.adjusted()
833 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000834 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000835 self_padded = self._int + '0'*(self._exp - other._exp)
836 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000837 if self_padded == other_padded:
838 return 0
839 elif self_padded < other_padded:
840 return -(-1)**self._sign
841 else:
842 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000843 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000844 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000845 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000846 return -((-1)**self._sign)
847
Christian Heimes77c02eb2008-02-09 02:18:51 +0000848 # Note: The Decimal standard doesn't cover rich comparisons for
849 # Decimals. In particular, the specification is silent on the
850 # subject of what should happen for a comparison involving a NaN.
851 # We take the following approach:
852 #
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000853 # == comparisons involving a quiet NaN always return False
854 # != comparisons involving a quiet NaN always return True
855 # == or != comparisons involving a signaling NaN signal
856 # InvalidOperation, and return False or True as above if the
857 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000858 # <, >, <= and >= comparisons involving a (quiet or signaling)
859 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000860 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000861 #
862 # This behavior is designed to conform as closely as possible to
863 # that specified by IEEE 754.
864
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000865 def __eq__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000866 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000867 if other is NotImplemented:
868 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000869 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000870 return False
871 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000872
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000873 def __ne__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000874 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000875 if other is NotImplemented:
876 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000877 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000878 return True
879 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000880
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000881
Christian Heimes77c02eb2008-02-09 02:18:51 +0000882 def __lt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000883 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000884 if other is NotImplemented:
885 return other
886 ans = self._compare_check_nans(other, context)
887 if ans:
888 return False
889 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000890
Christian Heimes77c02eb2008-02-09 02:18:51 +0000891 def __le__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000892 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000893 if other is NotImplemented:
894 return other
895 ans = self._compare_check_nans(other, context)
896 if ans:
897 return False
898 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000899
Christian Heimes77c02eb2008-02-09 02:18:51 +0000900 def __gt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000901 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000902 if other is NotImplemented:
903 return other
904 ans = self._compare_check_nans(other, context)
905 if ans:
906 return False
907 return self._cmp(other) > 0
908
909 def __ge__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000910 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000911 if other is NotImplemented:
912 return other
913 ans = self._compare_check_nans(other, context)
914 if ans:
915 return False
916 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000917
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000918 def compare(self, other, context=None):
919 """Compares one to another.
920
921 -1 => a < b
922 0 => a = b
923 1 => a > b
924 NaN => one is NaN
925 Like __cmp__, but returns Decimal instances.
926 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000927 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
Guido van Rossumd8faa362007-04-27 19:54:29 +0000929 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000930 if (self._is_special or other and other._is_special):
931 ans = self._check_nans(other, context)
932 if ans:
933 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000934
Christian Heimes77c02eb2008-02-09 02:18:51 +0000935 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000936
937 def __hash__(self):
938 """x.__hash__() <==> hash(x)"""
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000939
Mark Dickinsondc787d22010-05-23 13:33:13 +0000940 # In order to make sure that the hash of a Decimal instance
941 # agrees with the hash of a numerically equal integer, float
942 # or Fraction, we follow the rules for numeric hashes outlined
943 # in the documentation. (See library docs, 'Built-in Types').
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000944 if self._is_special:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000945 if self.is_snan():
946 raise TypeError('Cannot hash a signaling NaN value.')
947 elif self.is_nan():
Mark Dickinsondc787d22010-05-23 13:33:13 +0000948 return _PyHASH_NAN
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000949 else:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000950 if self._sign:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000951 return -_PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000952 else:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000953 return _PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000954
Mark Dickinsondc787d22010-05-23 13:33:13 +0000955 if self._exp >= 0:
956 exp_hash = pow(10, self._exp, _PyHASH_MODULUS)
957 else:
958 exp_hash = pow(_PyHASH_10INV, -self._exp, _PyHASH_MODULUS)
959 hash_ = int(self._int) * exp_hash % _PyHASH_MODULUS
960 return hash_ if self >= 0 else -hash_
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000961
962 def as_tuple(self):
963 """Represents the number as a triple tuple.
964
965 To show the internals exactly as they are.
966 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000967 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000968
969 def __repr__(self):
970 """Represents the number as an instance of Decimal."""
971 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000972 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000973
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000974 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000975 """Return string representation of the number in scientific notation.
976
977 Captures all of the information in the underlying representation.
978 """
979
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000980 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000981 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000982 if self._exp == 'F':
983 return sign + 'Infinity'
984 elif self._exp == 'n':
985 return sign + 'NaN' + self._int
986 else: # self._exp == 'N'
987 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000989 # number of digits of self._int to left of decimal point
990 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000991
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000992 # dotplace is number of digits of self._int to the left of the
993 # decimal point in the mantissa of the output string (that is,
994 # after adjusting the exponent)
995 if self._exp <= 0 and leftdigits > -6:
996 # no exponent required
997 dotplace = leftdigits
998 elif not eng:
999 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001001 elif self._int == '0':
1002 # engineering notation, zero
1003 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001005 # engineering notation, nonzero
1006 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001007
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001008 if dotplace <= 0:
1009 intpart = '0'
1010 fracpart = '.' + '0'*(-dotplace) + self._int
1011 elif dotplace >= len(self._int):
1012 intpart = self._int+'0'*(dotplace-len(self._int))
1013 fracpart = ''
1014 else:
1015 intpart = self._int[:dotplace]
1016 fracpart = '.' + self._int[dotplace:]
1017 if leftdigits == dotplace:
1018 exp = ''
1019 else:
1020 if context is None:
1021 context = getcontext()
1022 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1023
1024 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025
1026 def to_eng_string(self, context=None):
1027 """Convert to engineering-type string.
1028
1029 Engineering notation has an exponent which is a multiple of 3, so there
1030 are up to 3 digits left of the decimal place.
1031
1032 Same rules for when in exponential and when as a value as in __str__.
1033 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001034 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001035
1036 def __neg__(self, context=None):
1037 """Returns a copy with the sign switched.
1038
1039 Rounds, if it has reason.
1040 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001041 if self._is_special:
1042 ans = self._check_nans(context=context)
1043 if ans:
1044 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001045
1046 if not self:
1047 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001048 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001049 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001050 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001051
1052 if context is None:
1053 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001054 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001055
1056 def __pos__(self, context=None):
1057 """Returns a copy, unless it is a sNaN.
1058
1059 Rounds the number (if more then precision digits)
1060 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001061 if self._is_special:
1062 ans = self._check_nans(context=context)
1063 if ans:
1064 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001065
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001066 if not self:
1067 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001068 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001069 else:
1070 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001071
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001072 if context is None:
1073 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001074 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075
Christian Heimes2c181612007-12-17 20:04:13 +00001076 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001077 """Returns the absolute value of self.
1078
Christian Heimes2c181612007-12-17 20:04:13 +00001079 If the keyword argument 'round' is false, do not round. The
1080 expression self.__abs__(round=False) is equivalent to
1081 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082 """
Christian Heimes2c181612007-12-17 20:04:13 +00001083 if not round:
1084 return self.copy_abs()
1085
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001086 if self._is_special:
1087 ans = self._check_nans(context=context)
1088 if ans:
1089 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001091 if self._sign:
1092 ans = self.__neg__(context=context)
1093 else:
1094 ans = self.__pos__(context=context)
1095
1096 return ans
1097
1098 def __add__(self, other, context=None):
1099 """Returns self + other.
1100
1101 -INF + INF (or the reverse) cause InvalidOperation errors.
1102 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001104 if other is NotImplemented:
1105 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001106
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001107 if context is None:
1108 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001109
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001110 if self._is_special or other._is_special:
1111 ans = self._check_nans(other, context)
1112 if ans:
1113 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001114
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001115 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001116 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001117 if self._sign != other._sign and other._isinfinity():
1118 return context._raise_error(InvalidOperation, '-INF + INF')
1119 return Decimal(self)
1120 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001122
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001123 exp = min(self._exp, other._exp)
1124 negativezero = 0
1125 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001126 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001127 negativezero = 1
1128
1129 if not self and not other:
1130 sign = min(self._sign, other._sign)
1131 if negativezero:
1132 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001133 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001134 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001135 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001136 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001137 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001138 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001139 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001140 return ans
1141 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001142 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001143 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001144 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001145 return ans
1146
1147 op1 = _WorkRep(self)
1148 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001149 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150
1151 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001153 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001154 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001155 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001156 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001157 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001159 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001160 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001161 if op1.sign == 1:
1162 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001163 op1.sign, op2.sign = op2.sign, op1.sign
1164 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001165 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001166 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001167 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001169 op1.sign, op2.sign = (0, 0)
1170 else:
1171 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001172 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173
Raymond Hettinger17931de2004-10-27 06:21:46 +00001174 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001175 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001176 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001177 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
1179 result.exp = op1.exp
1180 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001181 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001182 return ans
1183
1184 __radd__ = __add__
1185
1186 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001187 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001188 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001189 if other is NotImplemented:
1190 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001192 if self._is_special or other._is_special:
1193 ans = self._check_nans(other, context=context)
1194 if ans:
1195 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001197 # self - other is computed as self + other.copy_negate()
1198 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001199
1200 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001201 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001202 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001203 if other is NotImplemented:
1204 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001206 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001208 def __mul__(self, other, context=None):
1209 """Return self * other.
1210
1211 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1212 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001214 if other is NotImplemented:
1215 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001216
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001217 if context is None:
1218 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001220 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001222 if self._is_special or other._is_special:
1223 ans = self._check_nans(other, context)
1224 if ans:
1225 return ans
1226
1227 if self._isinfinity():
1228 if not other:
1229 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001230 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001231
1232 if other._isinfinity():
1233 if not self:
1234 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001235 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236
1237 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001238
1239 # Special case for multiplying by zero
1240 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001241 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001242 # Fixing in case the exponent is out of bounds
1243 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001244 return ans
1245
1246 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001247 if self._int == '1':
1248 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001249 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001250 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001251 if other._int == '1':
1252 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001253 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001254 return ans
1255
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001256 op1 = _WorkRep(self)
1257 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001259 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001260 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001261
1262 return ans
1263 __rmul__ = __mul__
1264
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001265 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001268 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001269 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001270
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001271 if context is None:
1272 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001274 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001275
1276 if self._is_special or other._is_special:
1277 ans = self._check_nans(other, context)
1278 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001279 return ans
1280
1281 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001284 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001285 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001286
1287 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001288 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001289 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001290
1291 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001293 if not self:
1294 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001296
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001297 if not self:
1298 exp = self._exp - other._exp
1299 coeff = 0
1300 else:
1301 # OK, so neither = 0, INF or NaN
1302 shift = len(other._int) - len(self._int) + context.prec + 1
1303 exp = self._exp - other._exp - shift
1304 op1 = _WorkRep(self)
1305 op2 = _WorkRep(other)
1306 if shift >= 0:
1307 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1308 else:
1309 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1310 if remainder:
1311 # result is not exact; adjust to ensure correct rounding
1312 if coeff % 5 == 0:
1313 coeff += 1
1314 else:
1315 # result is exact; get as close to ideal exponent as possible
1316 ideal_exp = self._exp - other._exp
1317 while exp < ideal_exp and coeff % 10 == 0:
1318 coeff //= 10
1319 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001321 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001322 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 def _divide(self, other, context):
1325 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001326
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001327 Assumes that neither self nor other is a NaN, that self is not
1328 infinite and that other is nonzero.
1329 """
1330 sign = self._sign ^ other._sign
1331 if other._isinfinity():
1332 ideal_exp = self._exp
1333 else:
1334 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001335
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336 expdiff = self.adjusted() - other.adjusted()
1337 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001338 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001339 self._rescale(ideal_exp, context.rounding))
1340 if expdiff <= context.prec:
1341 op1 = _WorkRep(self)
1342 op2 = _WorkRep(other)
1343 if op1.exp >= op2.exp:
1344 op1.int *= 10**(op1.exp - op2.exp)
1345 else:
1346 op2.int *= 10**(op2.exp - op1.exp)
1347 q, r = divmod(op1.int, op2.int)
1348 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001349 return (_dec_from_triple(sign, str(q), 0),
1350 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001352 # Here the quotient is too large to be representable
1353 ans = context._raise_error(DivisionImpossible,
1354 'quotient too large in //, % or divmod')
1355 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001356
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001357 def __rtruediv__(self, other, context=None):
1358 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001359 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001360 if other is NotImplemented:
1361 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001362 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
1364 def __divmod__(self, other, context=None):
1365 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001366 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001367 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001368 other = _convert_other(other)
1369 if other is NotImplemented:
1370 return other
1371
1372 if context is None:
1373 context = getcontext()
1374
1375 ans = self._check_nans(other, context)
1376 if ans:
1377 return (ans, ans)
1378
1379 sign = self._sign ^ other._sign
1380 if self._isinfinity():
1381 if other._isinfinity():
1382 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1383 return ans, ans
1384 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001385 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001386 context._raise_error(InvalidOperation, 'INF % x'))
1387
1388 if not other:
1389 if not self:
1390 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1391 return ans, ans
1392 else:
1393 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1394 context._raise_error(InvalidOperation, 'x % 0'))
1395
1396 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001397 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001398 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001399
1400 def __rdivmod__(self, other, context=None):
1401 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001402 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001403 if other is NotImplemented:
1404 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405 return other.__divmod__(self, context=context)
1406
1407 def __mod__(self, other, context=None):
1408 """
1409 self % other
1410 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001411 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001412 if other is NotImplemented:
1413 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001415 if context is None:
1416 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001417
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001418 ans = self._check_nans(other, context)
1419 if ans:
1420 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001421
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001422 if self._isinfinity():
1423 return context._raise_error(InvalidOperation, 'INF % x')
1424 elif not other:
1425 if self:
1426 return context._raise_error(InvalidOperation, 'x % 0')
1427 else:
1428 return context._raise_error(DivisionUndefined, '0 % 0')
1429
1430 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001431 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001432 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001433
1434 def __rmod__(self, other, context=None):
1435 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001436 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001437 if other is NotImplemented:
1438 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001439 return other.__mod__(self, context=context)
1440
1441 def remainder_near(self, other, context=None):
1442 """
1443 Remainder nearest to 0- abs(remainder-near) <= other/2
1444 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001445 if context is None:
1446 context = getcontext()
1447
1448 other = _convert_other(other, raiseit=True)
1449
1450 ans = self._check_nans(other, context)
1451 if ans:
1452 return ans
1453
1454 # self == +/-infinity -> InvalidOperation
1455 if self._isinfinity():
1456 return context._raise_error(InvalidOperation,
1457 'remainder_near(infinity, x)')
1458
1459 # other == 0 -> either InvalidOperation or DivisionUndefined
1460 if not other:
1461 if self:
1462 return context._raise_error(InvalidOperation,
1463 'remainder_near(x, 0)')
1464 else:
1465 return context._raise_error(DivisionUndefined,
1466 'remainder_near(0, 0)')
1467
1468 # other = +/-infinity -> remainder = self
1469 if other._isinfinity():
1470 ans = Decimal(self)
1471 return ans._fix(context)
1472
1473 # self = 0 -> remainder = self, with ideal exponent
1474 ideal_exponent = min(self._exp, other._exp)
1475 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001476 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001477 return ans._fix(context)
1478
1479 # catch most cases of large or small quotient
1480 expdiff = self.adjusted() - other.adjusted()
1481 if expdiff >= context.prec + 1:
1482 # expdiff >= prec+1 => abs(self/other) > 10**prec
1483 return context._raise_error(DivisionImpossible)
1484 if expdiff <= -2:
1485 # expdiff <= -2 => abs(self/other) < 0.1
1486 ans = self._rescale(ideal_exponent, context.rounding)
1487 return ans._fix(context)
1488
1489 # adjust both arguments to have the same exponent, then divide
1490 op1 = _WorkRep(self)
1491 op2 = _WorkRep(other)
1492 if op1.exp >= op2.exp:
1493 op1.int *= 10**(op1.exp - op2.exp)
1494 else:
1495 op2.int *= 10**(op2.exp - op1.exp)
1496 q, r = divmod(op1.int, op2.int)
1497 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1498 # 10**ideal_exponent. Apply correction to ensure that
1499 # abs(remainder) <= abs(other)/2
1500 if 2*r + (q&1) > op2.int:
1501 r -= op2.int
1502 q += 1
1503
1504 if q >= 10**context.prec:
1505 return context._raise_error(DivisionImpossible)
1506
1507 # result has same sign as self unless r is negative
1508 sign = self._sign
1509 if r < 0:
1510 sign = 1-sign
1511 r = -r
1512
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001513 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001514 return ans._fix(context)
1515
1516 def __floordiv__(self, other, context=None):
1517 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001518 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001519 if other is NotImplemented:
1520 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001521
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001522 if context is None:
1523 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001524
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001525 ans = self._check_nans(other, context)
1526 if ans:
1527 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001528
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001529 if self._isinfinity():
1530 if other._isinfinity():
1531 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001532 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001533 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001534
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001535 if not other:
1536 if self:
1537 return context._raise_error(DivisionByZero, 'x // 0',
1538 self._sign ^ other._sign)
1539 else:
1540 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001541
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001542 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
1544 def __rfloordiv__(self, other, context=None):
1545 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001546 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001547 if other is NotImplemented:
1548 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001549 return other.__floordiv__(self, context=context)
1550
1551 def __float__(self):
1552 """Float representation."""
1553 return float(str(self))
1554
1555 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001556 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 if self._is_special:
1558 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001559 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001560 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001561 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001562 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001563 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001564 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001565 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001566 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001567
Christian Heimes969fe572008-01-25 11:23:10 +00001568 __trunc__ = __int__
1569
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570 def real(self):
1571 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001572 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001573
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574 def imag(self):
1575 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001576 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001577
1578 def conjugate(self):
1579 return self
1580
1581 def __complex__(self):
1582 return complex(float(self))
1583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001584 def _fix_nan(self, context):
1585 """Decapitate the payload of a NaN to fit the context"""
1586 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001588 # maximum length of payload is precision if clamp=0,
1589 # precision-1 if clamp=1.
1590 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001592 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1593 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001594 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001595
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001596 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597 """Round if it is necessary to keep self within prec precision.
1598
1599 Rounds and fixes the exponent. Does not raise on a sNaN.
1600
1601 Arguments:
1602 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603 context - context used.
1604 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001605
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001606 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001607 if self._isnan():
1608 # decapitate payload if necessary
1609 return self._fix_nan(context)
1610 else:
1611 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001612 return Decimal(self)
1613
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001614 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001615 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 Etiny = context.Etiny()
1617 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001618 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001619 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001620 new_exp = min(max(self._exp, Etiny), exp_max)
1621 if new_exp != self._exp:
1622 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001623 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001624 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001625 return Decimal(self)
1626
1627 # exp_min is the smallest allowable exponent of the result,
1628 # equal to max(self.adjusted()-context.prec+1, Etiny)
1629 exp_min = len(self._int) + self._exp - context.prec
1630 if exp_min > Etop:
1631 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001632 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001633 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001634 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001635 return ans
1636
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001637 self_is_subnormal = exp_min < Etiny
1638 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001639 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001640
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001641 # round if self has too many digits
1642 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001643 digits = len(self._int) + self._exp - exp_min
1644 if digits < 0:
1645 self = _dec_from_triple(self._sign, '1', exp_min-1)
1646 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001647 rounding_method = self._pick_rounding_function[context.rounding]
1648 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001649 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001650 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001651 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001652 if len(coeff) > context.prec:
1653 coeff = coeff[:-1]
1654 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001655
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001656 # check whether the rounding pushed the exponent out of range
1657 if exp_min > Etop:
1658 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1659 else:
1660 ans = _dec_from_triple(self._sign, coeff, exp_min)
1661
1662 # raise the appropriate signals, taking care to respect
1663 # the precedence described in the specification
1664 if changed and self_is_subnormal:
1665 context._raise_error(Underflow)
1666 if self_is_subnormal:
1667 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001668 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001669 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001670 context._raise_error(Rounded)
1671 if not ans:
1672 # raise Clamped on underflow to 0
1673 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001674 return ans
1675
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001676 if self_is_subnormal:
1677 context._raise_error(Subnormal)
1678
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001679 # fold down if clamp == 1 and self has too few digits
1680 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001681 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001682 self_padded = self._int + '0'*(self._exp - Etop)
1683 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001685 # here self was representable to begin with; return unchanged
1686 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001687
1688 _pick_rounding_function = {}
1689
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690 # for each of the rounding functions below:
1691 # self is a finite, nonzero Decimal
1692 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001693 #
1694 # each function returns either -1, 0, or 1, as follows:
1695 # 1 indicates that self should be rounded up (away from zero)
1696 # 0 indicates that self should be truncated, and that all the
1697 # digits to be truncated are zeros (so the value is unchanged)
1698 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001699
1700 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001702 if _all_zeros(self._int, prec):
1703 return 0
1704 else:
1705 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001707 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001708 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001709 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001711 def _round_half_up(self, prec):
1712 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001713 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001714 return 1
1715 elif _all_zeros(self._int, prec):
1716 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001717 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001718 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001719
1720 def _round_half_down(self, prec):
1721 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001722 if _exact_half(self._int, prec):
1723 return -1
1724 else:
1725 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001726
1727 def _round_half_even(self, prec):
1728 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001729 if _exact_half(self._int, prec) and \
1730 (prec == 0 or self._int[prec-1] in '02468'):
1731 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001732 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001733 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001734
1735 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001736 """Rounds up (not away from 0 if negative.)"""
1737 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001738 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001740 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001742 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743 """Rounds down (not towards 0 if negative)"""
1744 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001745 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001747 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001749 def _round_05up(self, prec):
1750 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001751 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001752 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001753 else:
1754 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001755
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001756 def __round__(self, n=None):
1757 """Round self to the nearest integer, or to a given precision.
1758
1759 If only one argument is supplied, round a finite Decimal
1760 instance self to the nearest integer. If self is infinite or
1761 a NaN then a Python exception is raised. If self is finite
1762 and lies exactly halfway between two integers then it is
1763 rounded to the integer with even last digit.
1764
1765 >>> round(Decimal('123.456'))
1766 123
1767 >>> round(Decimal('-456.789'))
1768 -457
1769 >>> round(Decimal('-3.0'))
1770 -3
1771 >>> round(Decimal('2.5'))
1772 2
1773 >>> round(Decimal('3.5'))
1774 4
1775 >>> round(Decimal('Inf'))
1776 Traceback (most recent call last):
1777 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001778 OverflowError: cannot round an infinity
1779 >>> round(Decimal('NaN'))
1780 Traceback (most recent call last):
1781 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001782 ValueError: cannot round a NaN
1783
1784 If a second argument n is supplied, self is rounded to n
1785 decimal places using the rounding mode for the current
1786 context.
1787
1788 For an integer n, round(self, -n) is exactly equivalent to
1789 self.quantize(Decimal('1En')).
1790
1791 >>> round(Decimal('123.456'), 0)
1792 Decimal('123')
1793 >>> round(Decimal('123.456'), 2)
1794 Decimal('123.46')
1795 >>> round(Decimal('123.456'), -2)
1796 Decimal('1E+2')
1797 >>> round(Decimal('-Infinity'), 37)
1798 Decimal('NaN')
1799 >>> round(Decimal('sNaN123'), 0)
1800 Decimal('NaN123')
1801
1802 """
1803 if n is not None:
1804 # two-argument form: use the equivalent quantize call
1805 if not isinstance(n, int):
1806 raise TypeError('Second argument to round should be integral')
1807 exp = _dec_from_triple(0, '1', -n)
1808 return self.quantize(exp)
1809
1810 # one-argument form
1811 if self._is_special:
1812 if self.is_nan():
1813 raise ValueError("cannot round a NaN")
1814 else:
1815 raise OverflowError("cannot round an infinity")
1816 return int(self._rescale(0, ROUND_HALF_EVEN))
1817
1818 def __floor__(self):
1819 """Return the floor of self, as an integer.
1820
1821 For a finite Decimal instance self, return the greatest
1822 integer n such that n <= self. If self is infinite or a NaN
1823 then a Python exception is raised.
1824
1825 """
1826 if self._is_special:
1827 if self.is_nan():
1828 raise ValueError("cannot round a NaN")
1829 else:
1830 raise OverflowError("cannot round an infinity")
1831 return int(self._rescale(0, ROUND_FLOOR))
1832
1833 def __ceil__(self):
1834 """Return the ceiling of self, as an integer.
1835
1836 For a finite Decimal instance self, return the least integer n
1837 such that n >= self. If self is infinite or a NaN then a
1838 Python exception is raised.
1839
1840 """
1841 if self._is_special:
1842 if self.is_nan():
1843 raise ValueError("cannot round a NaN")
1844 else:
1845 raise OverflowError("cannot round an infinity")
1846 return int(self._rescale(0, ROUND_CEILING))
1847
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001848 def fma(self, other, third, context=None):
1849 """Fused multiply-add.
1850
1851 Returns self*other+third with no rounding of the intermediate
1852 product self*other.
1853
1854 self and other are multiplied together, with no rounding of
1855 the result. The third operand is then added to the result,
1856 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001857 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001858
1859 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001860
1861 # compute product; raise InvalidOperation if either operand is
1862 # a signaling NaN or if the product is zero times infinity.
1863 if self._is_special or other._is_special:
1864 if context is None:
1865 context = getcontext()
1866 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001867 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001868 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001869 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001870 if self._exp == 'n':
1871 product = self
1872 elif other._exp == 'n':
1873 product = other
1874 elif self._exp == 'F':
1875 if not other:
1876 return context._raise_error(InvalidOperation,
1877 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001878 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001879 elif other._exp == 'F':
1880 if not self:
1881 return context._raise_error(InvalidOperation,
1882 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001883 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001884 else:
1885 product = _dec_from_triple(self._sign ^ other._sign,
1886 str(int(self._int) * int(other._int)),
1887 self._exp + other._exp)
1888
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001889 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001890 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001891
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892 def _power_modulo(self, other, modulo, context=None):
1893 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001894
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895 # if can't convert other and modulo to Decimal, raise
1896 # TypeError; there's no point returning NotImplemented (no
1897 # equivalent of __rpow__ for three argument pow)
1898 other = _convert_other(other, raiseit=True)
1899 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001900
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001901 if context is None:
1902 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001903
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001904 # deal with NaNs: if there are any sNaNs then first one wins,
1905 # (i.e. behaviour for NaNs is identical to that of fma)
1906 self_is_nan = self._isnan()
1907 other_is_nan = other._isnan()
1908 modulo_is_nan = modulo._isnan()
1909 if self_is_nan or other_is_nan or modulo_is_nan:
1910 if self_is_nan == 2:
1911 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001912 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001913 if other_is_nan == 2:
1914 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001915 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001916 if modulo_is_nan == 2:
1917 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001918 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001919 if self_is_nan:
1920 return self._fix_nan(context)
1921 if other_is_nan:
1922 return other._fix_nan(context)
1923 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001924
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001925 # check inputs: we apply same restrictions as Python's pow()
1926 if not (self._isinteger() and
1927 other._isinteger() and
1928 modulo._isinteger()):
1929 return context._raise_error(InvalidOperation,
1930 'pow() 3rd argument not allowed '
1931 'unless all arguments are integers')
1932 if other < 0:
1933 return context._raise_error(InvalidOperation,
1934 'pow() 2nd argument cannot be '
1935 'negative when 3rd argument specified')
1936 if not modulo:
1937 return context._raise_error(InvalidOperation,
1938 'pow() 3rd argument cannot be 0')
1939
1940 # additional restriction for decimal: the modulus must be less
1941 # than 10**prec in absolute value
1942 if modulo.adjusted() >= context.prec:
1943 return context._raise_error(InvalidOperation,
1944 'insufficient precision: pow() 3rd '
1945 'argument must not have more than '
1946 'precision digits')
1947
1948 # define 0**0 == NaN, for consistency with two-argument pow
1949 # (even though it hurts!)
1950 if not other and not self:
1951 return context._raise_error(InvalidOperation,
1952 'at least one of pow() 1st argument '
1953 'and 2nd argument must be nonzero ;'
1954 '0**0 is not defined')
1955
1956 # compute sign of result
1957 if other._iseven():
1958 sign = 0
1959 else:
1960 sign = self._sign
1961
1962 # convert modulo to a Python integer, and self and other to
1963 # Decimal integers (i.e. force their exponents to be >= 0)
1964 modulo = abs(int(modulo))
1965 base = _WorkRep(self.to_integral_value())
1966 exponent = _WorkRep(other.to_integral_value())
1967
1968 # compute result using integer pow()
1969 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1970 for i in range(exponent.exp):
1971 base = pow(base, 10, modulo)
1972 base = pow(base, exponent.int, modulo)
1973
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001974 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001975
1976 def _power_exact(self, other, p):
1977 """Attempt to compute self**other exactly.
1978
1979 Given Decimals self and other and an integer p, attempt to
1980 compute an exact result for the power self**other, with p
1981 digits of precision. Return None if self**other is not
1982 exactly representable in p digits.
1983
1984 Assumes that elimination of special cases has already been
1985 performed: self and other must both be nonspecial; self must
1986 be positive and not numerically equal to 1; other must be
1987 nonzero. For efficiency, other._exp should not be too large,
1988 so that 10**abs(other._exp) is a feasible calculation."""
1989
1990 # In the comments below, we write x for the value of self and
1991 # y for the value of other. Write x = xc*10**xe and y =
1992 # yc*10**ye.
1993
1994 # The main purpose of this method is to identify the *failure*
1995 # of x**y to be exactly representable with as little effort as
1996 # possible. So we look for cheap and easy tests that
1997 # eliminate the possibility of x**y being exact. Only if all
1998 # these tests are passed do we go on to actually compute x**y.
1999
2000 # Here's the main idea. First normalize both x and y. We
2001 # express y as a rational m/n, with m and n relatively prime
2002 # and n>0. Then for x**y to be exactly representable (at
2003 # *any* precision), xc must be the nth power of a positive
2004 # integer and xe must be divisible by n. If m is negative
2005 # then additionally xc must be a power of either 2 or 5, hence
2006 # a power of 2**n or 5**n.
2007 #
2008 # There's a limit to how small |y| can be: if y=m/n as above
2009 # then:
2010 #
2011 # (1) if xc != 1 then for the result to be representable we
2012 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2013 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2014 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2015 # representable.
2016 #
2017 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2018 # |y| < 1/|xe| then the result is not representable.
2019 #
2020 # Note that since x is not equal to 1, at least one of (1) and
2021 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2022 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2023 #
2024 # There's also a limit to how large y can be, at least if it's
2025 # positive: the normalized result will have coefficient xc**y,
2026 # so if it's representable then xc**y < 10**p, and y <
2027 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2028 # not exactly representable.
2029
2030 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2031 # so |y| < 1/xe and the result is not representable.
2032 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2033 # < 1/nbits(xc).
2034
2035 x = _WorkRep(self)
2036 xc, xe = x.int, x.exp
2037 while xc % 10 == 0:
2038 xc //= 10
2039 xe += 1
2040
2041 y = _WorkRep(other)
2042 yc, ye = y.int, y.exp
2043 while yc % 10 == 0:
2044 yc //= 10
2045 ye += 1
2046
2047 # case where xc == 1: result is 10**(xe*y), with xe*y
2048 # required to be an integer
2049 if xc == 1:
Mark Dickinsona1236312010-07-08 19:03:34 +00002050 xe *= yc
2051 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2052 while xe % 10 == 0:
2053 xe //= 10
2054 ye += 1
2055 if ye < 0:
2056 return None
2057 exponent = xe * 10**ye
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002058 if y.sign == 1:
2059 exponent = -exponent
2060 # if other is a nonnegative integer, use ideal exponent
2061 if other._isinteger() and other._sign == 0:
2062 ideal_exponent = self._exp*int(other)
2063 zeros = min(exponent-ideal_exponent, p-1)
2064 else:
2065 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002066 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002067
2068 # case where y is negative: xc must be either a power
2069 # of 2 or a power of 5.
2070 if y.sign == 1:
2071 last_digit = xc % 10
2072 if last_digit in (2,4,6,8):
2073 # quick test for power of 2
2074 if xc & -xc != xc:
2075 return None
2076 # now xc is a power of 2; e is its exponent
2077 e = _nbits(xc)-1
2078 # find e*y and xe*y; both must be integers
2079 if ye >= 0:
2080 y_as_int = yc*10**ye
2081 e = e*y_as_int
2082 xe = xe*y_as_int
2083 else:
2084 ten_pow = 10**-ye
2085 e, remainder = divmod(e*yc, ten_pow)
2086 if remainder:
2087 return None
2088 xe, remainder = divmod(xe*yc, ten_pow)
2089 if remainder:
2090 return None
2091
2092 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2093 return None
2094 xc = 5**e
2095
2096 elif last_digit == 5:
2097 # e >= log_5(xc) if xc is a power of 5; we have
2098 # equality all the way up to xc=5**2658
2099 e = _nbits(xc)*28//65
2100 xc, remainder = divmod(5**e, xc)
2101 if remainder:
2102 return None
2103 while xc % 5 == 0:
2104 xc //= 5
2105 e -= 1
2106 if ye >= 0:
2107 y_as_integer = yc*10**ye
2108 e = e*y_as_integer
2109 xe = xe*y_as_integer
2110 else:
2111 ten_pow = 10**-ye
2112 e, remainder = divmod(e*yc, ten_pow)
2113 if remainder:
2114 return None
2115 xe, remainder = divmod(xe*yc, ten_pow)
2116 if remainder:
2117 return None
2118 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2119 return None
2120 xc = 2**e
2121 else:
2122 return None
2123
2124 if xc >= 10**p:
2125 return None
2126 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002127 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002128
2129 # now y is positive; find m and n such that y = m/n
2130 if ye >= 0:
2131 m, n = yc*10**ye, 1
2132 else:
2133 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2134 return None
2135 xc_bits = _nbits(xc)
2136 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2137 return None
2138 m, n = yc, 10**(-ye)
2139 while m % 2 == n % 2 == 0:
2140 m //= 2
2141 n //= 2
2142 while m % 5 == n % 5 == 0:
2143 m //= 5
2144 n //= 5
2145
2146 # compute nth root of xc*10**xe
2147 if n > 1:
2148 # if 1 < xc < 2**n then xc isn't an nth power
2149 if xc != 1 and xc_bits <= n:
2150 return None
2151
2152 xe, rem = divmod(xe, n)
2153 if rem != 0:
2154 return None
2155
2156 # compute nth root of xc using Newton's method
2157 a = 1 << -(-_nbits(xc)//n) # initial estimate
2158 while True:
2159 q, r = divmod(xc, a**(n-1))
2160 if a <= q:
2161 break
2162 else:
2163 a = (a*(n-1) + q)//n
2164 if not (a == q and r == 0):
2165 return None
2166 xc = a
2167
2168 # now xc*10**xe is the nth root of the original xc*10**xe
2169 # compute mth power of xc*10**xe
2170
2171 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2172 # 10**p and the result is not representable.
2173 if xc > 1 and m > p*100//_log10_lb(xc):
2174 return None
2175 xc = xc**m
2176 xe *= m
2177 if xc > 10**p:
2178 return None
2179
2180 # by this point the result *is* exactly representable
2181 # adjust the exponent to get as close as possible to the ideal
2182 # exponent, if necessary
2183 str_xc = str(xc)
2184 if other._isinteger() and other._sign == 0:
2185 ideal_exponent = self._exp*int(other)
2186 zeros = min(xe-ideal_exponent, p-len(str_xc))
2187 else:
2188 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002189 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002190
2191 def __pow__(self, other, modulo=None, context=None):
2192 """Return self ** other [ % modulo].
2193
2194 With two arguments, compute self**other.
2195
2196 With three arguments, compute (self**other) % modulo. For the
2197 three argument form, the following restrictions on the
2198 arguments hold:
2199
2200 - all three arguments must be integral
2201 - other must be nonnegative
2202 - either self or other (or both) must be nonzero
2203 - modulo must be nonzero and must have at most p digits,
2204 where p is the context precision.
2205
2206 If any of these restrictions is violated the InvalidOperation
2207 flag is raised.
2208
2209 The result of pow(self, other, modulo) is identical to the
2210 result that would be obtained by computing (self**other) %
2211 modulo with unbounded precision, but is computed more
2212 efficiently. It is always exact.
2213 """
2214
2215 if modulo is not None:
2216 return self._power_modulo(other, modulo, context)
2217
2218 other = _convert_other(other)
2219 if other is NotImplemented:
2220 return other
2221
2222 if context is None:
2223 context = getcontext()
2224
2225 # either argument is a NaN => result is NaN
2226 ans = self._check_nans(other, context)
2227 if ans:
2228 return ans
2229
2230 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2231 if not other:
2232 if not self:
2233 return context._raise_error(InvalidOperation, '0 ** 0')
2234 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002235 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002236
2237 # result has sign 1 iff self._sign is 1 and other is an odd integer
2238 result_sign = 0
2239 if self._sign == 1:
2240 if other._isinteger():
2241 if not other._iseven():
2242 result_sign = 1
2243 else:
2244 # -ve**noninteger = NaN
2245 # (-0)**noninteger = 0**noninteger
2246 if self:
2247 return context._raise_error(InvalidOperation,
2248 'x ** y with x negative and y not an integer')
2249 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002250 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002251
2252 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2253 if not self:
2254 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002255 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002256 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002257 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258
2259 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002260 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002261 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002262 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002263 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002264 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002265
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002266 # 1**other = 1, but the choice of exponent and the flags
2267 # depend on the exponent of self, and on whether other is a
2268 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002269 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002270 if other._isinteger():
2271 # exp = max(self._exp*max(int(other), 0),
2272 # 1-context.prec) but evaluating int(other) directly
2273 # is dangerous until we know other is small (other
2274 # could be 1e999999999)
2275 if other._sign == 1:
2276 multiplier = 0
2277 elif other > context.prec:
2278 multiplier = context.prec
2279 else:
2280 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002281
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002282 exp = self._exp * multiplier
2283 if exp < 1-context.prec:
2284 exp = 1-context.prec
2285 context._raise_error(Rounded)
2286 else:
2287 context._raise_error(Inexact)
2288 context._raise_error(Rounded)
2289 exp = 1-context.prec
2290
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002291 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002292
2293 # compute adjusted exponent of self
2294 self_adj = self.adjusted()
2295
2296 # self ** infinity is infinity if self > 1, 0 if self < 1
2297 # self ** -infinity is infinity if self < 1, 0 if self > 1
2298 if other._isinfinity():
2299 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002300 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002301 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002302 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002303
2304 # from here on, the result always goes through the call
2305 # to _fix at the end of this function.
2306 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002307 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002308
2309 # crude test to catch cases of extreme overflow/underflow. If
2310 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2311 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2312 # self**other >= 10**(Emax+1), so overflow occurs. The test
2313 # for underflow is similar.
2314 bound = self._log10_exp_bound() + other.adjusted()
2315 if (self_adj >= 0) == (other._sign == 0):
2316 # self > 1 and other +ve, or self < 1 and other -ve
2317 # possibility of overflow
2318 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002319 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002320 else:
2321 # self > 1 and other -ve, or self < 1 and other +ve
2322 # possibility of underflow to 0
2323 Etiny = context.Etiny()
2324 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002325 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002326
2327 # try for an exact result with precision +1
2328 if ans is None:
2329 ans = self._power_exact(other, context.prec + 1)
2330 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002331 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002332 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002333
2334 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2335 if ans is None:
2336 p = context.prec
2337 x = _WorkRep(self)
2338 xc, xe = x.int, x.exp
2339 y = _WorkRep(other)
2340 yc, ye = y.int, y.exp
2341 if y.sign == 1:
2342 yc = -yc
2343
2344 # compute correctly rounded result: start with precision +3,
2345 # then increase precision until result is unambiguously roundable
2346 extra = 3
2347 while True:
2348 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2349 if coeff % (5*10**(len(str(coeff))-p-1)):
2350 break
2351 extra += 3
2352
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002353 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002354
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002355 # unlike exp, ln and log10, the power function respects the
2356 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2357
2358 # There's a difficulty here when 'other' is not an integer and
2359 # the result is exact. In this case, the specification
2360 # requires that the Inexact flag be raised (in spite of
2361 # exactness), but since the result is exact _fix won't do this
2362 # for us. (Correspondingly, the Underflow signal should also
2363 # be raised for subnormal results.) We can't directly raise
2364 # these signals either before or after calling _fix, since
2365 # that would violate the precedence for signals. So we wrap
2366 # the ._fix call in a temporary context, and reraise
2367 # afterwards.
2368 if exact and not other._isinteger():
2369 # pad with zeros up to length context.prec+1 if necessary; this
2370 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002371 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002372 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002373 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2374 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002375
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002376 # create a copy of the current context, with cleared flags/traps
2377 newcontext = context.copy()
2378 newcontext.clear_flags()
2379 for exception in _signals:
2380 newcontext.traps[exception] = 0
2381
2382 # round in the new context
2383 ans = ans._fix(newcontext)
2384
2385 # raise Inexact, and if necessary, Underflow
2386 newcontext._raise_error(Inexact)
2387 if newcontext.flags[Subnormal]:
2388 newcontext._raise_error(Underflow)
2389
2390 # propagate signals to the original context; _fix could
2391 # have raised any of Overflow, Underflow, Subnormal,
2392 # Inexact, Rounded, Clamped. Overflow needs the correct
2393 # arguments. Note that the order of the exceptions is
2394 # important here.
2395 if newcontext.flags[Overflow]:
2396 context._raise_error(Overflow, 'above Emax', ans._sign)
2397 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2398 if newcontext.flags[exception]:
2399 context._raise_error(exception)
2400
2401 else:
2402 ans = ans._fix(context)
2403
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002404 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002405
2406 def __rpow__(self, other, context=None):
2407 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002408 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002409 if other is NotImplemented:
2410 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002411 return other.__pow__(self, context=context)
2412
2413 def normalize(self, context=None):
2414 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002415
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002416 if context is None:
2417 context = getcontext()
2418
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002419 if self._is_special:
2420 ans = self._check_nans(context=context)
2421 if ans:
2422 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002423
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002424 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002425 if dup._isinfinity():
2426 return dup
2427
2428 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002429 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002430 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002431 end = len(dup._int)
2432 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002433 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002434 exp += 1
2435 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002436 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002438 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002439 """Quantize self so its exponent is the same as that of exp.
2440
2441 Similar to self._rescale(exp._exp) but with error checking.
2442 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002443 exp = _convert_other(exp, raiseit=True)
2444
2445 if context is None:
2446 context = getcontext()
2447 if rounding is None:
2448 rounding = context.rounding
2449
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002450 if self._is_special or exp._is_special:
2451 ans = self._check_nans(exp, context)
2452 if ans:
2453 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002454
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002455 if exp._isinfinity() or self._isinfinity():
2456 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002457 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002458 return context._raise_error(InvalidOperation,
2459 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002460
2461 # if we're not watching exponents, do a simple rescale
2462 if not watchexp:
2463 ans = self._rescale(exp._exp, rounding)
2464 # raise Inexact and Rounded where appropriate
2465 if ans._exp > self._exp:
2466 context._raise_error(Rounded)
2467 if ans != self:
2468 context._raise_error(Inexact)
2469 return ans
2470
2471 # exp._exp should be between Etiny and Emax
2472 if not (context.Etiny() <= exp._exp <= context.Emax):
2473 return context._raise_error(InvalidOperation,
2474 'target exponent out of bounds in quantize')
2475
2476 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002477 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002478 return ans._fix(context)
2479
2480 self_adjusted = self.adjusted()
2481 if self_adjusted > context.Emax:
2482 return context._raise_error(InvalidOperation,
2483 'exponent of quantize result too large for current context')
2484 if self_adjusted - exp._exp + 1 > context.prec:
2485 return context._raise_error(InvalidOperation,
2486 'quantize result has too many digits for current context')
2487
2488 ans = self._rescale(exp._exp, rounding)
2489 if ans.adjusted() > context.Emax:
2490 return context._raise_error(InvalidOperation,
2491 'exponent of quantize result too large for current context')
2492 if len(ans._int) > context.prec:
2493 return context._raise_error(InvalidOperation,
2494 'quantize result has too many digits for current context')
2495
2496 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002497 if ans and ans.adjusted() < context.Emin:
2498 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002499 if ans._exp > self._exp:
2500 if ans != self:
2501 context._raise_error(Inexact)
2502 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002503
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002504 # call to fix takes care of any necessary folddown, and
2505 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002506 ans = ans._fix(context)
2507 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002508
2509 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002510 """Return True if self and other have the same exponent; otherwise
2511 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002513 If either operand is a special value, the following rules are used:
2514 * return True if both operands are infinities
2515 * return True if both operands are NaNs
2516 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002517 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002518 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002519 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002520 return (self.is_nan() and other.is_nan() or
2521 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002522 return self._exp == other._exp
2523
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002524 def _rescale(self, exp, rounding):
2525 """Rescale self so that the exponent is exp, either by padding with zeros
2526 or by truncating digits, using the given rounding mode.
2527
2528 Specials are returned without change. This operation is
2529 quiet: it raises no flags, and uses no information from the
2530 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002531
2532 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002533 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002535 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002536 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002538 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002539
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002540 if self._exp >= exp:
2541 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002542 return _dec_from_triple(self._sign,
2543 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002544
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002545 # too many digits; round and lose data. If self.adjusted() <
2546 # exp-1, replace self by 10**(exp-1) before rounding
2547 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002548 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002549 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002550 digits = 0
2551 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002552 changed = this_function(digits)
2553 coeff = self._int[:digits] or '0'
2554 if changed == 1:
2555 coeff = str(int(coeff)+1)
2556 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002557
Christian Heimesf16baeb2008-02-29 14:57:44 +00002558 def _round(self, places, rounding):
2559 """Round a nonzero, nonspecial Decimal to a fixed number of
2560 significant figures, using the given rounding mode.
2561
2562 Infinities, NaNs and zeros are returned unaltered.
2563
2564 This operation is quiet: it raises no flags, and uses no
2565 information from the context.
2566
2567 """
2568 if places <= 0:
2569 raise ValueError("argument should be at least 1 in _round")
2570 if self._is_special or not self:
2571 return Decimal(self)
2572 ans = self._rescale(self.adjusted()+1-places, rounding)
2573 # it can happen that the rescale alters the adjusted exponent;
2574 # for example when rounding 99.97 to 3 significant figures.
2575 # When this happens we end up with an extra 0 at the end of
2576 # the number; a second rescale fixes this.
2577 if ans.adjusted() != self.adjusted():
2578 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2579 return ans
2580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002581 def to_integral_exact(self, rounding=None, context=None):
2582 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002584 If no rounding mode is specified, take the rounding mode from
2585 the context. This method raises the Rounded and Inexact flags
2586 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002587
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002588 See also: to_integral_value, which does exactly the same as
2589 this method except that it doesn't raise Inexact or Rounded.
2590 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002591 if self._is_special:
2592 ans = self._check_nans(context=context)
2593 if ans:
2594 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002595 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002596 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002597 return Decimal(self)
2598 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002599 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002600 if context is None:
2601 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002602 if rounding is None:
2603 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002604 ans = self._rescale(0, rounding)
2605 if ans != self:
2606 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002607 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002608 return ans
2609
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002610 def to_integral_value(self, rounding=None, context=None):
2611 """Rounds to the nearest integer, without raising inexact, rounded."""
2612 if context is None:
2613 context = getcontext()
2614 if rounding is None:
2615 rounding = context.rounding
2616 if self._is_special:
2617 ans = self._check_nans(context=context)
2618 if ans:
2619 return ans
2620 return Decimal(self)
2621 if self._exp >= 0:
2622 return Decimal(self)
2623 else:
2624 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002625
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002626 # the method name changed, but we provide also the old one, for compatibility
2627 to_integral = to_integral_value
2628
2629 def sqrt(self, context=None):
2630 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002631 if context is None:
2632 context = getcontext()
2633
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002634 if self._is_special:
2635 ans = self._check_nans(context=context)
2636 if ans:
2637 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002638
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002639 if self._isinfinity() and self._sign == 0:
2640 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002643 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002644 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002645 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002646
2647 if self._sign == 1:
2648 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2649
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002650 # At this point self represents a positive number. Let p be
2651 # the desired precision and express self in the form c*100**e
2652 # with c a positive real number and e an integer, c and e
2653 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2654 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2655 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2656 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2657 # the closest integer to sqrt(c) with the even integer chosen
2658 # in the case of a tie.
2659 #
2660 # To ensure correct rounding in all cases, we use the
2661 # following trick: we compute the square root to an extra
2662 # place (precision p+1 instead of precision p), rounding down.
2663 # Then, if the result is inexact and its last digit is 0 or 5,
2664 # we increase the last digit to 1 or 6 respectively; if it's
2665 # exact we leave the last digit alone. Now the final round to
2666 # p places (or fewer in the case of underflow) will round
2667 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002669 # use an extra digit of precision
2670 prec = context.prec+1
2671
2672 # write argument in the form c*100**e where e = self._exp//2
2673 # is the 'ideal' exponent, to be used if the square root is
2674 # exactly representable. l is the number of 'digits' of c in
2675 # base 100, so that 100**(l-1) <= c < 100**l.
2676 op = _WorkRep(self)
2677 e = op.exp >> 1
2678 if op.exp & 1:
2679 c = op.int * 10
2680 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002681 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002682 c = op.int
2683 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002684
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002685 # rescale so that c has exactly prec base 100 'digits'
2686 shift = prec-l
2687 if shift >= 0:
2688 c *= 100**shift
2689 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002690 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002691 c, remainder = divmod(c, 100**-shift)
2692 exact = not remainder
2693 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002694
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002695 # find n = floor(sqrt(c)) using Newton's method
2696 n = 10**prec
2697 while True:
2698 q = c//n
2699 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002700 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002701 else:
2702 n = n + q >> 1
2703 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002704
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002705 if exact:
2706 # result is exact; rescale to use ideal exponent e
2707 if shift >= 0:
2708 # assert n % 10**shift == 0
2709 n //= 10**shift
2710 else:
2711 n *= 10**-shift
2712 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002713 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002714 # result is not exact; fix last digit as described above
2715 if n % 5 == 0:
2716 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002717
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002718 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002719
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002720 # round, and fit to current context
2721 context = context._shallow_copy()
2722 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002723 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002724 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002725
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002726 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002727
2728 def max(self, other, context=None):
2729 """Returns the larger value.
2730
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002731 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002732 NaN (and signals if one is sNaN). Also rounds.
2733 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002734 other = _convert_other(other, raiseit=True)
2735
2736 if context is None:
2737 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002738
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002739 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002740 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002741 # number is always returned
2742 sn = self._isnan()
2743 on = other._isnan()
2744 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002745 if on == 1 and sn == 0:
2746 return self._fix(context)
2747 if sn == 1 and on == 0:
2748 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002749 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002750
Christian Heimes77c02eb2008-02-09 02:18:51 +00002751 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002752 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002753 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002754 # then an ordering is applied:
2755 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002756 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002757 # positive sign and min returns the operand with the negative sign
2758 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002759 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002760 # the result. This is exactly the ordering used in compare_total.
2761 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002762
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002763 if c == -1:
2764 ans = other
2765 else:
2766 ans = self
2767
Christian Heimes2c181612007-12-17 20:04:13 +00002768 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002769
2770 def min(self, other, context=None):
2771 """Returns the smaller value.
2772
Guido van Rossumd8faa362007-04-27 19:54:29 +00002773 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002774 NaN (and signals if one is sNaN). Also rounds.
2775 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002776 other = _convert_other(other, raiseit=True)
2777
2778 if context is None:
2779 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002780
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002781 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002782 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002783 # number is always returned
2784 sn = self._isnan()
2785 on = other._isnan()
2786 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002787 if on == 1 and sn == 0:
2788 return self._fix(context)
2789 if sn == 1 and on == 0:
2790 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002791 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002792
Christian Heimes77c02eb2008-02-09 02:18:51 +00002793 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002794 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002795 c = self.compare_total(other)
2796
2797 if c == -1:
2798 ans = self
2799 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002800 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002801
Christian Heimes2c181612007-12-17 20:04:13 +00002802 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002803
2804 def _isinteger(self):
2805 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002806 if self._is_special:
2807 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002808 if self._exp >= 0:
2809 return True
2810 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002811 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002812
2813 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002814 """Returns True if self is even. Assumes self is an integer."""
2815 if not self or self._exp > 0:
2816 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002817 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002818
2819 def adjusted(self):
2820 """Return the adjusted exponent of self"""
2821 try:
2822 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002823 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002824 except TypeError:
2825 return 0
2826
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002827 def canonical(self, context=None):
2828 """Returns the same Decimal object.
2829
2830 As we do not have different encodings for the same number, the
2831 received object already is in its canonical form.
2832 """
2833 return self
2834
2835 def compare_signal(self, other, context=None):
2836 """Compares self to the other operand numerically.
2837
2838 It's pretty much like compare(), but all NaNs signal, with signaling
2839 NaNs taking precedence over quiet NaNs.
2840 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002841 other = _convert_other(other, raiseit = True)
2842 ans = self._compare_check_nans(other, context)
2843 if ans:
2844 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002845 return self.compare(other, context=context)
2846
2847 def compare_total(self, other):
2848 """Compares self to other using the abstract representations.
2849
2850 This is not like the standard compare, which use their numerical
2851 value. Note that a total ordering is defined for all possible abstract
2852 representations.
2853 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002854 other = _convert_other(other, raiseit=True)
2855
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002856 # if one is negative and the other is positive, it's easy
2857 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002858 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002860 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002861 sign = self._sign
2862
2863 # let's handle both NaN types
2864 self_nan = self._isnan()
2865 other_nan = other._isnan()
2866 if self_nan or other_nan:
2867 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002868 # compare payloads as though they're integers
2869 self_key = len(self._int), self._int
2870 other_key = len(other._int), other._int
2871 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002872 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002873 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002874 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002875 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002876 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002877 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002878 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002879 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002880 return _One
2881 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002882
2883 if sign:
2884 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002885 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002886 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002887 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002888 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002889 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002890 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002891 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002892 else:
2893 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002894 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002895 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002896 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002897 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002898 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002899 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002900 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002901
2902 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002903 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002904 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002905 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002906
2907 if self._exp < other._exp:
2908 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002909 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002910 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002911 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002912 if self._exp > other._exp:
2913 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002914 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002915 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002916 return _One
2917 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002918
2919
2920 def compare_total_mag(self, other):
2921 """Compares self to other using abstract repr., ignoring sign.
2922
2923 Like compare_total, but with operand's sign ignored and assumed to be 0.
2924 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002925 other = _convert_other(other, raiseit=True)
2926
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002927 s = self.copy_abs()
2928 o = other.copy_abs()
2929 return s.compare_total(o)
2930
2931 def copy_abs(self):
2932 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002933 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002934
2935 def copy_negate(self):
2936 """Returns a copy with the sign inverted."""
2937 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002938 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002939 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002940 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002941
2942 def copy_sign(self, other):
2943 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002944 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002945 return _dec_from_triple(other._sign, self._int,
2946 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002947
2948 def exp(self, context=None):
2949 """Returns e ** self."""
2950
2951 if context is None:
2952 context = getcontext()
2953
2954 # exp(NaN) = NaN
2955 ans = self._check_nans(context=context)
2956 if ans:
2957 return ans
2958
2959 # exp(-Infinity) = 0
2960 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002961 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002962
2963 # exp(0) = 1
2964 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002965 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002966
2967 # exp(Infinity) = Infinity
2968 if self._isinfinity() == 1:
2969 return Decimal(self)
2970
2971 # the result is now guaranteed to be inexact (the true
2972 # mathematical result is transcendental). There's no need to
2973 # raise Rounded and Inexact here---they'll always be raised as
2974 # a result of the call to _fix.
2975 p = context.prec
2976 adj = self.adjusted()
2977
2978 # we only need to do any computation for quite a small range
2979 # of adjusted exponents---for example, -29 <= adj <= 10 for
2980 # the default context. For smaller exponent the result is
2981 # indistinguishable from 1 at the given precision, while for
2982 # larger exponent the result either overflows or underflows.
2983 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2984 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002985 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2987 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002988 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002989 elif self._sign == 0 and adj < -p:
2990 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002991 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002992 elif self._sign == 1 and adj < -p-1:
2993 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002994 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002995 # general case
2996 else:
2997 op = _WorkRep(self)
2998 c, e = op.int, op.exp
2999 if op.sign == 1:
3000 c = -c
3001
3002 # compute correctly rounded result: increase precision by
3003 # 3 digits at a time until we get an unambiguously
3004 # roundable result
3005 extra = 3
3006 while True:
3007 coeff, exp = _dexp(c, e, p+extra)
3008 if coeff % (5*10**(len(str(coeff))-p-1)):
3009 break
3010 extra += 3
3011
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003012 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003013
3014 # at this stage, ans should round correctly with *any*
3015 # rounding mode, not just with ROUND_HALF_EVEN
3016 context = context._shallow_copy()
3017 rounding = context._set_rounding(ROUND_HALF_EVEN)
3018 ans = ans._fix(context)
3019 context.rounding = rounding
3020
3021 return ans
3022
3023 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003024 """Return True if self is canonical; otherwise return False.
3025
3026 Currently, the encoding of a Decimal instance is always
3027 canonical, so this method returns True for any Decimal.
3028 """
3029 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003030
3031 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003032 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003033
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003034 A Decimal instance is considered finite if it is neither
3035 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003036 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003037 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003038
3039 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003040 """Return True if self is infinite; otherwise return False."""
3041 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003042
3043 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003044 """Return True if self is a qNaN or sNaN; otherwise return False."""
3045 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003046
3047 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003048 """Return True if self is a normal number; otherwise return False."""
3049 if self._is_special or not self:
3050 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003051 if context is None:
3052 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003053 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003054
3055 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003056 """Return True if self is a quiet NaN; otherwise return False."""
3057 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003058
3059 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003060 """Return True if self is negative; otherwise return False."""
3061 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003062
3063 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003064 """Return True if self is a signaling NaN; otherwise return False."""
3065 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003066
3067 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003068 """Return True if self is subnormal; otherwise return False."""
3069 if self._is_special or not self:
3070 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003071 if context is None:
3072 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003073 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003074
3075 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003076 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003077 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003078
3079 def _ln_exp_bound(self):
3080 """Compute a lower bound for the adjusted exponent of self.ln().
3081 In other words, compute r such that self.ln() >= 10**r. Assumes
3082 that self is finite and positive and that self != 1.
3083 """
3084
3085 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3086 adj = self._exp + len(self._int) - 1
3087 if adj >= 1:
3088 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3089 return len(str(adj*23//10)) - 1
3090 if adj <= -2:
3091 # argument <= 0.1
3092 return len(str((-1-adj)*23//10)) - 1
3093 op = _WorkRep(self)
3094 c, e = op.int, op.exp
3095 if adj == 0:
3096 # 1 < self < 10
3097 num = str(c-10**-e)
3098 den = str(c)
3099 return len(num) - len(den) - (num < den)
3100 # adj == -1, 0.1 <= self < 1
3101 return e + len(str(10**-e - c)) - 1
3102
3103
3104 def ln(self, context=None):
3105 """Returns the natural (base e) logarithm of self."""
3106
3107 if context is None:
3108 context = getcontext()
3109
3110 # ln(NaN) = NaN
3111 ans = self._check_nans(context=context)
3112 if ans:
3113 return ans
3114
3115 # ln(0.0) == -Infinity
3116 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003117 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003118
3119 # ln(Infinity) = Infinity
3120 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003121 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003122
3123 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003124 if self == _One:
3125 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003126
3127 # ln(negative) raises InvalidOperation
3128 if self._sign == 1:
3129 return context._raise_error(InvalidOperation,
3130 'ln of a negative value')
3131
3132 # result is irrational, so necessarily inexact
3133 op = _WorkRep(self)
3134 c, e = op.int, op.exp
3135 p = context.prec
3136
3137 # correctly rounded result: repeatedly increase precision by 3
3138 # until we get an unambiguously roundable result
3139 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3140 while True:
3141 coeff = _dlog(c, e, places)
3142 # assert len(str(abs(coeff)))-p >= 1
3143 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3144 break
3145 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003146 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003147
3148 context = context._shallow_copy()
3149 rounding = context._set_rounding(ROUND_HALF_EVEN)
3150 ans = ans._fix(context)
3151 context.rounding = rounding
3152 return ans
3153
3154 def _log10_exp_bound(self):
3155 """Compute a lower bound for the adjusted exponent of self.log10().
3156 In other words, find r such that self.log10() >= 10**r.
3157 Assumes that self is finite and positive and that self != 1.
3158 """
3159
3160 # For x >= 10 or x < 0.1 we only need a bound on the integer
3161 # part of log10(self), and this comes directly from the
3162 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3163 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3164 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3165
3166 adj = self._exp + len(self._int) - 1
3167 if adj >= 1:
3168 # self >= 10
3169 return len(str(adj))-1
3170 if adj <= -2:
3171 # self < 0.1
3172 return len(str(-1-adj))-1
3173 op = _WorkRep(self)
3174 c, e = op.int, op.exp
3175 if adj == 0:
3176 # 1 < self < 10
3177 num = str(c-10**-e)
3178 den = str(231*c)
3179 return len(num) - len(den) - (num < den) + 2
3180 # adj == -1, 0.1 <= self < 1
3181 num = str(10**-e-c)
3182 return len(num) + e - (num < "231") - 1
3183
3184 def log10(self, context=None):
3185 """Returns the base 10 logarithm of self."""
3186
3187 if context is None:
3188 context = getcontext()
3189
3190 # log10(NaN) = NaN
3191 ans = self._check_nans(context=context)
3192 if ans:
3193 return ans
3194
3195 # log10(0.0) == -Infinity
3196 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003197 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003198
3199 # log10(Infinity) = Infinity
3200 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003201 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003202
3203 # log10(negative or -Infinity) raises InvalidOperation
3204 if self._sign == 1:
3205 return context._raise_error(InvalidOperation,
3206 'log10 of a negative value')
3207
3208 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003209 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003210 # answer may need rounding
3211 ans = Decimal(self._exp + len(self._int) - 1)
3212 else:
3213 # result is irrational, so necessarily inexact
3214 op = _WorkRep(self)
3215 c, e = op.int, op.exp
3216 p = context.prec
3217
3218 # correctly rounded result: repeatedly increase precision
3219 # until result is unambiguously roundable
3220 places = p-self._log10_exp_bound()+2
3221 while True:
3222 coeff = _dlog10(c, e, places)
3223 # assert len(str(abs(coeff)))-p >= 1
3224 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3225 break
3226 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003227 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003228
3229 context = context._shallow_copy()
3230 rounding = context._set_rounding(ROUND_HALF_EVEN)
3231 ans = ans._fix(context)
3232 context.rounding = rounding
3233 return ans
3234
3235 def logb(self, context=None):
3236 """ Returns the exponent of the magnitude of self's MSD.
3237
3238 The result is the integer which is the exponent of the magnitude
3239 of the most significant digit of self (as though it were truncated
3240 to a single digit while maintaining the value of that digit and
3241 without limiting the resulting exponent).
3242 """
3243 # logb(NaN) = NaN
3244 ans = self._check_nans(context=context)
3245 if ans:
3246 return ans
3247
3248 if context is None:
3249 context = getcontext()
3250
3251 # logb(+/-Inf) = +Inf
3252 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003253 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003254
3255 # logb(0) = -Inf, DivisionByZero
3256 if not self:
3257 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3258
3259 # otherwise, simply return the adjusted exponent of self, as a
3260 # Decimal. Note that no attempt is made to fit the result
3261 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003262 ans = Decimal(self.adjusted())
3263 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003264
3265 def _islogical(self):
3266 """Return True if self is a logical operand.
3267
Christian Heimes679db4a2008-01-18 09:56:22 +00003268 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003269 an exponent of 0, and a coefficient whose digits must all be
3270 either 0 or 1.
3271 """
3272 if self._sign != 0 or self._exp != 0:
3273 return False
3274 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003275 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003276 return False
3277 return True
3278
3279 def _fill_logical(self, context, opa, opb):
3280 dif = context.prec - len(opa)
3281 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003282 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003283 elif dif < 0:
3284 opa = opa[-context.prec:]
3285 dif = context.prec - len(opb)
3286 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003287 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003288 elif dif < 0:
3289 opb = opb[-context.prec:]
3290 return opa, opb
3291
3292 def logical_and(self, other, context=None):
3293 """Applies an 'and' operation between self and other's digits."""
3294 if context is None:
3295 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003296
3297 other = _convert_other(other, raiseit=True)
3298
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003299 if not self._islogical() or not other._islogical():
3300 return context._raise_error(InvalidOperation)
3301
3302 # fill to context.prec
3303 (opa, opb) = self._fill_logical(context, self._int, other._int)
3304
3305 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003306 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3307 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003308
3309 def logical_invert(self, context=None):
3310 """Invert all its digits."""
3311 if context is None:
3312 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003313 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3314 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003315
3316 def logical_or(self, other, context=None):
3317 """Applies an 'or' operation between self and other's digits."""
3318 if context is None:
3319 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003320
3321 other = _convert_other(other, raiseit=True)
3322
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003323 if not self._islogical() or not other._islogical():
3324 return context._raise_error(InvalidOperation)
3325
3326 # fill to context.prec
3327 (opa, opb) = self._fill_logical(context, self._int, other._int)
3328
3329 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003330 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003331 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003332
3333 def logical_xor(self, other, context=None):
3334 """Applies an 'xor' operation between self and other's digits."""
3335 if context is None:
3336 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003337
3338 other = _convert_other(other, raiseit=True)
3339
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003340 if not self._islogical() or not other._islogical():
3341 return context._raise_error(InvalidOperation)
3342
3343 # fill to context.prec
3344 (opa, opb) = self._fill_logical(context, self._int, other._int)
3345
3346 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003347 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003348 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003349
3350 def max_mag(self, other, context=None):
3351 """Compares the values numerically with their sign ignored."""
3352 other = _convert_other(other, raiseit=True)
3353
3354 if context is None:
3355 context = getcontext()
3356
3357 if self._is_special or other._is_special:
3358 # If one operand is a quiet NaN and the other is number, then the
3359 # number is always returned
3360 sn = self._isnan()
3361 on = other._isnan()
3362 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003363 if on == 1 and sn == 0:
3364 return self._fix(context)
3365 if sn == 1 and on == 0:
3366 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003367 return self._check_nans(other, context)
3368
Christian Heimes77c02eb2008-02-09 02:18:51 +00003369 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003370 if c == 0:
3371 c = self.compare_total(other)
3372
3373 if c == -1:
3374 ans = other
3375 else:
3376 ans = self
3377
Christian Heimes2c181612007-12-17 20:04:13 +00003378 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003379
3380 def min_mag(self, other, context=None):
3381 """Compares the values numerically with their sign ignored."""
3382 other = _convert_other(other, raiseit=True)
3383
3384 if context is None:
3385 context = getcontext()
3386
3387 if self._is_special or other._is_special:
3388 # If one operand is a quiet NaN and the other is number, then the
3389 # number is always returned
3390 sn = self._isnan()
3391 on = other._isnan()
3392 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003393 if on == 1 and sn == 0:
3394 return self._fix(context)
3395 if sn == 1 and on == 0:
3396 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003397 return self._check_nans(other, context)
3398
Christian Heimes77c02eb2008-02-09 02:18:51 +00003399 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003400 if c == 0:
3401 c = self.compare_total(other)
3402
3403 if c == -1:
3404 ans = self
3405 else:
3406 ans = other
3407
Christian Heimes2c181612007-12-17 20:04:13 +00003408 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003409
3410 def next_minus(self, context=None):
3411 """Returns the largest representable number smaller than itself."""
3412 if context is None:
3413 context = getcontext()
3414
3415 ans = self._check_nans(context=context)
3416 if ans:
3417 return ans
3418
3419 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003420 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003421 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003422 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003423
3424 context = context.copy()
3425 context._set_rounding(ROUND_FLOOR)
3426 context._ignore_all_flags()
3427 new_self = self._fix(context)
3428 if new_self != self:
3429 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003430 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3431 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003432
3433 def next_plus(self, context=None):
3434 """Returns the smallest representable number larger than itself."""
3435 if context is None:
3436 context = getcontext()
3437
3438 ans = self._check_nans(context=context)
3439 if ans:
3440 return ans
3441
3442 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003443 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003444 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003445 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003446
3447 context = context.copy()
3448 context._set_rounding(ROUND_CEILING)
3449 context._ignore_all_flags()
3450 new_self = self._fix(context)
3451 if new_self != self:
3452 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003453 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3454 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003455
3456 def next_toward(self, other, context=None):
3457 """Returns the number closest to self, in the direction towards other.
3458
3459 The result is the closest representable number to self
3460 (excluding self) that is in the direction towards other,
3461 unless both have the same value. If the two operands are
3462 numerically equal, then the result is a copy of self with the
3463 sign set to be the same as the sign of other.
3464 """
3465 other = _convert_other(other, raiseit=True)
3466
3467 if context is None:
3468 context = getcontext()
3469
3470 ans = self._check_nans(other, context)
3471 if ans:
3472 return ans
3473
Christian Heimes77c02eb2008-02-09 02:18:51 +00003474 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003475 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003476 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003477
3478 if comparison == -1:
3479 ans = self.next_plus(context)
3480 else: # comparison == 1
3481 ans = self.next_minus(context)
3482
3483 # decide which flags to raise using value of ans
3484 if ans._isinfinity():
3485 context._raise_error(Overflow,
3486 'Infinite result from next_toward',
3487 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003488 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003489 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003490 elif ans.adjusted() < context.Emin:
3491 context._raise_error(Underflow)
3492 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003493 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003494 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003495 # if precision == 1 then we don't raise Clamped for a
3496 # result 0E-Etiny.
3497 if not ans:
3498 context._raise_error(Clamped)
3499
3500 return ans
3501
3502 def number_class(self, context=None):
3503 """Returns an indication of the class of self.
3504
3505 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003506 sNaN
3507 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003508 -Infinity
3509 -Normal
3510 -Subnormal
3511 -Zero
3512 +Zero
3513 +Subnormal
3514 +Normal
3515 +Infinity
3516 """
3517 if self.is_snan():
3518 return "sNaN"
3519 if self.is_qnan():
3520 return "NaN"
3521 inf = self._isinfinity()
3522 if inf == 1:
3523 return "+Infinity"
3524 if inf == -1:
3525 return "-Infinity"
3526 if self.is_zero():
3527 if self._sign:
3528 return "-Zero"
3529 else:
3530 return "+Zero"
3531 if context is None:
3532 context = getcontext()
3533 if self.is_subnormal(context=context):
3534 if self._sign:
3535 return "-Subnormal"
3536 else:
3537 return "+Subnormal"
3538 # just a normal, regular, boring number, :)
3539 if self._sign:
3540 return "-Normal"
3541 else:
3542 return "+Normal"
3543
3544 def radix(self):
3545 """Just returns 10, as this is Decimal, :)"""
3546 return Decimal(10)
3547
3548 def rotate(self, other, context=None):
3549 """Returns a rotated copy of self, value-of-other times."""
3550 if context is None:
3551 context = getcontext()
3552
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003553 other = _convert_other(other, raiseit=True)
3554
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003555 ans = self._check_nans(other, context)
3556 if ans:
3557 return ans
3558
3559 if other._exp != 0:
3560 return context._raise_error(InvalidOperation)
3561 if not (-context.prec <= int(other) <= context.prec):
3562 return context._raise_error(InvalidOperation)
3563
3564 if self._isinfinity():
3565 return Decimal(self)
3566
3567 # get values, pad if necessary
3568 torot = int(other)
3569 rotdig = self._int
3570 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003571 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003572 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003573 elif topad < 0:
3574 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003575
3576 # let's rotate!
3577 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003578 return _dec_from_triple(self._sign,
3579 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003580
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003581 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003582 """Returns self operand after adding the second value to its exp."""
3583 if context is None:
3584 context = getcontext()
3585
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003586 other = _convert_other(other, raiseit=True)
3587
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003588 ans = self._check_nans(other, context)
3589 if ans:
3590 return ans
3591
3592 if other._exp != 0:
3593 return context._raise_error(InvalidOperation)
3594 liminf = -2 * (context.Emax + context.prec)
3595 limsup = 2 * (context.Emax + context.prec)
3596 if not (liminf <= int(other) <= limsup):
3597 return context._raise_error(InvalidOperation)
3598
3599 if self._isinfinity():
3600 return Decimal(self)
3601
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003602 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003603 d = d._fix(context)
3604 return d
3605
3606 def shift(self, other, context=None):
3607 """Returns a shifted copy of self, value-of-other times."""
3608 if context is None:
3609 context = getcontext()
3610
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003611 other = _convert_other(other, raiseit=True)
3612
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003613 ans = self._check_nans(other, context)
3614 if ans:
3615 return ans
3616
3617 if other._exp != 0:
3618 return context._raise_error(InvalidOperation)
3619 if not (-context.prec <= int(other) <= context.prec):
3620 return context._raise_error(InvalidOperation)
3621
3622 if self._isinfinity():
3623 return Decimal(self)
3624
3625 # get values, pad if necessary
3626 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003627 rotdig = self._int
3628 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003629 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003630 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003631 elif topad < 0:
3632 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003633
3634 # let's shift!
3635 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003636 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003637 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003638 shifted = rotdig + '0'*torot
3639 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003640
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003641 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003642 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003643
Guido van Rossumd8faa362007-04-27 19:54:29 +00003644 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003645 def __reduce__(self):
3646 return (self.__class__, (str(self),))
3647
3648 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003649 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003650 return self # I'm immutable; therefore I am my own clone
3651 return self.__class__(str(self))
3652
3653 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003654 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003655 return self # My components are also immutable
3656 return self.__class__(str(self))
3657
Mark Dickinson79f52032009-03-17 23:12:51 +00003658 # PEP 3101 support. the _localeconv keyword argument should be
3659 # considered private: it's provided for ease of testing only.
3660 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003661 """Format a Decimal instance according to the given specifier.
3662
3663 The specifier should be a standard format specifier, with the
3664 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003665 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3666 type is omitted it defaults to 'g' or 'G', depending on the
3667 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003668 """
3669
3670 # Note: PEP 3101 says that if the type is not present then
3671 # there should be at least one digit after the decimal point.
3672 # We take the liberty of ignoring this requirement for
3673 # Decimal---it's presumably there to make sure that
3674 # format(float, '') behaves similarly to str(float).
3675 if context is None:
3676 context = getcontext()
3677
Mark Dickinson79f52032009-03-17 23:12:51 +00003678 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003679
Mark Dickinson79f52032009-03-17 23:12:51 +00003680 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003681 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003682 sign = _format_sign(self._sign, spec)
3683 body = str(self.copy_abs())
3684 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003685
3686 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003687 if spec['type'] is None:
3688 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003689
3690 # if type is '%', adjust exponent of self accordingly
3691 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003692 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3693
3694 # round if necessary, taking rounding mode from the context
3695 rounding = context.rounding
3696 precision = spec['precision']
3697 if precision is not None:
3698 if spec['type'] in 'eE':
3699 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003700 elif spec['type'] in 'fF%':
3701 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003702 elif spec['type'] in 'gG' and len(self._int) > precision:
3703 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003704 # special case: zeros with a positive exponent can't be
3705 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003706 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003707 self = self._rescale(0, rounding)
3708
3709 # figure out placement of the decimal point
3710 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003711 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003712 if not self and precision is not None:
3713 dotplace = 1 - precision
3714 else:
3715 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003716 elif spec['type'] in 'fF%':
3717 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003718 elif spec['type'] in 'gG':
3719 if self._exp <= 0 and leftdigits > -6:
3720 dotplace = leftdigits
3721 else:
3722 dotplace = 1
3723
Mark Dickinson79f52032009-03-17 23:12:51 +00003724 # find digits before and after decimal point, and get exponent
3725 if dotplace < 0:
3726 intpart = '0'
3727 fracpart = '0'*(-dotplace) + self._int
3728 elif dotplace > len(self._int):
3729 intpart = self._int + '0'*(dotplace-len(self._int))
3730 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003731 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003732 intpart = self._int[:dotplace] or '0'
3733 fracpart = self._int[dotplace:]
3734 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003735
Mark Dickinson79f52032009-03-17 23:12:51 +00003736 # done with the decimal-specific stuff; hand over the rest
3737 # of the formatting to the _format_number function
3738 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003739
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003740def _dec_from_triple(sign, coefficient, exponent, special=False):
3741 """Create a decimal instance directly, without any validation,
3742 normalization (e.g. removal of leading zeros) or argument
3743 conversion.
3744
3745 This function is for *internal use only*.
3746 """
3747
3748 self = object.__new__(Decimal)
3749 self._sign = sign
3750 self._int = coefficient
3751 self._exp = exponent
3752 self._is_special = special
3753
3754 return self
3755
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003756# Register Decimal as a kind of Number (an abstract base class).
3757# However, do not register it as Real (because Decimals are not
3758# interoperable with floats).
3759_numbers.Number.register(Decimal)
3760
3761
Guido van Rossumd8faa362007-04-27 19:54:29 +00003762##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003763
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764
3765# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003766rounding_functions = [name for name in Decimal.__dict__.keys()
3767 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003768for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003769 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003770 globalname = name[1:].upper()
3771 val = globals()[globalname]
3772 Decimal._pick_rounding_function[val] = name
3773
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003774del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003775
Thomas Wouters89f507f2006-12-13 04:49:30 +00003776class _ContextManager(object):
3777 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003778
Thomas Wouters89f507f2006-12-13 04:49:30 +00003779 Sets a copy of the supplied context in __enter__() and restores
3780 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003781 """
3782 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003783 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003784 def __enter__(self):
3785 self.saved_context = getcontext()
3786 setcontext(self.new_context)
3787 return self.new_context
3788 def __exit__(self, t, v, tb):
3789 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003790
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003791class Context(object):
3792 """Contains the context for a Decimal instance.
3793
3794 Contains:
3795 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003796 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003797 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003798 raised when it is caused. Otherwise, a value is
3799 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003800 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003801 (Whether or not the trap_enabler is set)
3802 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003803 Emin - Minimum exponent
3804 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003805 capitals - If 1, 1*10^1 is printed as 1E+1.
3806 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003807 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003808 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003809
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003810 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003811 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003812 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003813 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003814 _ignored_flags=None):
3815 if flags is None:
3816 flags = []
3817 if _ignored_flags is None:
3818 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003819 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003820 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003821 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003822 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003823 for name, val in locals().items():
3824 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003825 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826 else:
3827 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003828 del self.self
3829
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003830 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003831 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003832 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003833 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003834 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3835 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003836 % vars(self))
3837 names = [f.__name__ for f, v in self.flags.items() if v]
3838 s.append('flags=[' + ', '.join(names) + ']')
3839 names = [t.__name__ for t, v in self.traps.items() if v]
3840 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003841 return ', '.join(s) + ')'
3842
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003843 def clear_flags(self):
3844 """Reset all flags to zero"""
3845 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003846 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003847
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003848 def _shallow_copy(self):
3849 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003850 nc = Context(self.prec, self.rounding, self.traps,
3851 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003852 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003853 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003854
3855 def copy(self):
3856 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003857 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003858 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003859 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003860 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003861 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003862
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003863 # _clamp is provided for backwards compatibility with third-party
3864 # code. May be removed in Python >= 3.3.
3865 def _get_clamp(self):
3866 "_clamp mirrors the clamp attribute. Its use is deprecated."
3867 import warnings
3868 warnings.warn('Use of the _clamp attribute is deprecated. '
3869 'Please use clamp instead.',
3870 DeprecationWarning)
3871 return self.clamp
3872
3873 def _set_clamp(self, clamp):
3874 "_clamp mirrors the clamp attribute. Its use is deprecated."
3875 import warnings
3876 warnings.warn('Use of the _clamp attribute is deprecated. '
3877 'Please use clamp instead.',
3878 DeprecationWarning)
3879 self.clamp = clamp
3880
3881 # don't bother with _del_clamp; no sane 3rd party code should
3882 # be deleting the _clamp attribute
3883 _clamp = property(_get_clamp, _set_clamp)
3884
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003885 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003886 """Handles an error
3887
3888 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003889 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003890 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003891 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003892 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003893 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003894 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003895 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003896 return error().handle(self, *args)
3897
Raymond Hettinger86173da2008-02-01 20:38:12 +00003898 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003899 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003900 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003901 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003902
3903 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003904 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003905 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003906
3907 def _ignore_all_flags(self):
3908 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003909 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003910
3911 def _ignore_flags(self, *flags):
3912 """Ignore the flags, if they are raised"""
3913 # Do not mutate-- This way, copies of a context leave the original
3914 # alone.
3915 self._ignored_flags = (self._ignored_flags + list(flags))
3916 return list(flags)
3917
3918 def _regard_flags(self, *flags):
3919 """Stop ignoring the flags, if they are raised"""
3920 if flags and isinstance(flags[0], (tuple,list)):
3921 flags = flags[0]
3922 for flag in flags:
3923 self._ignored_flags.remove(flag)
3924
Nick Coghland1abd252008-07-15 15:46:38 +00003925 # We inherit object.__hash__, so we must deny this explicitly
3926 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003927
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003928 def Etiny(self):
3929 """Returns Etiny (= Emin - prec + 1)"""
3930 return int(self.Emin - self.prec + 1)
3931
3932 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003933 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003934 return int(self.Emax - self.prec + 1)
3935
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003936 def _set_rounding(self, type):
3937 """Sets the rounding type.
3938
3939 Sets the rounding type, and returns the current (previous)
3940 rounding type. Often used like:
3941
3942 context = context.copy()
3943 # so you don't change the calling context
3944 # if an error occurs in the middle.
3945 rounding = context._set_rounding(ROUND_UP)
3946 val = self.__sub__(other, context=context)
3947 context._set_rounding(rounding)
3948
3949 This will make it round up for that operation.
3950 """
3951 rounding = self.rounding
3952 self.rounding= type
3953 return rounding
3954
Raymond Hettingerfed52962004-07-14 15:41:57 +00003955 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003956 """Creates a new Decimal instance but using self as context.
3957
3958 This method implements the to-number operation of the
3959 IBM Decimal specification."""
3960
3961 if isinstance(num, str) and num != num.strip():
3962 return self._raise_error(ConversionSyntax,
3963 "no trailing or leading whitespace is "
3964 "permitted.")
3965
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003966 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003967 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003968 return self._raise_error(ConversionSyntax,
3969 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003970 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003971
Raymond Hettinger771ed762009-01-03 19:20:32 +00003972 def create_decimal_from_float(self, f):
3973 """Creates a new Decimal instance from a float but rounding using self
3974 as the context.
3975
3976 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3977 >>> context.create_decimal_from_float(3.1415926535897932)
3978 Decimal('3.1415')
3979 >>> context = Context(prec=5, traps=[Inexact])
3980 >>> context.create_decimal_from_float(3.1415926535897932)
3981 Traceback (most recent call last):
3982 ...
3983 decimal.Inexact: None
3984
3985 """
3986 d = Decimal.from_float(f) # An exact conversion
3987 return d._fix(self) # Apply the context rounding
3988
Guido van Rossumd8faa362007-04-27 19:54:29 +00003989 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003990 def abs(self, a):
3991 """Returns the absolute value of the operand.
3992
3993 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003994 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003995 the plus operation on the operand.
3996
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003997 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003998 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003999 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004000 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004001 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004002 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004003 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004004 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004005 >>> ExtendedContext.abs(-1)
4006 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004007 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004008 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004009 return a.__abs__(context=self)
4010
4011 def add(self, a, b):
4012 """Return the sum of the two operands.
4013
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004014 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004015 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004016 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004017 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004018 >>> ExtendedContext.add(1, Decimal(2))
4019 Decimal('3')
4020 >>> ExtendedContext.add(Decimal(8), 5)
4021 Decimal('13')
4022 >>> ExtendedContext.add(5, 5)
4023 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004024 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004025 a = _convert_other(a, raiseit=True)
4026 r = a.__add__(b, context=self)
4027 if r is NotImplemented:
4028 raise TypeError("Unable to convert %s to Decimal" % b)
4029 else:
4030 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004031
4032 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004033 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004034
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004035 def canonical(self, a):
4036 """Returns the same Decimal object.
4037
4038 As we do not have different encodings for the same number, the
4039 received object already is in its canonical form.
4040
4041 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004042 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004043 """
4044 return a.canonical(context=self)
4045
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004046 def compare(self, a, b):
4047 """Compares values numerically.
4048
4049 If the signs of the operands differ, a value representing each operand
4050 ('-1' if the operand is less than zero, '0' if the operand is zero or
4051 negative zero, or '1' if the operand is greater than zero) is used in
4052 place of that operand for the comparison instead of the actual
4053 operand.
4054
4055 The comparison is then effected by subtracting the second operand from
4056 the first and then returning a value according to the result of the
4057 subtraction: '-1' if the result is less than zero, '0' if the result is
4058 zero or negative zero, or '1' if the result is greater than zero.
4059
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004060 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004061 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004062 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004064 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004065 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004066 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004067 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004068 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004069 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004070 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004071 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004072 >>> ExtendedContext.compare(1, 2)
4073 Decimal('-1')
4074 >>> ExtendedContext.compare(Decimal(1), 2)
4075 Decimal('-1')
4076 >>> ExtendedContext.compare(1, Decimal(2))
4077 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004078 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004079 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004080 return a.compare(b, context=self)
4081
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004082 def compare_signal(self, a, b):
4083 """Compares the values of the two operands numerically.
4084
4085 It's pretty much like compare(), but all NaNs signal, with signaling
4086 NaNs taking precedence over quiet NaNs.
4087
4088 >>> c = ExtendedContext
4089 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004091 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004092 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004093 >>> c.flags[InvalidOperation] = 0
4094 >>> print(c.flags[InvalidOperation])
4095 0
4096 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004097 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004098 >>> print(c.flags[InvalidOperation])
4099 1
4100 >>> c.flags[InvalidOperation] = 0
4101 >>> print(c.flags[InvalidOperation])
4102 0
4103 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004104 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004105 >>> print(c.flags[InvalidOperation])
4106 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004107 >>> c.compare_signal(-1, 2)
4108 Decimal('-1')
4109 >>> c.compare_signal(Decimal(-1), 2)
4110 Decimal('-1')
4111 >>> c.compare_signal(-1, Decimal(2))
4112 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004113 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004114 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004115 return a.compare_signal(b, context=self)
4116
4117 def compare_total(self, a, b):
4118 """Compares two operands using their abstract representation.
4119
4120 This is not like the standard compare, which use their numerical
4121 value. Note that a total ordering is defined for all possible abstract
4122 representations.
4123
4124 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004125 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004126 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004127 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004128 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004129 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004130 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004131 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004132 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004133 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004134 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004135 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004136 >>> ExtendedContext.compare_total(1, 2)
4137 Decimal('-1')
4138 >>> ExtendedContext.compare_total(Decimal(1), 2)
4139 Decimal('-1')
4140 >>> ExtendedContext.compare_total(1, Decimal(2))
4141 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004142 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004143 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004144 return a.compare_total(b)
4145
4146 def compare_total_mag(self, a, b):
4147 """Compares two operands using their abstract representation ignoring sign.
4148
4149 Like compare_total, but with operand's sign ignored and assumed to be 0.
4150 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004151 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004152 return a.compare_total_mag(b)
4153
4154 def copy_abs(self, a):
4155 """Returns a copy of the operand with the sign set to 0.
4156
4157 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004158 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004159 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004160 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004161 >>> ExtendedContext.copy_abs(-1)
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.copy_abs()
4166
4167 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004168 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004169
4170 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004171 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004172 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004173 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004174 >>> ExtendedContext.copy_decimal(1)
4175 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004176 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004177 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004178 return Decimal(a)
4179
4180 def copy_negate(self, a):
4181 """Returns a copy of the operand with the sign inverted.
4182
4183 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004184 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004185 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004186 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004187 >>> ExtendedContext.copy_negate(1)
4188 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004189 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004190 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004191 return a.copy_negate()
4192
4193 def copy_sign(self, a, b):
4194 """Copies the second operand's sign to the first one.
4195
4196 In detail, it returns a copy of the first operand with the sign
4197 equal to the sign of the second operand.
4198
4199 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004200 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004201 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004202 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004203 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004204 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004205 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004206 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004207 >>> ExtendedContext.copy_sign(1, -2)
4208 Decimal('-1')
4209 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4210 Decimal('-1')
4211 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4212 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004213 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004214 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004215 return a.copy_sign(b)
4216
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004217 def divide(self, a, b):
4218 """Decimal division in a specified context.
4219
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004220 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004221 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004222 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004223 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004224 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004225 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004226 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004227 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004228 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004229 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004230 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004231 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004232 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004233 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004234 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004235 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004236 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004237 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004238 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004239 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004240 >>> ExtendedContext.divide(5, 5)
4241 Decimal('1')
4242 >>> ExtendedContext.divide(Decimal(5), 5)
4243 Decimal('1')
4244 >>> ExtendedContext.divide(5, Decimal(5))
4245 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004246 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004247 a = _convert_other(a, raiseit=True)
4248 r = a.__truediv__(b, context=self)
4249 if r is NotImplemented:
4250 raise TypeError("Unable to convert %s to Decimal" % b)
4251 else:
4252 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004253
4254 def divide_int(self, a, b):
4255 """Divides two numbers and returns the integer part of the result.
4256
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004257 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004258 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004259 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004260 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004261 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004262 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004263 >>> ExtendedContext.divide_int(10, 3)
4264 Decimal('3')
4265 >>> ExtendedContext.divide_int(Decimal(10), 3)
4266 Decimal('3')
4267 >>> ExtendedContext.divide_int(10, Decimal(3))
4268 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004269 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004270 a = _convert_other(a, raiseit=True)
4271 r = a.__floordiv__(b, context=self)
4272 if r is NotImplemented:
4273 raise TypeError("Unable to convert %s to Decimal" % b)
4274 else:
4275 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004276
4277 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004278 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004279
4280 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4281 (Decimal('2'), Decimal('2'))
4282 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4283 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004284 >>> ExtendedContext.divmod(8, 4)
4285 (Decimal('2'), Decimal('0'))
4286 >>> ExtendedContext.divmod(Decimal(8), 4)
4287 (Decimal('2'), Decimal('0'))
4288 >>> ExtendedContext.divmod(8, Decimal(4))
4289 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004290 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004291 a = _convert_other(a, raiseit=True)
4292 r = a.__divmod__(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
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004298 def exp(self, a):
4299 """Returns e ** a.
4300
4301 >>> c = ExtendedContext.copy()
4302 >>> c.Emin = -999
4303 >>> c.Emax = 999
4304 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004305 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004306 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004307 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004308 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004309 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004310 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004311 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004312 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004313 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004314 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004315 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004316 >>> c.exp(10)
4317 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004318 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004319 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004320 return a.exp(context=self)
4321
4322 def fma(self, a, b, c):
4323 """Returns a multiplied by b, plus c.
4324
4325 The first two operands are multiplied together, using multiply,
4326 the third operand is then added to the result of that
4327 multiplication, using add, all with only one final rounding.
4328
4329 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004330 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004332 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004333 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004334 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004335 >>> ExtendedContext.fma(1, 3, 4)
4336 Decimal('7')
4337 >>> ExtendedContext.fma(1, Decimal(3), 4)
4338 Decimal('7')
4339 >>> ExtendedContext.fma(1, 3, Decimal(4))
4340 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004341 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004342 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004343 return a.fma(b, c, context=self)
4344
4345 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004346 """Return True if the operand is canonical; otherwise return False.
4347
4348 Currently, the encoding of a Decimal instance is always
4349 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004350
4351 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004352 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004353 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004354 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004355
4356 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004357 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004358
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004359 A Decimal instance is considered finite if it is neither
4360 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004361
4362 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004363 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004364 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004365 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004366 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004367 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004368 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004369 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004370 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004371 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004372 >>> ExtendedContext.is_finite(1)
4373 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004375 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004376 return a.is_finite()
4377
4378 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004379 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004380
4381 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004382 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004383 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004384 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004386 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004387 >>> ExtendedContext.is_infinite(1)
4388 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004390 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004391 return a.is_infinite()
4392
4393 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004394 """Return True if the operand is a qNaN or sNaN;
4395 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004396
4397 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004398 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004400 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004401 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004402 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004403 >>> ExtendedContext.is_nan(1)
4404 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004405 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004406 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004407 return a.is_nan()
4408
4409 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004410 """Return True if the operand is a normal number;
4411 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004412
4413 >>> c = ExtendedContext.copy()
4414 >>> c.Emin = -999
4415 >>> c.Emax = 999
4416 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004417 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004419 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004421 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004423 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004424 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004425 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004426 >>> c.is_normal(1)
4427 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004428 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004429 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004430 return a.is_normal(context=self)
4431
4432 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004433 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004434
4435 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004436 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004437 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004438 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004439 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004440 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004441 >>> ExtendedContext.is_qnan(1)
4442 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004444 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004445 return a.is_qnan()
4446
4447 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004448 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004449
4450 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004451 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004453 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004454 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004455 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004456 >>> ExtendedContext.is_signed(8)
4457 False
4458 >>> ExtendedContext.is_signed(-8)
4459 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004460 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004461 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004462 return a.is_signed()
4463
4464 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004465 """Return True if the operand is a signaling NaN;
4466 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004467
4468 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004469 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004470 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004471 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004472 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004473 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004474 >>> ExtendedContext.is_snan(1)
4475 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004476 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004477 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004478 return a.is_snan()
4479
4480 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004481 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004482
4483 >>> c = ExtendedContext.copy()
4484 >>> c.Emin = -999
4485 >>> c.Emax = 999
4486 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004487 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004488 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004489 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004490 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004491 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004492 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004493 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004494 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004495 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004496 >>> c.is_subnormal(1)
4497 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004498 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004499 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004500 return a.is_subnormal(context=self)
4501
4502 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004503 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004504
4505 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004506 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004507 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004508 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004509 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004510 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004511 >>> ExtendedContext.is_zero(1)
4512 False
4513 >>> ExtendedContext.is_zero(0)
4514 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004516 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004517 return a.is_zero()
4518
4519 def ln(self, a):
4520 """Returns the natural (base e) logarithm of the operand.
4521
4522 >>> c = ExtendedContext.copy()
4523 >>> c.Emin = -999
4524 >>> c.Emax = 999
4525 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004526 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004527 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004528 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004529 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004530 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004531 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004532 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004533 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004534 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004535 >>> c.ln(1)
4536 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004537 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004538 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004539 return a.ln(context=self)
4540
4541 def log10(self, a):
4542 """Returns the base 10 logarithm of the operand.
4543
4544 >>> c = ExtendedContext.copy()
4545 >>> c.Emin = -999
4546 >>> c.Emax = 999
4547 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004548 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004549 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004550 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004551 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004552 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004553 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004554 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004555 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004556 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004557 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004558 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004559 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004560 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004561 >>> c.log10(0)
4562 Decimal('-Infinity')
4563 >>> c.log10(1)
4564 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004565 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004566 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004567 return a.log10(context=self)
4568
4569 def logb(self, a):
4570 """ Returns the exponent of the magnitude of the operand's MSD.
4571
4572 The result is the integer which is the exponent of the magnitude
4573 of the most significant digit of the operand (as though the
4574 operand were truncated to a single digit while maintaining the
4575 value of that digit and without limiting the resulting exponent).
4576
4577 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004578 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004579 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004580 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004581 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004582 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004583 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004584 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004585 >>> ExtendedContext.logb(1)
4586 Decimal('0')
4587 >>> ExtendedContext.logb(10)
4588 Decimal('1')
4589 >>> ExtendedContext.logb(100)
4590 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004591 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004592 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004593 return a.logb(context=self)
4594
4595 def logical_and(self, a, b):
4596 """Applies the logical operation 'and' between each operand's digits.
4597
4598 The operands must be both logical numbers.
4599
4600 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004602 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004603 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004604 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004605 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004606 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004607 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004608 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004609 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004610 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004611 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004612 >>> ExtendedContext.logical_and(110, 1101)
4613 Decimal('100')
4614 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4615 Decimal('100')
4616 >>> ExtendedContext.logical_and(110, Decimal(1101))
4617 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004618 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004619 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004620 return a.logical_and(b, context=self)
4621
4622 def logical_invert(self, a):
4623 """Invert all the digits in the operand.
4624
4625 The operand must be a logical number.
4626
4627 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004631 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004632 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004633 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004634 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004635 >>> ExtendedContext.logical_invert(1101)
4636 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004637 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004638 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004639 return a.logical_invert(context=self)
4640
4641 def logical_or(self, a, b):
4642 """Applies the logical operation 'or' between each operand's digits.
4643
4644 The operands must be both logical numbers.
4645
4646 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004647 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004648 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004650 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004656 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004657 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004658 >>> ExtendedContext.logical_or(110, 1101)
4659 Decimal('1111')
4660 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4661 Decimal('1111')
4662 >>> ExtendedContext.logical_or(110, Decimal(1101))
4663 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004664 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004665 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004666 return a.logical_or(b, context=self)
4667
4668 def logical_xor(self, a, b):
4669 """Applies the logical operation 'xor' between each operand's digits.
4670
4671 The operands must be both logical numbers.
4672
4673 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004675 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004677 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004679 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004680 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004681 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004682 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004683 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004684 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004685 >>> ExtendedContext.logical_xor(110, 1101)
4686 Decimal('1011')
4687 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4688 Decimal('1011')
4689 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4690 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004691 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004692 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004693 return a.logical_xor(b, context=self)
4694
Mark Dickinson84230a12010-02-18 14:49:50 +00004695 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004696 """max compares two values numerically and returns the maximum.
4697
4698 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004699 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004700 operation. If they are numerically equal then the left-hand operand
4701 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004702 infinity) of the two operands is chosen as the result.
4703
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004704 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004705 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004706 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004707 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004708 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004709 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004710 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004711 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004712 >>> ExtendedContext.max(1, 2)
4713 Decimal('2')
4714 >>> ExtendedContext.max(Decimal(1), 2)
4715 Decimal('2')
4716 >>> ExtendedContext.max(1, Decimal(2))
4717 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004718 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004719 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004720 return a.max(b, context=self)
4721
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004722 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004723 """Compares the values numerically with their sign ignored.
4724
4725 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4726 Decimal('7')
4727 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4728 Decimal('-10')
4729 >>> ExtendedContext.max_mag(1, -2)
4730 Decimal('-2')
4731 >>> ExtendedContext.max_mag(Decimal(1), -2)
4732 Decimal('-2')
4733 >>> ExtendedContext.max_mag(1, Decimal(-2))
4734 Decimal('-2')
4735 """
4736 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004737 return a.max_mag(b, context=self)
4738
Mark Dickinson84230a12010-02-18 14:49:50 +00004739 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004740 """min compares two values numerically and returns the minimum.
4741
4742 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004743 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004744 operation. If they are numerically equal then the left-hand operand
4745 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004746 infinity) of the two operands is chosen as the result.
4747
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004748 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004749 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004750 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004751 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004752 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004753 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004754 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004755 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004756 >>> ExtendedContext.min(1, 2)
4757 Decimal('1')
4758 >>> ExtendedContext.min(Decimal(1), 2)
4759 Decimal('1')
4760 >>> ExtendedContext.min(1, Decimal(29))
4761 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004762 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004763 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004764 return a.min(b, context=self)
4765
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004766 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004767 """Compares the values numerically with their sign ignored.
4768
4769 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4770 Decimal('-2')
4771 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4772 Decimal('-3')
4773 >>> ExtendedContext.min_mag(1, -2)
4774 Decimal('1')
4775 >>> ExtendedContext.min_mag(Decimal(1), -2)
4776 Decimal('1')
4777 >>> ExtendedContext.min_mag(1, Decimal(-2))
4778 Decimal('1')
4779 """
4780 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004781 return a.min_mag(b, context=self)
4782
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004783 def minus(self, a):
4784 """Minus corresponds to unary prefix minus in Python.
4785
4786 The operation is evaluated using the same rules as subtract; the
4787 operation minus(a) is calculated as subtract('0', a) where the '0'
4788 has the same exponent as the operand.
4789
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004790 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004791 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004792 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004793 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004794 >>> ExtendedContext.minus(1)
4795 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004796 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004797 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004798 return a.__neg__(context=self)
4799
4800 def multiply(self, a, b):
4801 """multiply multiplies two operands.
4802
4803 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004804 Otherwise, the operands are multiplied together
4805 ('long multiplication'), resulting in a number which may be as long as
4806 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004807
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004808 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004809 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004810 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004811 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004812 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004813 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004814 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004815 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004816 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004817 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004818 >>> ExtendedContext.multiply(7, 7)
4819 Decimal('49')
4820 >>> ExtendedContext.multiply(Decimal(7), 7)
4821 Decimal('49')
4822 >>> ExtendedContext.multiply(7, Decimal(7))
4823 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004824 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004825 a = _convert_other(a, raiseit=True)
4826 r = a.__mul__(b, context=self)
4827 if r is NotImplemented:
4828 raise TypeError("Unable to convert %s to Decimal" % b)
4829 else:
4830 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004831
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004832 def next_minus(self, a):
4833 """Returns the largest representable number smaller than a.
4834
4835 >>> c = ExtendedContext.copy()
4836 >>> c.Emin = -999
4837 >>> c.Emax = 999
4838 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004839 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004840 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004841 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004842 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004843 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004844 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004845 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004846 >>> c.next_minus(1)
4847 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004848 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004849 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004850 return a.next_minus(context=self)
4851
4852 def next_plus(self, a):
4853 """Returns the smallest representable number larger than a.
4854
4855 >>> c = ExtendedContext.copy()
4856 >>> c.Emin = -999
4857 >>> c.Emax = 999
4858 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004859 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004860 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004861 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004862 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004863 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004864 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004865 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004866 >>> c.next_plus(1)
4867 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004868 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004869 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004870 return a.next_plus(context=self)
4871
4872 def next_toward(self, a, b):
4873 """Returns the number closest to a, in direction towards b.
4874
4875 The result is the closest representable number from the first
4876 operand (but not the first operand) that is in the direction
4877 towards the second operand, unless the operands have the same
4878 value.
4879
4880 >>> c = ExtendedContext.copy()
4881 >>> c.Emin = -999
4882 >>> c.Emax = 999
4883 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004884 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004885 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004886 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004887 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004888 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004889 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004890 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004891 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004892 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004893 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004894 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004895 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004896 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004897 >>> c.next_toward(0, 1)
4898 Decimal('1E-1007')
4899 >>> c.next_toward(Decimal(0), 1)
4900 Decimal('1E-1007')
4901 >>> c.next_toward(0, Decimal(1))
4902 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004903 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004904 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004905 return a.next_toward(b, context=self)
4906
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004907 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004908 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004909
4910 Essentially a plus operation with all trailing zeros removed from the
4911 result.
4912
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004913 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004914 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004915 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004916 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004917 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004918 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004919 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004920 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004921 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004922 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004923 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004924 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004925 >>> ExtendedContext.normalize(6)
4926 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004927 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004928 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004929 return a.normalize(context=self)
4930
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004931 def number_class(self, a):
4932 """Returns an indication of the class of the operand.
4933
4934 The class is one of the following strings:
4935 -sNaN
4936 -NaN
4937 -Infinity
4938 -Normal
4939 -Subnormal
4940 -Zero
4941 +Zero
4942 +Subnormal
4943 +Normal
4944 +Infinity
4945
4946 >>> c = Context(ExtendedContext)
4947 >>> c.Emin = -999
4948 >>> c.Emax = 999
4949 >>> c.number_class(Decimal('Infinity'))
4950 '+Infinity'
4951 >>> c.number_class(Decimal('1E-10'))
4952 '+Normal'
4953 >>> c.number_class(Decimal('2.50'))
4954 '+Normal'
4955 >>> c.number_class(Decimal('0.1E-999'))
4956 '+Subnormal'
4957 >>> c.number_class(Decimal('0'))
4958 '+Zero'
4959 >>> c.number_class(Decimal('-0'))
4960 '-Zero'
4961 >>> c.number_class(Decimal('-0.1E-999'))
4962 '-Subnormal'
4963 >>> c.number_class(Decimal('-1E-10'))
4964 '-Normal'
4965 >>> c.number_class(Decimal('-2.50'))
4966 '-Normal'
4967 >>> c.number_class(Decimal('-Infinity'))
4968 '-Infinity'
4969 >>> c.number_class(Decimal('NaN'))
4970 'NaN'
4971 >>> c.number_class(Decimal('-NaN'))
4972 'NaN'
4973 >>> c.number_class(Decimal('sNaN'))
4974 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004975 >>> c.number_class(123)
4976 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004977 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004978 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004979 return a.number_class(context=self)
4980
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004981 def plus(self, a):
4982 """Plus corresponds to unary prefix plus in Python.
4983
4984 The operation is evaluated using the same rules as add; the
4985 operation plus(a) is calculated as add('0', a) where the '0'
4986 has the same exponent as the operand.
4987
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004988 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004989 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004990 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004991 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004992 >>> ExtendedContext.plus(-1)
4993 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004994 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004995 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004996 return a.__pos__(context=self)
4997
4998 def power(self, a, b, modulo=None):
4999 """Raises a to the power of b, to modulo if given.
5000
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005001 With two arguments, compute a**b. If a is negative then b
5002 must be integral. The result will be inexact unless b is
5003 integral and the result is finite and can be expressed exactly
5004 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005005
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005006 With three arguments, compute (a**b) % modulo. For the
5007 three argument form, the following restrictions on the
5008 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005009
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005010 - all three arguments must be integral
5011 - b must be nonnegative
5012 - at least one of a or b must be nonzero
5013 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005014
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005015 The result of pow(a, b, modulo) is identical to the result
5016 that would be obtained by computing (a**b) % modulo with
5017 unbounded precision, but is computed more efficiently. It is
5018 always exact.
5019
5020 >>> c = ExtendedContext.copy()
5021 >>> c.Emin = -999
5022 >>> c.Emax = 999
5023 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005024 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005025 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005026 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005027 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005028 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005029 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005030 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005031 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005032 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005033 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005034 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005035 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005036 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005037 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005038 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005039 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005040 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005041 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005042 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005043 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005044 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005045 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005046 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005047 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005048 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005049
5050 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005051 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005052 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005053 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005054 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005055 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005056 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005057 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005058 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005059 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005060 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005061 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005062 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005063 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005064 >>> ExtendedContext.power(7, 7)
5065 Decimal('823543')
5066 >>> ExtendedContext.power(Decimal(7), 7)
5067 Decimal('823543')
5068 >>> ExtendedContext.power(7, Decimal(7), 2)
5069 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005070 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005071 a = _convert_other(a, raiseit=True)
5072 r = a.__pow__(b, modulo, context=self)
5073 if r is NotImplemented:
5074 raise TypeError("Unable to convert %s to Decimal" % b)
5075 else:
5076 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005077
5078 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005079 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005080
5081 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005082 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005083 exponent is being increased), multiplied by a positive power of ten (if
5084 the exponent is being decreased), or is unchanged (if the exponent is
5085 already equal to that of the right-hand operand).
5086
5087 Unlike other operations, if the length of the coefficient after the
5088 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005089 operation condition is raised. This guarantees that, unless there is
5090 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005091 equal to that of the right-hand operand.
5092
5093 Also unlike other operations, quantize will never raise Underflow, even
5094 if the result is subnormal and inexact.
5095
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005096 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005097 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005098 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005099 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005100 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005101 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005102 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005103 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005104 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005105 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005106 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005107 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005108 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005109 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005110 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005111 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005112 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005113 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005114 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005115 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005116 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005117 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005118 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005119 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005120 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005121 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005122 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005123 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005124 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005125 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005126 >>> ExtendedContext.quantize(1, 2)
5127 Decimal('1')
5128 >>> ExtendedContext.quantize(Decimal(1), 2)
5129 Decimal('1')
5130 >>> ExtendedContext.quantize(1, Decimal(2))
5131 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005132 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005133 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005134 return a.quantize(b, context=self)
5135
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005136 def radix(self):
5137 """Just returns 10, as this is Decimal, :)
5138
5139 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005140 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005141 """
5142 return Decimal(10)
5143
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005144 def remainder(self, a, b):
5145 """Returns the remainder from integer division.
5146
5147 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005148 calculating integer division as described for divide-integer, rounded
5149 to precision digits if necessary. The sign of the result, if
5150 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005151
5152 This operation will fail under the same conditions as integer division
5153 (that is, if integer division on the same two operands would fail, the
5154 remainder cannot be calculated).
5155
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005156 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005157 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005158 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005159 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005160 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005161 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005162 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005163 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005164 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005165 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005166 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005167 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005168 >>> ExtendedContext.remainder(22, 6)
5169 Decimal('4')
5170 >>> ExtendedContext.remainder(Decimal(22), 6)
5171 Decimal('4')
5172 >>> ExtendedContext.remainder(22, Decimal(6))
5173 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005174 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005175 a = _convert_other(a, raiseit=True)
5176 r = a.__mod__(b, context=self)
5177 if r is NotImplemented:
5178 raise TypeError("Unable to convert %s to Decimal" % b)
5179 else:
5180 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005181
5182 def remainder_near(self, a, b):
5183 """Returns to be "a - b * n", where n is the integer nearest the exact
5184 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005185 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005186 sign of a.
5187
5188 This operation will fail under the same conditions as integer division
5189 (that is, if integer division on the same two operands would fail, the
5190 remainder cannot be calculated).
5191
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005192 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005193 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005194 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005195 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005196 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005197 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005198 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005199 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005200 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005201 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005202 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005203 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005204 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005205 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005206 >>> ExtendedContext.remainder_near(3, 11)
5207 Decimal('3')
5208 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5209 Decimal('3')
5210 >>> ExtendedContext.remainder_near(3, Decimal(11))
5211 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005212 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005213 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005214 return a.remainder_near(b, context=self)
5215
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005216 def rotate(self, a, b):
5217 """Returns a rotated copy of a, b times.
5218
5219 The coefficient of the result is a rotated copy of the digits in
5220 the coefficient of the first operand. The number of places of
5221 rotation is taken from the absolute value of the second operand,
5222 with the rotation being to the left if the second operand is
5223 positive or to the right otherwise.
5224
5225 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005226 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005227 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005228 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005229 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005230 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005231 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005232 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005233 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005234 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005235 >>> ExtendedContext.rotate(1333333, 1)
5236 Decimal('13333330')
5237 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5238 Decimal('13333330')
5239 >>> ExtendedContext.rotate(1333333, Decimal(1))
5240 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005241 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005242 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005243 return a.rotate(b, context=self)
5244
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005245 def same_quantum(self, a, b):
5246 """Returns True if the two operands have the same exponent.
5247
5248 The result is never affected by either the sign or the coefficient of
5249 either operand.
5250
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005251 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005252 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005253 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005254 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005255 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005256 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005257 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005258 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005259 >>> ExtendedContext.same_quantum(10000, -1)
5260 True
5261 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5262 True
5263 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5264 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005265 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005266 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005267 return a.same_quantum(b)
5268
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005269 def scaleb (self, a, b):
5270 """Returns the first operand after adding the second value its exp.
5271
5272 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005273 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005274 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005275 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005276 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005277 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005278 >>> ExtendedContext.scaleb(1, 4)
5279 Decimal('1E+4')
5280 >>> ExtendedContext.scaleb(Decimal(1), 4)
5281 Decimal('1E+4')
5282 >>> ExtendedContext.scaleb(1, Decimal(4))
5283 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005284 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005285 a = _convert_other(a, raiseit=True)
5286 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005287
5288 def shift(self, a, b):
5289 """Returns a shifted copy of a, b times.
5290
5291 The coefficient of the result is a shifted copy of the digits
5292 in the coefficient of the first operand. The number of places
5293 to shift is taken from the absolute value of the second operand,
5294 with the shift being to the left if the second operand is
5295 positive or to the right otherwise. Digits shifted into the
5296 coefficient are zeros.
5297
5298 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005299 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005300 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005301 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005302 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005303 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005304 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005305 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005306 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005307 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005308 >>> ExtendedContext.shift(88888888, 2)
5309 Decimal('888888800')
5310 >>> ExtendedContext.shift(Decimal(88888888), 2)
5311 Decimal('888888800')
5312 >>> ExtendedContext.shift(88888888, Decimal(2))
5313 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005314 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005315 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005316 return a.shift(b, context=self)
5317
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005318 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005319 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005320
5321 If the result must be inexact, it is rounded using the round-half-even
5322 algorithm.
5323
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005324 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005325 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005326 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005327 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005328 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005329 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005330 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005331 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005332 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005333 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005334 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005335 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005336 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005337 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005338 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005339 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005340 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005341 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005342 >>> ExtendedContext.sqrt(2)
5343 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005344 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005345 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005346 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005347 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005348 return a.sqrt(context=self)
5349
5350 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005351 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005352
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005353 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005354 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005355 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005356 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005357 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005358 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005359 >>> ExtendedContext.subtract(8, 5)
5360 Decimal('3')
5361 >>> ExtendedContext.subtract(Decimal(8), 5)
5362 Decimal('3')
5363 >>> ExtendedContext.subtract(8, Decimal(5))
5364 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005365 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005366 a = _convert_other(a, raiseit=True)
5367 r = a.__sub__(b, context=self)
5368 if r is NotImplemented:
5369 raise TypeError("Unable to convert %s to Decimal" % b)
5370 else:
5371 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005372
5373 def to_eng_string(self, a):
5374 """Converts a number to a string, using scientific notation.
5375
5376 The operation is not affected by the context.
5377 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005378 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005379 return a.to_eng_string(context=self)
5380
5381 def to_sci_string(self, a):
5382 """Converts a number to a string, using scientific notation.
5383
5384 The operation is not affected by the context.
5385 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005386 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005387 return a.__str__(context=self)
5388
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005389 def to_integral_exact(self, a):
5390 """Rounds to an integer.
5391
5392 When the operand has a negative exponent, the result is the same
5393 as using the quantize() operation using the given operand as the
5394 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5395 of the operand as the precision setting; Inexact and Rounded flags
5396 are allowed in this operation. The rounding mode is taken from the
5397 context.
5398
5399 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005400 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005401 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005402 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005403 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005404 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005405 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005406 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005407 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005408 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005409 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005410 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005411 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005412 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005413 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005414 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005415 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005416 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005417 return a.to_integral_exact(context=self)
5418
5419 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005420 """Rounds to an integer.
5421
5422 When the operand has a negative exponent, the result is the same
5423 as using the quantize() operation using the given operand as the
5424 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5425 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005426 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005427
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005428 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005429 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005430 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005431 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005432 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005433 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005434 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005435 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005436 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005437 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005438 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005439 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005440 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005441 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005442 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005443 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005444 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005445 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005446 return a.to_integral_value(context=self)
5447
5448 # the method name changed, but we provide also the old one, for compatibility
5449 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005450
5451class _WorkRep(object):
5452 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005453 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005454 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005455 # exp: None, int, or string
5456
5457 def __init__(self, value=None):
5458 if value is None:
5459 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005460 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005461 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005462 elif isinstance(value, Decimal):
5463 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005464 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005465 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005466 else:
5467 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005468 self.sign = value[0]
5469 self.int = value[1]
5470 self.exp = value[2]
5471
5472 def __repr__(self):
5473 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5474
5475 __str__ = __repr__
5476
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005477
5478
Christian Heimes2c181612007-12-17 20:04:13 +00005479def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005480 """Normalizes op1, op2 to have the same exp and length of coefficient.
5481
5482 Done during addition.
5483 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005484 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005485 tmp = op2
5486 other = op1
5487 else:
5488 tmp = op1
5489 other = op2
5490
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005491 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5492 # Then adding 10**exp to tmp has the same effect (after rounding)
5493 # as adding any positive quantity smaller than 10**exp; similarly
5494 # for subtraction. So if other is smaller than 10**exp we replace
5495 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005496 tmp_len = len(str(tmp.int))
5497 other_len = len(str(other.int))
5498 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5499 if other_len + other.exp - 1 < exp:
5500 other.int = 1
5501 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005502
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005503 tmp.int *= 10 ** (tmp.exp - other.exp)
5504 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005505 return op1, op2
5506
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005507##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005508
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005509# This function from Tim Peters was taken from here:
5510# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5511# The correction being in the function definition is for speed, and
5512# the whole function is not resolved with math.log because of avoiding
5513# the use of floats.
5514def _nbits(n, correction = {
5515 '0': 4, '1': 3, '2': 2, '3': 2,
5516 '4': 1, '5': 1, '6': 1, '7': 1,
5517 '8': 0, '9': 0, 'a': 0, 'b': 0,
5518 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5519 """Number of bits in binary representation of the positive integer n,
5520 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005521 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005522 if n < 0:
5523 raise ValueError("The argument to _nbits should be nonnegative.")
5524 hex_n = "%x" % n
5525 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005526
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005527def _sqrt_nearest(n, a):
5528 """Closest integer to the square root of the positive integer n. a is
5529 an initial approximation to the square root. Any positive integer
5530 will do for a, but the closer a is to the square root of n the
5531 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005532
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005533 """
5534 if n <= 0 or a <= 0:
5535 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5536
5537 b=0
5538 while a != b:
5539 b, a = a, a--n//a>>1
5540 return a
5541
5542def _rshift_nearest(x, shift):
5543 """Given an integer x and a nonnegative integer shift, return closest
5544 integer to x / 2**shift; use round-to-even in case of a tie.
5545
5546 """
5547 b, q = 1 << shift, x >> shift
5548 return q + (2*(x & (b-1)) + (q&1) > b)
5549
5550def _div_nearest(a, b):
5551 """Closest integer to a/b, a and b positive integers; rounds to even
5552 in the case of a tie.
5553
5554 """
5555 q, r = divmod(a, b)
5556 return q + (2*r + (q&1) > b)
5557
5558def _ilog(x, M, L = 8):
5559 """Integer approximation to M*log(x/M), with absolute error boundable
5560 in terms only of x/M.
5561
5562 Given positive integers x and M, return an integer approximation to
5563 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5564 between the approximation and the exact result is at most 22. For
5565 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5566 both cases these are upper bounds on the error; it will usually be
5567 much smaller."""
5568
5569 # The basic algorithm is the following: let log1p be the function
5570 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5571 # the reduction
5572 #
5573 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5574 #
5575 # repeatedly until the argument to log1p is small (< 2**-L in
5576 # absolute value). For small y we can use the Taylor series
5577 # expansion
5578 #
5579 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5580 #
5581 # truncating at T such that y**T is small enough. The whole
5582 # computation is carried out in a form of fixed-point arithmetic,
5583 # with a real number z being represented by an integer
5584 # approximation to z*M. To avoid loss of precision, the y below
5585 # is actually an integer approximation to 2**R*y*M, where R is the
5586 # number of reductions performed so far.
5587
5588 y = x-M
5589 # argument reduction; R = number of reductions performed
5590 R = 0
5591 while (R <= L and abs(y) << L-R >= M or
5592 R > L and abs(y) >> R-L >= M):
5593 y = _div_nearest((M*y) << 1,
5594 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5595 R += 1
5596
5597 # Taylor series with T terms
5598 T = -int(-10*len(str(M))//(3*L))
5599 yshift = _rshift_nearest(y, R)
5600 w = _div_nearest(M, T)
5601 for k in range(T-1, 0, -1):
5602 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5603
5604 return _div_nearest(w*y, M)
5605
5606def _dlog10(c, e, p):
5607 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5608 approximation to 10**p * log10(c*10**e), with an absolute error of
5609 at most 1. Assumes that c*10**e is not exactly 1."""
5610
5611 # increase precision by 2; compensate for this by dividing
5612 # final result by 100
5613 p += 2
5614
5615 # write c*10**e as d*10**f with either:
5616 # f >= 0 and 1 <= d <= 10, or
5617 # f <= 0 and 0.1 <= d <= 1.
5618 # Thus for c*10**e close to 1, f = 0
5619 l = len(str(c))
5620 f = e+l - (e+l >= 1)
5621
5622 if p > 0:
5623 M = 10**p
5624 k = e+p-f
5625 if k >= 0:
5626 c *= 10**k
5627 else:
5628 c = _div_nearest(c, 10**-k)
5629
5630 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005631 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005632 log_d = _div_nearest(log_d*M, log_10)
5633 log_tenpower = f*M # exact
5634 else:
5635 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005636 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005637
5638 return _div_nearest(log_tenpower+log_d, 100)
5639
5640def _dlog(c, e, p):
5641 """Given integers c, e and p with c > 0, compute an integer
5642 approximation to 10**p * log(c*10**e), with an absolute error of
5643 at most 1. Assumes that c*10**e is not exactly 1."""
5644
5645 # Increase precision by 2. The precision increase is compensated
5646 # for at the end with a division by 100.
5647 p += 2
5648
5649 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5650 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5651 # as 10**p * log(d) + 10**p*f * log(10).
5652 l = len(str(c))
5653 f = e+l - (e+l >= 1)
5654
5655 # compute approximation to 10**p*log(d), with error < 27
5656 if p > 0:
5657 k = e+p-f
5658 if k >= 0:
5659 c *= 10**k
5660 else:
5661 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5662
5663 # _ilog magnifies existing error in c by a factor of at most 10
5664 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5665 else:
5666 # p <= 0: just approximate the whole thing by 0; error < 2.31
5667 log_d = 0
5668
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005669 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005670 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005671 extra = len(str(abs(f)))-1
5672 if p + extra >= 0:
5673 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5674 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5675 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005676 else:
5677 f_log_ten = 0
5678 else:
5679 f_log_ten = 0
5680
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005681 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005682 return _div_nearest(f_log_ten + log_d, 100)
5683
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005684class _Log10Memoize(object):
5685 """Class to compute, store, and allow retrieval of, digits of the
5686 constant log(10) = 2.302585.... This constant is needed by
5687 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5688 def __init__(self):
5689 self.digits = "23025850929940456840179914546843642076011014886"
5690
5691 def getdigits(self, p):
5692 """Given an integer p >= 0, return floor(10**p)*log(10).
5693
5694 For example, self.getdigits(3) returns 2302.
5695 """
5696 # digits are stored as a string, for quick conversion to
5697 # integer in the case that we've already computed enough
5698 # digits; the stored digits should always be correct
5699 # (truncated, not rounded to nearest).
5700 if p < 0:
5701 raise ValueError("p should be nonnegative")
5702
5703 if p >= len(self.digits):
5704 # compute p+3, p+6, p+9, ... digits; continue until at
5705 # least one of the extra digits is nonzero
5706 extra = 3
5707 while True:
5708 # compute p+extra digits, correct to within 1ulp
5709 M = 10**(p+extra+2)
5710 digits = str(_div_nearest(_ilog(10*M, M), 100))
5711 if digits[-extra:] != '0'*extra:
5712 break
5713 extra += 3
5714 # keep all reliable digits so far; remove trailing zeros
5715 # and next nonzero digit
5716 self.digits = digits.rstrip('0')[:-1]
5717 return int(self.digits[:p+1])
5718
5719_log10_digits = _Log10Memoize().getdigits
5720
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005721def _iexp(x, M, L=8):
5722 """Given integers x and M, M > 0, such that x/M is small in absolute
5723 value, compute an integer approximation to M*exp(x/M). For 0 <=
5724 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5725 is usually much smaller)."""
5726
5727 # Algorithm: to compute exp(z) for a real number z, first divide z
5728 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5729 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5730 # series
5731 #
5732 # expm1(x) = x + x**2/2! + x**3/3! + ...
5733 #
5734 # Now use the identity
5735 #
5736 # expm1(2x) = expm1(x)*(expm1(x)+2)
5737 #
5738 # R times to compute the sequence expm1(z/2**R),
5739 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5740
5741 # Find R such that x/2**R/M <= 2**-L
5742 R = _nbits((x<<L)//M)
5743
5744 # Taylor series. (2**L)**T > M
5745 T = -int(-10*len(str(M))//(3*L))
5746 y = _div_nearest(x, T)
5747 Mshift = M<<R
5748 for i in range(T-1, 0, -1):
5749 y = _div_nearest(x*(Mshift + y), Mshift * i)
5750
5751 # Expansion
5752 for k in range(R-1, -1, -1):
5753 Mshift = M<<(k+2)
5754 y = _div_nearest(y*(y+Mshift), Mshift)
5755
5756 return M+y
5757
5758def _dexp(c, e, p):
5759 """Compute an approximation to exp(c*10**e), with p decimal places of
5760 precision.
5761
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005762 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005763
5764 10**(p-1) <= d <= 10**p, and
5765 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5766
5767 In other words, d*10**f is an approximation to exp(c*10**e) with p
5768 digits of precision, and with an error in d of at most 1. This is
5769 almost, but not quite, the same as the error being < 1ulp: when d
5770 = 10**(p-1) the error could be up to 10 ulp."""
5771
5772 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5773 p += 2
5774
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005775 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005776 extra = max(0, e + len(str(c)) - 1)
5777 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005778
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005779 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005780 # rounding down
5781 shift = e+q
5782 if shift >= 0:
5783 cshift = c*10**shift
5784 else:
5785 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005786 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005787
5788 # reduce remainder back to original precision
5789 rem = _div_nearest(rem, 10**extra)
5790
5791 # error in result of _iexp < 120; error after division < 0.62
5792 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5793
5794def _dpower(xc, xe, yc, ye, p):
5795 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5796 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5797
5798 10**(p-1) <= c <= 10**p, and
5799 (c-1)*10**e < x**y < (c+1)*10**e
5800
5801 in other words, c*10**e is an approximation to x**y with p digits
5802 of precision, and with an error in c of at most 1. (This is
5803 almost, but not quite, the same as the error being < 1ulp: when c
5804 == 10**(p-1) we can only guarantee error < 10ulp.)
5805
5806 We assume that: x is positive and not equal to 1, and y is nonzero.
5807 """
5808
5809 # Find b such that 10**(b-1) <= |y| <= 10**b
5810 b = len(str(abs(yc))) + ye
5811
5812 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5813 lxc = _dlog(xc, xe, p+b+1)
5814
5815 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5816 shift = ye-b
5817 if shift >= 0:
5818 pc = lxc*yc*10**shift
5819 else:
5820 pc = _div_nearest(lxc*yc, 10**-shift)
5821
5822 if pc == 0:
5823 # we prefer a result that isn't exactly 1; this makes it
5824 # easier to compute a correctly rounded result in __pow__
5825 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5826 coeff, exp = 10**(p-1)+1, 1-p
5827 else:
5828 coeff, exp = 10**p-1, -p
5829 else:
5830 coeff, exp = _dexp(pc, -(p+1), p+1)
5831 coeff = _div_nearest(coeff, 10)
5832 exp += 1
5833
5834 return coeff, exp
5835
5836def _log10_lb(c, correction = {
5837 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5838 '6': 23, '7': 16, '8': 10, '9': 5}):
5839 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5840 if c <= 0:
5841 raise ValueError("The argument to _log10_lb should be nonnegative.")
5842 str_c = str(c)
5843 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005844
Guido van Rossumd8faa362007-04-27 19:54:29 +00005845##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005846
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005847def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005848 """Convert other to Decimal.
5849
5850 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005851 If allow_float is true, allow conversion from float; this
5852 is used in the comparison methods (__eq__ and friends).
5853
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005854 """
5855 if isinstance(other, Decimal):
5856 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005857 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005858 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005859 if allow_float and isinstance(other, float):
5860 return Decimal.from_float(other)
5861
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005862 if raiseit:
5863 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005864 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005865
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005866def _convert_for_comparison(self, other, equality_op=False):
5867 """Given a Decimal instance self and a Python object other, return
Mark Dickinson1c164a62010-06-11 16:49:20 +00005868 a pair (s, o) of Decimal instances such that "s op o" is
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005869 equivalent to "self op other" for any of the 6 comparison
5870 operators "op".
5871
5872 """
5873 if isinstance(other, Decimal):
5874 return self, other
5875
5876 # Comparison with a Rational instance (also includes integers):
5877 # self op n/d <=> self*d op n (for n and d integers, d positive).
5878 # A NaN or infinity can be left unchanged without affecting the
5879 # comparison result.
5880 if isinstance(other, _numbers.Rational):
5881 if not self._is_special:
5882 self = _dec_from_triple(self._sign,
5883 str(int(self._int) * other.denominator),
5884 self._exp)
5885 return self, Decimal(other.numerator)
5886
5887 # Comparisons with float and complex types. == and != comparisons
5888 # with complex numbers should succeed, returning either True or False
5889 # as appropriate. Other comparisons return NotImplemented.
5890 if equality_op and isinstance(other, _numbers.Complex) and other.imag == 0:
5891 other = other.real
5892 if isinstance(other, float):
5893 return self, Decimal.from_float(other)
5894 return NotImplemented, NotImplemented
5895
5896
Guido van Rossumd8faa362007-04-27 19:54:29 +00005897##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005898
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005899# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005900# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005901
5902DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005903 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005904 traps=[DivisionByZero, Overflow, InvalidOperation],
5905 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005906 Emax=999999999,
5907 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005908 capitals=1,
5909 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005910)
5911
5912# Pre-made alternate contexts offered by the specification
5913# Don't change these; the user should be able to select these
5914# contexts and be able to reproduce results from other implementations
5915# of the spec.
5916
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005917BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005918 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005919 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5920 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005921)
5922
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005923ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005924 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005925 traps=[],
5926 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005927)
5928
5929
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005930##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005931#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005932# Regular expression used for parsing numeric strings. Additional
5933# comments:
5934#
5935# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5936# whitespace. But note that the specification disallows whitespace in
5937# a numeric string.
5938#
5939# 2. For finite numbers (not infinities and NaNs) the body of the
5940# number between the optional sign and the optional exponent must have
5941# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005942# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005943
5944import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005945_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005946# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005947 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005948 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005949 (?=\d|\.\d) # ...a number (with at least one digit)
5950 (?P<int>\d*) # having a (possibly empty) integer part
5951 (\.(?P<frac>\d*))? # followed by an optional fractional part
5952 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005953 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005954 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005955 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005956 (?P<signal>s)? # ...an (optionally signaling)
5957 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005958 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005959 )
5960# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005961 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005962""", re.VERBOSE | re.IGNORECASE).match
5963
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005964_all_zeros = re.compile('0*$').match
5965_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005966
5967##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005968# The functions in this section have little to do with the Decimal
5969# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005970# Python numeric classes that want to implement __format__
5971#
5972# A format specifier for Decimal looks like:
5973#
Mark Dickinson79f52032009-03-17 23:12:51 +00005974# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005975
5976_parse_format_specifier_regex = re.compile(r"""\A
5977(?:
5978 (?P<fill>.)?
5979 (?P<align>[<>=^])
5980)?
5981(?P<sign>[-+ ])?
5982(?P<zeropad>0)?
5983(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005984(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005985(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005986(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005987\Z
5988""", re.VERBOSE)
5989
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005990del re
5991
Mark Dickinson79f52032009-03-17 23:12:51 +00005992# The locale module is only needed for the 'n' format specifier. The
5993# rest of the PEP 3101 code functions quite happily without it, so we
5994# don't care too much if locale isn't present.
5995try:
5996 import locale as _locale
5997except ImportError:
5998 pass
5999
6000def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00006001 """Parse and validate a format specifier.
6002
6003 Turns a standard numeric format specifier into a dict, with the
6004 following entries:
6005
6006 fill: fill character to pad field to minimum width
6007 align: alignment type, either '<', '>', '=' or '^'
6008 sign: either '+', '-' or ' '
6009 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006010 zeropad: boolean, indicating whether to pad with zeros
6011 thousands_sep: string to use as thousands separator, or ''
6012 grouping: grouping for thousands separators, in format
6013 used by localeconv
6014 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006015 precision: nonnegative integer giving precision, or None
6016 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006017
6018 """
6019 m = _parse_format_specifier_regex.match(format_spec)
6020 if m is None:
6021 raise ValueError("Invalid format specifier: " + format_spec)
6022
6023 # get the dictionary
6024 format_dict = m.groupdict()
6025
Mark Dickinson79f52032009-03-17 23:12:51 +00006026 # zeropad; defaults for fill and alignment. If zero padding
6027 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006028 fill = format_dict['fill']
6029 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006030 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6031 if format_dict['zeropad']:
6032 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006033 raise ValueError("Fill character conflicts with '0'"
6034 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006035 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006036 raise ValueError("Alignment conflicts with '0' in "
6037 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006038 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006039 # PEP 3101 originally specified that the default alignment should
6040 # be left; it was later agreed that right-aligned makes more sense
6041 # for numeric types. See http://bugs.python.org/issue6857.
6042 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006043
Mark Dickinson79f52032009-03-17 23:12:51 +00006044 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006045 if format_dict['sign'] is None:
6046 format_dict['sign'] = '-'
6047
Christian Heimesf16baeb2008-02-29 14:57:44 +00006048 # minimumwidth defaults to 0; precision remains None if not given
6049 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6050 if format_dict['precision'] is not None:
6051 format_dict['precision'] = int(format_dict['precision'])
6052
6053 # if format type is 'g' or 'G' then a precision of 0 makes little
6054 # sense; convert it to 1. Same if format type is unspecified.
6055 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006056 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006057 format_dict['precision'] = 1
6058
Mark Dickinson79f52032009-03-17 23:12:51 +00006059 # determine thousands separator, grouping, and decimal separator, and
6060 # add appropriate entries to format_dict
6061 if format_dict['type'] == 'n':
6062 # apart from separators, 'n' behaves just like 'g'
6063 format_dict['type'] = 'g'
6064 if _localeconv is None:
6065 _localeconv = _locale.localeconv()
6066 if format_dict['thousands_sep'] is not None:
6067 raise ValueError("Explicit thousands separator conflicts with "
6068 "'n' type in format specifier: " + format_spec)
6069 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6070 format_dict['grouping'] = _localeconv['grouping']
6071 format_dict['decimal_point'] = _localeconv['decimal_point']
6072 else:
6073 if format_dict['thousands_sep'] is None:
6074 format_dict['thousands_sep'] = ''
6075 format_dict['grouping'] = [3, 0]
6076 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006077
6078 return format_dict
6079
Mark Dickinson79f52032009-03-17 23:12:51 +00006080def _format_align(sign, body, spec):
6081 """Given an unpadded, non-aligned numeric string 'body' and sign
6082 string 'sign', add padding and aligment conforming to the given
6083 format specifier dictionary 'spec' (as produced by
6084 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006085
6086 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006087 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006088 minimumwidth = spec['minimumwidth']
6089 fill = spec['fill']
6090 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006091
Mark Dickinson79f52032009-03-17 23:12:51 +00006092 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006093 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006094 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006095 elif align == '>':
6096 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006097 elif align == '=':
6098 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006099 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006100 half = len(padding)//2
6101 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006102 else:
6103 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006104
Christian Heimesf16baeb2008-02-29 14:57:44 +00006105 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006106
Mark Dickinson79f52032009-03-17 23:12:51 +00006107def _group_lengths(grouping):
6108 """Convert a localeconv-style grouping into a (possibly infinite)
6109 iterable of integers representing group lengths.
6110
6111 """
6112 # The result from localeconv()['grouping'], and the input to this
6113 # function, should be a list of integers in one of the
6114 # following three forms:
6115 #
6116 # (1) an empty list, or
6117 # (2) nonempty list of positive integers + [0]
6118 # (3) list of positive integers + [locale.CHAR_MAX], or
6119
6120 from itertools import chain, repeat
6121 if not grouping:
6122 return []
6123 elif grouping[-1] == 0 and len(grouping) >= 2:
6124 return chain(grouping[:-1], repeat(grouping[-2]))
6125 elif grouping[-1] == _locale.CHAR_MAX:
6126 return grouping[:-1]
6127 else:
6128 raise ValueError('unrecognised format for grouping')
6129
6130def _insert_thousands_sep(digits, spec, min_width=1):
6131 """Insert thousands separators into a digit string.
6132
6133 spec is a dictionary whose keys should include 'thousands_sep' and
6134 'grouping'; typically it's the result of parsing the format
6135 specifier using _parse_format_specifier.
6136
6137 The min_width keyword argument gives the minimum length of the
6138 result, which will be padded on the left with zeros if necessary.
6139
6140 If necessary, the zero padding adds an extra '0' on the left to
6141 avoid a leading thousands separator. For example, inserting
6142 commas every three digits in '123456', with min_width=8, gives
6143 '0,123,456', even though that has length 9.
6144
6145 """
6146
6147 sep = spec['thousands_sep']
6148 grouping = spec['grouping']
6149
6150 groups = []
6151 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006152 if l <= 0:
6153 raise ValueError("group length should be positive")
6154 # max(..., 1) forces at least 1 digit to the left of a separator
6155 l = min(max(len(digits), min_width, 1), l)
6156 groups.append('0'*(l - len(digits)) + digits[-l:])
6157 digits = digits[:-l]
6158 min_width -= l
6159 if not digits and min_width <= 0:
6160 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006161 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006162 else:
6163 l = max(len(digits), min_width, 1)
6164 groups.append('0'*(l - len(digits)) + digits[-l:])
6165 return sep.join(reversed(groups))
6166
6167def _format_sign(is_negative, spec):
6168 """Determine sign character."""
6169
6170 if is_negative:
6171 return '-'
6172 elif spec['sign'] in ' +':
6173 return spec['sign']
6174 else:
6175 return ''
6176
6177def _format_number(is_negative, intpart, fracpart, exp, spec):
6178 """Format a number, given the following data:
6179
6180 is_negative: true if the number is negative, else false
6181 intpart: string of digits that must appear before the decimal point
6182 fracpart: string of digits that must come after the point
6183 exp: exponent, as an integer
6184 spec: dictionary resulting from parsing the format specifier
6185
6186 This function uses the information in spec to:
6187 insert separators (decimal separator and thousands separators)
6188 format the sign
6189 format the exponent
6190 add trailing '%' for the '%' type
6191 zero-pad if necessary
6192 fill and align if necessary
6193 """
6194
6195 sign = _format_sign(is_negative, spec)
6196
6197 if fracpart:
6198 fracpart = spec['decimal_point'] + fracpart
6199
6200 if exp != 0 or spec['type'] in 'eE':
6201 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6202 fracpart += "{0}{1:+}".format(echar, exp)
6203 if spec['type'] == '%':
6204 fracpart += '%'
6205
6206 if spec['zeropad']:
6207 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6208 else:
6209 min_width = 0
6210 intpart = _insert_thousands_sep(intpart, spec, min_width)
6211
6212 return _format_align(sign, intpart+fracpart, spec)
6213
6214
Guido van Rossumd8faa362007-04-27 19:54:29 +00006215##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006216
Guido van Rossumd8faa362007-04-27 19:54:29 +00006217# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006218_Infinity = Decimal('Inf')
6219_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006220_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006221_Zero = Decimal(0)
6222_One = Decimal(1)
6223_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006224
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006225# _SignedInfinity[sign] is infinity w/ that sign
6226_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006227
Mark Dickinsondc787d22010-05-23 13:33:13 +00006228# Constants related to the hash implementation; hash(x) is based
6229# on the reduction of x modulo _PyHASH_MODULUS
6230import sys
6231_PyHASH_MODULUS = sys.hash_info.modulus
6232# hash values to use for positive and negative infinities, and nans
6233_PyHASH_INF = sys.hash_info.inf
6234_PyHASH_NAN = sys.hash_info.nan
6235del sys
6236
6237# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6238_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006239
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006240
6241if __name__ == '__main__':
6242 import doctest, sys
6243 doctest.testmod(sys.modules[__name__])