blob: 96d4b3e61a06b1c480d38ef495546f33eab80d0d [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
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Guido van Rossumd8faa362007-04-27 19:54:29 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Christian Heimes68f5fbe2008-02-14 08:27:37 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000059>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000600.333333333
61>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000062>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000630.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000064>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000651
Guido van Rossum7131f842007-02-09 20:13:25 +000066>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000671.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000068>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000071>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000072Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000074>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000075-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000076>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000077NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000078>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000079-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000080>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000081Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000083>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000084Traceback (most recent call last):
85 ...
86 ...
87 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000088decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000089>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000091>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000096>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000099>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
Guido van Rossum7131f842007-02-09 20:13:25 +0000101>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000102Traceback (most recent call last):
103 ...
104 ...
105 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000106decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000107>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000111>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000112NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000113>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Guido van Rossuma13f4a12007-12-10 20:04:04 +0000137import numbers as _numbers
Raymond Hettingereb260842005-06-07 18:52:34 +0000138import copy as _copy
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
168 trap_enabler is set. First argument is self, second is the
169 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)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000220 return NaN
221
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):
Thomas Wouters1b7f8912007-09-19 03:06:30 +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):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000246 return Infsign[sign]
247
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):
Thomas Wouters1b7f8912007-09-19 03:06:30 +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):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268 return NaN
269
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):
294 return NaN
295
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):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 return Infsign[sign]
345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
347 return Infsign[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:
352 return Infsign[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
386# is not available, use threading.currentThread() 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.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000408 if hasattr(threading.currentThread(), '__decimal_context__'):
409 del threading.currentThread().__decimal_context__
410
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()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000416 threading.currentThread().__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:
426 return threading.currentThread().__decimal_context__
427 except AttributeError:
428 context = Context()
429 threading.currentThread().__decimal_context__ = context
430 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
481 """
482 # The string below can't be included in the docstring until Python 2.6
483 # as the doctest module doesn't understand __future__ statements
484 """
485 >>> from __future__ import with_statement
Guido van Rossum7131f842007-02-09 20:13:25 +0000486 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000487 28
488 >>> with localcontext():
489 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000490 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000491 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000492 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000493 30
494 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000495 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000496 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000497 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000498 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000499 28
500 """
501 if ctx is None: ctx = getcontext()
502 return _ContextManager(ctx)
503
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000504
Guido van Rossumd8faa362007-04-27 19:54:29 +0000505##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000506
Christian Heimes08976cb2008-03-16 00:32:36 +0000507class Decimal(_numbers.Real):
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
558 fracpart = m.group('frac')
559 exp = int(m.group('exp') or '0')
560 if fracpart is not None:
561 self._int = (intpart+fracpart).lstrip('0') or '0'
562 self._exp = exp - len(fracpart)
563 else:
564 self._int = intpart.lstrip('0') or '0'
565 self._exp = exp
566 self._is_special = False
567 else:
568 diag = m.group('diag')
569 if diag is not None:
570 # NaN
571 self._int = diag.lstrip('0')
572 if m.group('signal'):
573 self._exp = 'N'
574 else:
575 self._exp = 'n'
576 else:
577 # infinity
578 self._int = '0'
579 self._exp = 'F'
580 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000581 return self
582
583 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000584 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000585 if value >= 0:
586 self._sign = 0
587 else:
588 self._sign = 1
589 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000590 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000591 self._is_special = False
592 return self
593
594 # From another decimal
595 if isinstance(value, Decimal):
596 self._exp = value._exp
597 self._sign = value._sign
598 self._int = value._int
599 self._is_special = value._is_special
600 return self
601
602 # From an internal working value
603 if isinstance(value, _WorkRep):
604 self._sign = value.sign
605 self._int = str(value.int)
606 self._exp = int(value.exp)
607 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000608 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000609
610 # tuple/list conversion (possibly from as_tuple())
611 if isinstance(value, (list,tuple)):
612 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000613 raise ValueError('Invalid tuple size in creation of Decimal '
614 'from list or tuple. The list or tuple '
615 'should have exactly three elements.')
616 # process sign. The isinstance test rejects floats
617 if not (isinstance(value[0], int) and value[0] in (0,1)):
618 raise ValueError("Invalid sign. The first value in the tuple "
619 "should be an integer; either 0 for a "
620 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000622 if value[2] == 'F':
623 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000624 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000625 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000626 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000627 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000628 # process and validate the digits in value[1]
629 digits = []
630 for digit in value[1]:
631 if isinstance(digit, int) and 0 <= digit <= 9:
632 # skip leading zeros
633 if digits or digit != 0:
634 digits.append(digit)
635 else:
636 raise ValueError("The second value in the tuple must "
637 "be composed of integers in the range "
638 "0 through 9.")
639 if value[2] in ('n', 'N'):
640 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000642 self._exp = value[2]
643 self._is_special = True
644 elif isinstance(value[2], int):
645 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000646 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000647 self._exp = value[2]
648 self._is_special = False
649 else:
650 raise ValueError("The third value in the tuple must "
651 "be an integer, or one of the "
652 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000653 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000654
Raymond Hettingerbf440692004-07-10 14:14:37 +0000655 if isinstance(value, float):
656 raise TypeError("Cannot convert float to Decimal. " +
657 "First convert the float to a string")
658
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000659 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000660
661 def _isnan(self):
662 """Returns whether the number is not actually one.
663
664 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000665 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000666 2 if sNaN
667 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000668 if self._is_special:
669 exp = self._exp
670 if exp == 'n':
671 return 1
672 elif exp == 'N':
673 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000674 return 0
675
676 def _isinfinity(self):
677 """Returns whether the number is infinite
678
679 0 if finite or not a number
680 1 if +INF
681 -1 if -INF
682 """
683 if self._exp == 'F':
684 if self._sign:
685 return -1
686 return 1
687 return 0
688
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000689 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000690 """Returns whether the number is not actually one.
691
692 if self, other are sNaN, signal
693 if self, other are NaN return nan
694 return 0
695
696 Done before operations.
697 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000698
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000699 self_is_nan = self._isnan()
700 if other is None:
701 other_is_nan = False
702 else:
703 other_is_nan = other._isnan()
704
705 if self_is_nan or other_is_nan:
706 if context is None:
707 context = getcontext()
708
709 if self_is_nan == 2:
710 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000711 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000712 if other_is_nan == 2:
713 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000714 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000715 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000716 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000717
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000718 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000719 return 0
720
Christian Heimes77c02eb2008-02-09 02:18:51 +0000721 def _compare_check_nans(self, other, context):
722 """Version of _check_nans used for the signaling comparisons
723 compare_signal, __le__, __lt__, __ge__, __gt__.
724
725 Signal InvalidOperation if either self or other is a (quiet
726 or signaling) NaN. Signaling NaNs take precedence over quiet
727 NaNs.
728
729 Return 0 if neither operand is a NaN.
730
731 """
732 if context is None:
733 context = getcontext()
734
735 if self._is_special or other._is_special:
736 if self.is_snan():
737 return context._raise_error(InvalidOperation,
738 'comparison involving sNaN',
739 self)
740 elif other.is_snan():
741 return context._raise_error(InvalidOperation,
742 'comparison involving sNaN',
743 other)
744 elif self.is_qnan():
745 return context._raise_error(InvalidOperation,
746 'comparison involving NaN',
747 self)
748 elif other.is_qnan():
749 return context._raise_error(InvalidOperation,
750 'comparison involving NaN',
751 other)
752 return 0
753
Jack Diederich4dafcc42006-11-28 19:15:13 +0000754 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000755 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000756
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000757 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000759 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000760
Christian Heimes77c02eb2008-02-09 02:18:51 +0000761 def _cmp(self, other):
762 """Compare the two non-NaN decimal instances self and other.
763
764 Returns -1 if self < other, 0 if self == other and 1
765 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000766
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000767 if self._is_special or other._is_special:
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000768 return cmp(self._isinfinity(), other._isinfinity())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000769
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000770 # check for zeros; note that cmp(0, -0) should return 0
771 if not self:
772 if not other:
773 return 0
774 else:
775 return -((-1)**other._sign)
776 if not other:
777 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000778
Guido van Rossumd8faa362007-04-27 19:54:29 +0000779 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000780 if other._sign < self._sign:
781 return -1
782 if self._sign < other._sign:
783 return 1
784
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000785 self_adjusted = self.adjusted()
786 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000787 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000788 self_padded = self._int + '0'*(self._exp - other._exp)
789 other_padded = other._int + '0'*(other._exp - self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000790 return cmp(self_padded, other_padded) * (-1)**self._sign
791 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000792 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000793 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000794 return -((-1)**self._sign)
795
Christian Heimes77c02eb2008-02-09 02:18:51 +0000796 # Note: The Decimal standard doesn't cover rich comparisons for
797 # Decimals. In particular, the specification is silent on the
798 # subject of what should happen for a comparison involving a NaN.
799 # We take the following approach:
800 #
801 # == comparisons involving a NaN always return False
802 # != comparisons involving a NaN always return True
803 # <, >, <= and >= comparisons involving a (quiet or signaling)
804 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000805 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000806 #
807 # This behavior is designed to conform as closely as possible to
808 # that specified by IEEE 754.
809
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000810 def __eq__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000811 other = _convert_other(other)
812 if other is NotImplemented:
813 return other
814 if self.is_nan() or other.is_nan():
815 return False
816 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000817
818 def __ne__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000819 other = _convert_other(other)
820 if other is NotImplemented:
821 return other
822 if self.is_nan() or other.is_nan():
823 return True
824 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000825
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000826
Christian Heimes77c02eb2008-02-09 02:18:51 +0000827 def __lt__(self, other, context=None):
828 other = _convert_other(other)
829 if other is NotImplemented:
830 return other
831 ans = self._compare_check_nans(other, context)
832 if ans:
833 return False
834 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000835
Christian Heimes77c02eb2008-02-09 02:18:51 +0000836 def __le__(self, other, context=None):
837 other = _convert_other(other)
838 if other is NotImplemented:
839 return other
840 ans = self._compare_check_nans(other, context)
841 if ans:
842 return False
843 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000844
Christian Heimes77c02eb2008-02-09 02:18:51 +0000845 def __gt__(self, other, context=None):
846 other = _convert_other(other)
847 if other is NotImplemented:
848 return other
849 ans = self._compare_check_nans(other, context)
850 if ans:
851 return False
852 return self._cmp(other) > 0
853
854 def __ge__(self, other, context=None):
855 other = _convert_other(other)
856 if other is NotImplemented:
857 return other
858 ans = self._compare_check_nans(other, context)
859 if ans:
860 return False
861 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000862
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000863 def compare(self, other, context=None):
864 """Compares one to another.
865
866 -1 => a < b
867 0 => a = b
868 1 => a > b
869 NaN => one is NaN
870 Like __cmp__, but returns Decimal instances.
871 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000872 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000873
Guido van Rossumd8faa362007-04-27 19:54:29 +0000874 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000875 if (self._is_special or other and other._is_special):
876 ans = self._check_nans(other, context)
877 if ans:
878 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000879
Christian Heimes77c02eb2008-02-09 02:18:51 +0000880 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000881
882 def __hash__(self):
883 """x.__hash__() <==> hash(x)"""
884 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000885 #
886 # The hash of a nonspecial noninteger Decimal must depend only
887 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000888 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000889 if self._is_special:
890 if self._isnan():
891 raise TypeError('Cannot hash a NaN value.')
892 return hash(str(self))
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000893 if not self:
894 return 0
895 if self._isinteger():
896 op = _WorkRep(self.to_integral_value())
897 # to make computation feasible for Decimals with large
898 # exponent, we use the fact that hash(n) == hash(m) for
899 # any two nonzero integers n and m such that (i) n and m
900 # have the same sign, and (ii) n is congruent to m modulo
901 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
902 # hash((-1)**s*c*pow(10, e, 2**64-1).
903 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000904 # The value of a nonzero nonspecial Decimal instance is
905 # faithfully represented by the triple consisting of its sign,
906 # its adjusted exponent, and its coefficient with trailing
907 # zeros removed.
908 return hash((self._sign,
909 self._exp+len(self._int),
910 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000911
912 def as_tuple(self):
913 """Represents the number as a triple tuple.
914
915 To show the internals exactly as they are.
916 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000917 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000918
919 def __repr__(self):
920 """Represents the number as an instance of Decimal."""
921 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000922 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000923
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000924 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000925 """Return string representation of the number in scientific notation.
926
927 Captures all of the information in the underlying representation.
928 """
929
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000930 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000931 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000932 if self._exp == 'F':
933 return sign + 'Infinity'
934 elif self._exp == 'n':
935 return sign + 'NaN' + self._int
936 else: # self._exp == 'N'
937 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000938
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000939 # number of digits of self._int to left of decimal point
940 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000942 # dotplace is number of digits of self._int to the left of the
943 # decimal point in the mantissa of the output string (that is,
944 # after adjusting the exponent)
945 if self._exp <= 0 and leftdigits > -6:
946 # no exponent required
947 dotplace = leftdigits
948 elif not eng:
949 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000950 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000951 elif self._int == '0':
952 # engineering notation, zero
953 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000954 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000955 # engineering notation, nonzero
956 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000957
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000958 if dotplace <= 0:
959 intpart = '0'
960 fracpart = '.' + '0'*(-dotplace) + self._int
961 elif dotplace >= len(self._int):
962 intpart = self._int+'0'*(dotplace-len(self._int))
963 fracpart = ''
964 else:
965 intpart = self._int[:dotplace]
966 fracpart = '.' + self._int[dotplace:]
967 if leftdigits == dotplace:
968 exp = ''
969 else:
970 if context is None:
971 context = getcontext()
972 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
973
974 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000975
976 def to_eng_string(self, context=None):
977 """Convert to engineering-type string.
978
979 Engineering notation has an exponent which is a multiple of 3, so there
980 are up to 3 digits left of the decimal place.
981
982 Same rules for when in exponential and when as a value as in __str__.
983 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000984 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000985
986 def __neg__(self, context=None):
987 """Returns a copy with the sign switched.
988
989 Rounds, if it has reason.
990 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000991 if self._is_special:
992 ans = self._check_nans(context=context)
993 if ans:
994 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000995
996 if not self:
997 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000998 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000999 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001000 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001001
1002 if context is None:
1003 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001004 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001005
1006 def __pos__(self, context=None):
1007 """Returns a copy, unless it is a sNaN.
1008
1009 Rounds the number (if more then precision digits)
1010 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001011 if self._is_special:
1012 ans = self._check_nans(context=context)
1013 if ans:
1014 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001015
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001016 if not self:
1017 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001018 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001019 else:
1020 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001021
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001022 if context is None:
1023 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001024 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025
Christian Heimes2c181612007-12-17 20:04:13 +00001026 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001027 """Returns the absolute value of self.
1028
Christian Heimes2c181612007-12-17 20:04:13 +00001029 If the keyword argument 'round' is false, do not round. The
1030 expression self.__abs__(round=False) is equivalent to
1031 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032 """
Christian Heimes2c181612007-12-17 20:04:13 +00001033 if not round:
1034 return self.copy_abs()
1035
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001036 if self._is_special:
1037 ans = self._check_nans(context=context)
1038 if ans:
1039 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001040
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001041 if self._sign:
1042 ans = self.__neg__(context=context)
1043 else:
1044 ans = self.__pos__(context=context)
1045
1046 return ans
1047
1048 def __add__(self, other, context=None):
1049 """Returns self + other.
1050
1051 -INF + INF (or the reverse) cause InvalidOperation errors.
1052 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001053 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001054 if other is NotImplemented:
1055 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001056
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001057 if context is None:
1058 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001059
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001060 if self._is_special or other._is_special:
1061 ans = self._check_nans(other, context)
1062 if ans:
1063 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001064
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001065 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001066 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001067 if self._sign != other._sign and other._isinfinity():
1068 return context._raise_error(InvalidOperation, '-INF + INF')
1069 return Decimal(self)
1070 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001071 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001072
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001073 exp = min(self._exp, other._exp)
1074 negativezero = 0
1075 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001076 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001077 negativezero = 1
1078
1079 if not self and not other:
1080 sign = min(self._sign, other._sign)
1081 if negativezero:
1082 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001083 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001084 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001085 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001086 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001087 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001088 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001089 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090 return ans
1091 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001092 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001093 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001094 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001095 return ans
1096
1097 op1 = _WorkRep(self)
1098 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001099 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001100
1101 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001102 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001104 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001105 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001106 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001107 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001108 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001109 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001110 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001111 if op1.sign == 1:
1112 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001113 op1.sign, op2.sign = op2.sign, op1.sign
1114 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001115 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001116 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001117 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001118 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001119 op1.sign, op2.sign = (0, 0)
1120 else:
1121 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001122 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001123
Raymond Hettinger17931de2004-10-27 06:21:46 +00001124 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001125 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001127 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001128
1129 result.exp = op1.exp
1130 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001131 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001132 return ans
1133
1134 __radd__ = __add__
1135
1136 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001137 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001138 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001139 if other is NotImplemented:
1140 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001142 if self._is_special or other._is_special:
1143 ans = self._check_nans(other, context=context)
1144 if ans:
1145 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001146
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001147 # self - other is computed as self + other.copy_negate()
1148 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
1150 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001151 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001152 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001153 if other is NotImplemented:
1154 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001156 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001157
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158 def __mul__(self, other, context=None):
1159 """Return self * other.
1160
1161 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1162 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001163 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001164 if other is NotImplemented:
1165 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001166
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001167 if context is None:
1168 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001169
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001170 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001171
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001172 if self._is_special or other._is_special:
1173 ans = self._check_nans(other, context)
1174 if ans:
1175 return ans
1176
1177 if self._isinfinity():
1178 if not other:
1179 return context._raise_error(InvalidOperation, '(+-)INF * 0')
1180 return Infsign[resultsign]
1181
1182 if other._isinfinity():
1183 if not self:
1184 return context._raise_error(InvalidOperation, '0 * (+-)INF')
1185 return Infsign[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001186
1187 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188
1189 # Special case for multiplying by zero
1190 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001191 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001192 # Fixing in case the exponent is out of bounds
1193 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001194 return ans
1195
1196 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001197 if self._int == '1':
1198 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001199 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001200 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001201 if other._int == '1':
1202 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001203 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204 return ans
1205
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001206 op1 = _WorkRep(self)
1207 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001208
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001209 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001210 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001211
1212 return ans
1213 __rmul__ = __mul__
1214
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001215 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001217 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001218 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001219 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221 if context is None:
1222 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001223
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001224 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001225
1226 if self._is_special or other._is_special:
1227 ans = self._check_nans(other, context)
1228 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001229 return ans
1230
1231 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001232 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001234 if self._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001235 return Infsign[sign]
1236
1237 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001238 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001239 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001240
1241 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001242 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001243 if not self:
1244 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001245 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001246
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001247 if not self:
1248 exp = self._exp - other._exp
1249 coeff = 0
1250 else:
1251 # OK, so neither = 0, INF or NaN
1252 shift = len(other._int) - len(self._int) + context.prec + 1
1253 exp = self._exp - other._exp - shift
1254 op1 = _WorkRep(self)
1255 op2 = _WorkRep(other)
1256 if shift >= 0:
1257 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1258 else:
1259 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1260 if remainder:
1261 # result is not exact; adjust to ensure correct rounding
1262 if coeff % 5 == 0:
1263 coeff += 1
1264 else:
1265 # result is exact; get as close to ideal exponent as possible
1266 ideal_exp = self._exp - other._exp
1267 while exp < ideal_exp and coeff % 10 == 0:
1268 coeff //= 10
1269 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001271 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001272 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001274 def _divide(self, other, context):
1275 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001277 Assumes that neither self nor other is a NaN, that self is not
1278 infinite and that other is nonzero.
1279 """
1280 sign = self._sign ^ other._sign
1281 if other._isinfinity():
1282 ideal_exp = self._exp
1283 else:
1284 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001285
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001286 expdiff = self.adjusted() - other.adjusted()
1287 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001288 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001289 self._rescale(ideal_exp, context.rounding))
1290 if expdiff <= context.prec:
1291 op1 = _WorkRep(self)
1292 op2 = _WorkRep(other)
1293 if op1.exp >= op2.exp:
1294 op1.int *= 10**(op1.exp - op2.exp)
1295 else:
1296 op2.int *= 10**(op2.exp - op1.exp)
1297 q, r = divmod(op1.int, op2.int)
1298 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001299 return (_dec_from_triple(sign, str(q), 0),
1300 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001301
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001302 # Here the quotient is too large to be representable
1303 ans = context._raise_error(DivisionImpossible,
1304 'quotient too large in //, % or divmod')
1305 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001306
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001307 def __rtruediv__(self, other, context=None):
1308 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001309 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001310 if other is NotImplemented:
1311 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001312 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001313
1314 def __divmod__(self, other, context=None):
1315 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001316 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001317 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001318 other = _convert_other(other)
1319 if other is NotImplemented:
1320 return other
1321
1322 if context is None:
1323 context = getcontext()
1324
1325 ans = self._check_nans(other, context)
1326 if ans:
1327 return (ans, ans)
1328
1329 sign = self._sign ^ other._sign
1330 if self._isinfinity():
1331 if other._isinfinity():
1332 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1333 return ans, ans
1334 else:
1335 return (Infsign[sign],
1336 context._raise_error(InvalidOperation, 'INF % x'))
1337
1338 if not other:
1339 if not self:
1340 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1341 return ans, ans
1342 else:
1343 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1344 context._raise_error(InvalidOperation, 'x % 0'))
1345
1346 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001347 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001348 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001349
1350 def __rdivmod__(self, other, context=None):
1351 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001352 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001353 if other is NotImplemented:
1354 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355 return other.__divmod__(self, context=context)
1356
1357 def __mod__(self, other, context=None):
1358 """
1359 self % other
1360 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001361 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001362 if other is NotImplemented:
1363 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001364
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 if context is None:
1366 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001367
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001368 ans = self._check_nans(other, context)
1369 if ans:
1370 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001371
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001372 if self._isinfinity():
1373 return context._raise_error(InvalidOperation, 'INF % x')
1374 elif not other:
1375 if self:
1376 return context._raise_error(InvalidOperation, 'x % 0')
1377 else:
1378 return context._raise_error(DivisionUndefined, '0 % 0')
1379
1380 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001381 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001382 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001383
1384 def __rmod__(self, other, context=None):
1385 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001386 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001387 if other is NotImplemented:
1388 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001389 return other.__mod__(self, context=context)
1390
1391 def remainder_near(self, other, context=None):
1392 """
1393 Remainder nearest to 0- abs(remainder-near) <= other/2
1394 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001395 if context is None:
1396 context = getcontext()
1397
1398 other = _convert_other(other, raiseit=True)
1399
1400 ans = self._check_nans(other, context)
1401 if ans:
1402 return ans
1403
1404 # self == +/-infinity -> InvalidOperation
1405 if self._isinfinity():
1406 return context._raise_error(InvalidOperation,
1407 'remainder_near(infinity, x)')
1408
1409 # other == 0 -> either InvalidOperation or DivisionUndefined
1410 if not other:
1411 if self:
1412 return context._raise_error(InvalidOperation,
1413 'remainder_near(x, 0)')
1414 else:
1415 return context._raise_error(DivisionUndefined,
1416 'remainder_near(0, 0)')
1417
1418 # other = +/-infinity -> remainder = self
1419 if other._isinfinity():
1420 ans = Decimal(self)
1421 return ans._fix(context)
1422
1423 # self = 0 -> remainder = self, with ideal exponent
1424 ideal_exponent = min(self._exp, other._exp)
1425 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001426 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001427 return ans._fix(context)
1428
1429 # catch most cases of large or small quotient
1430 expdiff = self.adjusted() - other.adjusted()
1431 if expdiff >= context.prec + 1:
1432 # expdiff >= prec+1 => abs(self/other) > 10**prec
1433 return context._raise_error(DivisionImpossible)
1434 if expdiff <= -2:
1435 # expdiff <= -2 => abs(self/other) < 0.1
1436 ans = self._rescale(ideal_exponent, context.rounding)
1437 return ans._fix(context)
1438
1439 # adjust both arguments to have the same exponent, then divide
1440 op1 = _WorkRep(self)
1441 op2 = _WorkRep(other)
1442 if op1.exp >= op2.exp:
1443 op1.int *= 10**(op1.exp - op2.exp)
1444 else:
1445 op2.int *= 10**(op2.exp - op1.exp)
1446 q, r = divmod(op1.int, op2.int)
1447 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1448 # 10**ideal_exponent. Apply correction to ensure that
1449 # abs(remainder) <= abs(other)/2
1450 if 2*r + (q&1) > op2.int:
1451 r -= op2.int
1452 q += 1
1453
1454 if q >= 10**context.prec:
1455 return context._raise_error(DivisionImpossible)
1456
1457 # result has same sign as self unless r is negative
1458 sign = self._sign
1459 if r < 0:
1460 sign = 1-sign
1461 r = -r
1462
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001463 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001464 return ans._fix(context)
1465
1466 def __floordiv__(self, other, context=None):
1467 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001468 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001469 if other is NotImplemented:
1470 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001471
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001472 if context is None:
1473 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001474
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001475 ans = self._check_nans(other, context)
1476 if ans:
1477 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001478
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001479 if self._isinfinity():
1480 if other._isinfinity():
1481 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001482 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001483 return Infsign[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001484
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001485 if not other:
1486 if self:
1487 return context._raise_error(DivisionByZero, 'x // 0',
1488 self._sign ^ other._sign)
1489 else:
1490 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001491
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001492 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001493
1494 def __rfloordiv__(self, other, context=None):
1495 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001496 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001497 if other is NotImplemented:
1498 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001499 return other.__floordiv__(self, context=context)
1500
1501 def __float__(self):
1502 """Float representation."""
1503 return float(str(self))
1504
1505 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001506 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001507 if self._is_special:
1508 if self._isnan():
1509 context = getcontext()
1510 return context._raise_error(InvalidContext)
1511 elif self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001512 raise OverflowError("Cannot convert infinity to int")
1513 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001514 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001515 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001516 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001517 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001518
Christian Heimes969fe572008-01-25 11:23:10 +00001519 __trunc__ = __int__
1520
Christian Heimes0bd4e112008-02-12 22:59:25 +00001521 @property
1522 def real(self):
1523 return self
1524
1525 @property
1526 def imag(self):
1527 return Decimal(0)
1528
1529 def conjugate(self):
1530 return self
1531
1532 def __complex__(self):
1533 return complex(float(self))
1534
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001535 def _fix_nan(self, context):
1536 """Decapitate the payload of a NaN to fit the context"""
1537 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001539 # maximum length of payload is precision if _clamp=0,
1540 # precision-1 if _clamp=1.
1541 max_payload_len = context.prec - context._clamp
1542 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001543 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1544 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001545 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001547 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001548 """Round if it is necessary to keep self within prec precision.
1549
1550 Rounds and fixes the exponent. Does not raise on a sNaN.
1551
1552 Arguments:
1553 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001554 context - context used.
1555 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001556
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001558 if self._isnan():
1559 # decapitate payload if necessary
1560 return self._fix_nan(context)
1561 else:
1562 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001563 return Decimal(self)
1564
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001565 # if self is zero then exponent should be between Etiny and
1566 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1567 Etiny = context.Etiny()
1568 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001569 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001570 exp_max = [context.Emax, Etop][context._clamp]
1571 new_exp = min(max(self._exp, Etiny), exp_max)
1572 if new_exp != self._exp:
1573 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001574 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001575 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001576 return Decimal(self)
1577
1578 # exp_min is the smallest allowable exponent of the result,
1579 # equal to max(self.adjusted()-context.prec+1, Etiny)
1580 exp_min = len(self._int) + self._exp - context.prec
1581 if exp_min > Etop:
1582 # overflow: exp_min > Etop iff self.adjusted() > Emax
1583 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001584 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001585 return context._raise_error(Overflow, 'above Emax', self._sign)
1586 self_is_subnormal = exp_min < Etiny
1587 if self_is_subnormal:
1588 context._raise_error(Subnormal)
1589 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001590
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 # round if self has too many digits
1592 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001593 context._raise_error(Rounded)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001594 digits = len(self._int) + self._exp - exp_min
1595 if digits < 0:
1596 self = _dec_from_triple(self._sign, '1', exp_min-1)
1597 digits = 0
1598 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1599 changed = this_function(digits)
1600 coeff = self._int[:digits] or '0'
1601 if changed == 1:
1602 coeff = str(int(coeff)+1)
1603 ans = _dec_from_triple(self._sign, coeff, exp_min)
1604
1605 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001606 context._raise_error(Inexact)
1607 if self_is_subnormal:
1608 context._raise_error(Underflow)
1609 if not ans:
1610 # raise Clamped on underflow to 0
1611 context._raise_error(Clamped)
1612 elif len(ans._int) == context.prec+1:
1613 # we get here only if rescaling rounds the
1614 # cofficient up to exactly 10**context.prec
1615 if ans._exp < Etop:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001616 ans = _dec_from_triple(ans._sign,
1617 ans._int[:-1], ans._exp+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001618 else:
1619 # Inexact and Rounded have already been raised
1620 ans = context._raise_error(Overflow, 'above Emax',
1621 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001622 return ans
1623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001624 # fold down if _clamp == 1 and self has too few digits
1625 if context._clamp == 1 and self._exp > Etop:
1626 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001627 self_padded = self._int + '0'*(self._exp - Etop)
1628 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001629
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001630 # here self was representable to begin with; return unchanged
1631 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001632
1633 _pick_rounding_function = {}
1634
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001635 # for each of the rounding functions below:
1636 # self is a finite, nonzero Decimal
1637 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001638 #
1639 # each function returns either -1, 0, or 1, as follows:
1640 # 1 indicates that self should be rounded up (away from zero)
1641 # 0 indicates that self should be truncated, and that all the
1642 # digits to be truncated are zeros (so the value is unchanged)
1643 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001644
1645 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001646 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001647 if _all_zeros(self._int, prec):
1648 return 0
1649 else:
1650 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001651
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001652 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001653 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001654 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001655
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001656 def _round_half_up(self, prec):
1657 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001658 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001659 return 1
1660 elif _all_zeros(self._int, prec):
1661 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001662 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001663 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001664
1665 def _round_half_down(self, prec):
1666 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001667 if _exact_half(self._int, prec):
1668 return -1
1669 else:
1670 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001671
1672 def _round_half_even(self, prec):
1673 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001674 if _exact_half(self._int, prec) and \
1675 (prec == 0 or self._int[prec-1] in '02468'):
1676 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001677 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001678 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001679
1680 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001681 """Rounds up (not away from 0 if negative.)"""
1682 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001683 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001685 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001686
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001687 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001688 """Rounds down (not towards 0 if negative)"""
1689 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001691 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001692 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001693
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001694 def _round_05up(self, prec):
1695 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001696 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001697 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001698 else:
1699 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001701 def fma(self, other, third, context=None):
1702 """Fused multiply-add.
1703
1704 Returns self*other+third with no rounding of the intermediate
1705 product self*other.
1706
1707 self and other are multiplied together, with no rounding of
1708 the result. The third operand is then added to the result,
1709 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001711
1712 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001713
1714 # compute product; raise InvalidOperation if either operand is
1715 # a signaling NaN or if the product is zero times infinity.
1716 if self._is_special or other._is_special:
1717 if context is None:
1718 context = getcontext()
1719 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001720 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001721 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001722 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001723 if self._exp == 'n':
1724 product = self
1725 elif other._exp == 'n':
1726 product = other
1727 elif self._exp == 'F':
1728 if not other:
1729 return context._raise_error(InvalidOperation,
1730 'INF * 0 in fma')
1731 product = Infsign[self._sign ^ other._sign]
1732 elif other._exp == 'F':
1733 if not self:
1734 return context._raise_error(InvalidOperation,
1735 '0 * INF in fma')
1736 product = Infsign[self._sign ^ other._sign]
1737 else:
1738 product = _dec_from_triple(self._sign ^ other._sign,
1739 str(int(self._int) * int(other._int)),
1740 self._exp + other._exp)
1741
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001742 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001743 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001744
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001745 def _power_modulo(self, other, modulo, context=None):
1746 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001747
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001748 # if can't convert other and modulo to Decimal, raise
1749 # TypeError; there's no point returning NotImplemented (no
1750 # equivalent of __rpow__ for three argument pow)
1751 other = _convert_other(other, raiseit=True)
1752 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001753
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001754 if context is None:
1755 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001756
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001757 # deal with NaNs: if there are any sNaNs then first one wins,
1758 # (i.e. behaviour for NaNs is identical to that of fma)
1759 self_is_nan = self._isnan()
1760 other_is_nan = other._isnan()
1761 modulo_is_nan = modulo._isnan()
1762 if self_is_nan or other_is_nan or modulo_is_nan:
1763 if self_is_nan == 2:
1764 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001765 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001766 if other_is_nan == 2:
1767 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001768 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001769 if modulo_is_nan == 2:
1770 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001771 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001772 if self_is_nan:
1773 return self._fix_nan(context)
1774 if other_is_nan:
1775 return other._fix_nan(context)
1776 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001777
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001778 # check inputs: we apply same restrictions as Python's pow()
1779 if not (self._isinteger() and
1780 other._isinteger() and
1781 modulo._isinteger()):
1782 return context._raise_error(InvalidOperation,
1783 'pow() 3rd argument not allowed '
1784 'unless all arguments are integers')
1785 if other < 0:
1786 return context._raise_error(InvalidOperation,
1787 'pow() 2nd argument cannot be '
1788 'negative when 3rd argument specified')
1789 if not modulo:
1790 return context._raise_error(InvalidOperation,
1791 'pow() 3rd argument cannot be 0')
1792
1793 # additional restriction for decimal: the modulus must be less
1794 # than 10**prec in absolute value
1795 if modulo.adjusted() >= context.prec:
1796 return context._raise_error(InvalidOperation,
1797 'insufficient precision: pow() 3rd '
1798 'argument must not have more than '
1799 'precision digits')
1800
1801 # define 0**0 == NaN, for consistency with two-argument pow
1802 # (even though it hurts!)
1803 if not other and not self:
1804 return context._raise_error(InvalidOperation,
1805 'at least one of pow() 1st argument '
1806 'and 2nd argument must be nonzero ;'
1807 '0**0 is not defined')
1808
1809 # compute sign of result
1810 if other._iseven():
1811 sign = 0
1812 else:
1813 sign = self._sign
1814
1815 # convert modulo to a Python integer, and self and other to
1816 # Decimal integers (i.e. force their exponents to be >= 0)
1817 modulo = abs(int(modulo))
1818 base = _WorkRep(self.to_integral_value())
1819 exponent = _WorkRep(other.to_integral_value())
1820
1821 # compute result using integer pow()
1822 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1823 for i in range(exponent.exp):
1824 base = pow(base, 10, modulo)
1825 base = pow(base, exponent.int, modulo)
1826
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001827 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001828
1829 def _power_exact(self, other, p):
1830 """Attempt to compute self**other exactly.
1831
1832 Given Decimals self and other and an integer p, attempt to
1833 compute an exact result for the power self**other, with p
1834 digits of precision. Return None if self**other is not
1835 exactly representable in p digits.
1836
1837 Assumes that elimination of special cases has already been
1838 performed: self and other must both be nonspecial; self must
1839 be positive and not numerically equal to 1; other must be
1840 nonzero. For efficiency, other._exp should not be too large,
1841 so that 10**abs(other._exp) is a feasible calculation."""
1842
1843 # In the comments below, we write x for the value of self and
1844 # y for the value of other. Write x = xc*10**xe and y =
1845 # yc*10**ye.
1846
1847 # The main purpose of this method is to identify the *failure*
1848 # of x**y to be exactly representable with as little effort as
1849 # possible. So we look for cheap and easy tests that
1850 # eliminate the possibility of x**y being exact. Only if all
1851 # these tests are passed do we go on to actually compute x**y.
1852
1853 # Here's the main idea. First normalize both x and y. We
1854 # express y as a rational m/n, with m and n relatively prime
1855 # and n>0. Then for x**y to be exactly representable (at
1856 # *any* precision), xc must be the nth power of a positive
1857 # integer and xe must be divisible by n. If m is negative
1858 # then additionally xc must be a power of either 2 or 5, hence
1859 # a power of 2**n or 5**n.
1860 #
1861 # There's a limit to how small |y| can be: if y=m/n as above
1862 # then:
1863 #
1864 # (1) if xc != 1 then for the result to be representable we
1865 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1866 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1867 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1868 # representable.
1869 #
1870 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1871 # |y| < 1/|xe| then the result is not representable.
1872 #
1873 # Note that since x is not equal to 1, at least one of (1) and
1874 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1875 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1876 #
1877 # There's also a limit to how large y can be, at least if it's
1878 # positive: the normalized result will have coefficient xc**y,
1879 # so if it's representable then xc**y < 10**p, and y <
1880 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1881 # not exactly representable.
1882
1883 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1884 # so |y| < 1/xe and the result is not representable.
1885 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1886 # < 1/nbits(xc).
1887
1888 x = _WorkRep(self)
1889 xc, xe = x.int, x.exp
1890 while xc % 10 == 0:
1891 xc //= 10
1892 xe += 1
1893
1894 y = _WorkRep(other)
1895 yc, ye = y.int, y.exp
1896 while yc % 10 == 0:
1897 yc //= 10
1898 ye += 1
1899
1900 # case where xc == 1: result is 10**(xe*y), with xe*y
1901 # required to be an integer
1902 if xc == 1:
1903 if ye >= 0:
1904 exponent = xe*yc*10**ye
1905 else:
1906 exponent, remainder = divmod(xe*yc, 10**-ye)
1907 if remainder:
1908 return None
1909 if y.sign == 1:
1910 exponent = -exponent
1911 # if other is a nonnegative integer, use ideal exponent
1912 if other._isinteger() and other._sign == 0:
1913 ideal_exponent = self._exp*int(other)
1914 zeros = min(exponent-ideal_exponent, p-1)
1915 else:
1916 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001917 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918
1919 # case where y is negative: xc must be either a power
1920 # of 2 or a power of 5.
1921 if y.sign == 1:
1922 last_digit = xc % 10
1923 if last_digit in (2,4,6,8):
1924 # quick test for power of 2
1925 if xc & -xc != xc:
1926 return None
1927 # now xc is a power of 2; e is its exponent
1928 e = _nbits(xc)-1
1929 # find e*y and xe*y; both must be integers
1930 if ye >= 0:
1931 y_as_int = yc*10**ye
1932 e = e*y_as_int
1933 xe = xe*y_as_int
1934 else:
1935 ten_pow = 10**-ye
1936 e, remainder = divmod(e*yc, ten_pow)
1937 if remainder:
1938 return None
1939 xe, remainder = divmod(xe*yc, ten_pow)
1940 if remainder:
1941 return None
1942
1943 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1944 return None
1945 xc = 5**e
1946
1947 elif last_digit == 5:
1948 # e >= log_5(xc) if xc is a power of 5; we have
1949 # equality all the way up to xc=5**2658
1950 e = _nbits(xc)*28//65
1951 xc, remainder = divmod(5**e, xc)
1952 if remainder:
1953 return None
1954 while xc % 5 == 0:
1955 xc //= 5
1956 e -= 1
1957 if ye >= 0:
1958 y_as_integer = yc*10**ye
1959 e = e*y_as_integer
1960 xe = xe*y_as_integer
1961 else:
1962 ten_pow = 10**-ye
1963 e, remainder = divmod(e*yc, ten_pow)
1964 if remainder:
1965 return None
1966 xe, remainder = divmod(xe*yc, ten_pow)
1967 if remainder:
1968 return None
1969 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1970 return None
1971 xc = 2**e
1972 else:
1973 return None
1974
1975 if xc >= 10**p:
1976 return None
1977 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001978 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001979
1980 # now y is positive; find m and n such that y = m/n
1981 if ye >= 0:
1982 m, n = yc*10**ye, 1
1983 else:
1984 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
1985 return None
1986 xc_bits = _nbits(xc)
1987 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
1988 return None
1989 m, n = yc, 10**(-ye)
1990 while m % 2 == n % 2 == 0:
1991 m //= 2
1992 n //= 2
1993 while m % 5 == n % 5 == 0:
1994 m //= 5
1995 n //= 5
1996
1997 # compute nth root of xc*10**xe
1998 if n > 1:
1999 # if 1 < xc < 2**n then xc isn't an nth power
2000 if xc != 1 and xc_bits <= n:
2001 return None
2002
2003 xe, rem = divmod(xe, n)
2004 if rem != 0:
2005 return None
2006
2007 # compute nth root of xc using Newton's method
2008 a = 1 << -(-_nbits(xc)//n) # initial estimate
2009 while True:
2010 q, r = divmod(xc, a**(n-1))
2011 if a <= q:
2012 break
2013 else:
2014 a = (a*(n-1) + q)//n
2015 if not (a == q and r == 0):
2016 return None
2017 xc = a
2018
2019 # now xc*10**xe is the nth root of the original xc*10**xe
2020 # compute mth power of xc*10**xe
2021
2022 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2023 # 10**p and the result is not representable.
2024 if xc > 1 and m > p*100//_log10_lb(xc):
2025 return None
2026 xc = xc**m
2027 xe *= m
2028 if xc > 10**p:
2029 return None
2030
2031 # by this point the result *is* exactly representable
2032 # adjust the exponent to get as close as possible to the ideal
2033 # exponent, if necessary
2034 str_xc = str(xc)
2035 if other._isinteger() and other._sign == 0:
2036 ideal_exponent = self._exp*int(other)
2037 zeros = min(xe-ideal_exponent, p-len(str_xc))
2038 else:
2039 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002040 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002041
2042 def __pow__(self, other, modulo=None, context=None):
2043 """Return self ** other [ % modulo].
2044
2045 With two arguments, compute self**other.
2046
2047 With three arguments, compute (self**other) % modulo. For the
2048 three argument form, the following restrictions on the
2049 arguments hold:
2050
2051 - all three arguments must be integral
2052 - other must be nonnegative
2053 - either self or other (or both) must be nonzero
2054 - modulo must be nonzero and must have at most p digits,
2055 where p is the context precision.
2056
2057 If any of these restrictions is violated the InvalidOperation
2058 flag is raised.
2059
2060 The result of pow(self, other, modulo) is identical to the
2061 result that would be obtained by computing (self**other) %
2062 modulo with unbounded precision, but is computed more
2063 efficiently. It is always exact.
2064 """
2065
2066 if modulo is not None:
2067 return self._power_modulo(other, modulo, context)
2068
2069 other = _convert_other(other)
2070 if other is NotImplemented:
2071 return other
2072
2073 if context is None:
2074 context = getcontext()
2075
2076 # either argument is a NaN => result is NaN
2077 ans = self._check_nans(other, context)
2078 if ans:
2079 return ans
2080
2081 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2082 if not other:
2083 if not self:
2084 return context._raise_error(InvalidOperation, '0 ** 0')
2085 else:
2086 return Dec_p1
2087
2088 # result has sign 1 iff self._sign is 1 and other is an odd integer
2089 result_sign = 0
2090 if self._sign == 1:
2091 if other._isinteger():
2092 if not other._iseven():
2093 result_sign = 1
2094 else:
2095 # -ve**noninteger = NaN
2096 # (-0)**noninteger = 0**noninteger
2097 if self:
2098 return context._raise_error(InvalidOperation,
2099 'x ** y with x negative and y not an integer')
2100 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002101 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002102
2103 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2104 if not self:
2105 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002106 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002107 else:
2108 return Infsign[result_sign]
2109
2110 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002111 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002112 if other._sign == 0:
2113 return Infsign[result_sign]
2114 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002115 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002116
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002117 # 1**other = 1, but the choice of exponent and the flags
2118 # depend on the exponent of self, and on whether other is a
2119 # positive integer, a negative integer, or neither
2120 if self == Dec_p1:
2121 if other._isinteger():
2122 # exp = max(self._exp*max(int(other), 0),
2123 # 1-context.prec) but evaluating int(other) directly
2124 # is dangerous until we know other is small (other
2125 # could be 1e999999999)
2126 if other._sign == 1:
2127 multiplier = 0
2128 elif other > context.prec:
2129 multiplier = context.prec
2130 else:
2131 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002132
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002133 exp = self._exp * multiplier
2134 if exp < 1-context.prec:
2135 exp = 1-context.prec
2136 context._raise_error(Rounded)
2137 else:
2138 context._raise_error(Inexact)
2139 context._raise_error(Rounded)
2140 exp = 1-context.prec
2141
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002142 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002143
2144 # compute adjusted exponent of self
2145 self_adj = self.adjusted()
2146
2147 # self ** infinity is infinity if self > 1, 0 if self < 1
2148 # self ** -infinity is infinity if self < 1, 0 if self > 1
2149 if other._isinfinity():
2150 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002151 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002152 else:
2153 return Infsign[result_sign]
2154
2155 # from here on, the result always goes through the call
2156 # to _fix at the end of this function.
2157 ans = None
2158
2159 # crude test to catch cases of extreme overflow/underflow. If
2160 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2161 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2162 # self**other >= 10**(Emax+1), so overflow occurs. The test
2163 # for underflow is similar.
2164 bound = self._log10_exp_bound() + other.adjusted()
2165 if (self_adj >= 0) == (other._sign == 0):
2166 # self > 1 and other +ve, or self < 1 and other -ve
2167 # possibility of overflow
2168 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002169 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002170 else:
2171 # self > 1 and other -ve, or self < 1 and other +ve
2172 # possibility of underflow to 0
2173 Etiny = context.Etiny()
2174 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002175 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002176
2177 # try for an exact result with precision +1
2178 if ans is None:
2179 ans = self._power_exact(other, context.prec + 1)
2180 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002181 ans = _dec_from_triple(1, ans._int, ans._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002182
2183 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2184 if ans is None:
2185 p = context.prec
2186 x = _WorkRep(self)
2187 xc, xe = x.int, x.exp
2188 y = _WorkRep(other)
2189 yc, ye = y.int, y.exp
2190 if y.sign == 1:
2191 yc = -yc
2192
2193 # compute correctly rounded result: start with precision +3,
2194 # then increase precision until result is unambiguously roundable
2195 extra = 3
2196 while True:
2197 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2198 if coeff % (5*10**(len(str(coeff))-p-1)):
2199 break
2200 extra += 3
2201
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002202 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002203
2204 # the specification says that for non-integer other we need to
2205 # raise Inexact, even when the result is actually exact. In
2206 # the same way, we need to raise Underflow here if the result
2207 # is subnormal. (The call to _fix will take care of raising
2208 # Rounded and Subnormal, as usual.)
2209 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002210 context._raise_error(Inexact)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002211 # pad with zeros up to length context.prec+1 if necessary
2212 if len(ans._int) <= context.prec:
2213 expdiff = context.prec+1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002214 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2215 ans._exp-expdiff)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002216 if ans.adjusted() < context.Emin:
2217 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002218
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002219 # unlike exp, ln and log10, the power function respects the
2220 # rounding mode; no need to use ROUND_HALF_EVEN here
2221 ans = ans._fix(context)
2222 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002223
2224 def __rpow__(self, other, context=None):
2225 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002226 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002227 if other is NotImplemented:
2228 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002229 return other.__pow__(self, context=context)
2230
2231 def normalize(self, context=None):
2232 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002233
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002234 if context is None:
2235 context = getcontext()
2236
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002237 if self._is_special:
2238 ans = self._check_nans(context=context)
2239 if ans:
2240 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002241
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002242 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002243 if dup._isinfinity():
2244 return dup
2245
2246 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002247 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002248 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002249 end = len(dup._int)
2250 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002251 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002252 exp += 1
2253 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002254 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002255
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002256 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002257 """Quantize self so its exponent is the same as that of exp.
2258
2259 Similar to self._rescale(exp._exp) but with error checking.
2260 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002261 exp = _convert_other(exp, raiseit=True)
2262
2263 if context is None:
2264 context = getcontext()
2265 if rounding is None:
2266 rounding = context.rounding
2267
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002268 if self._is_special or exp._is_special:
2269 ans = self._check_nans(exp, context)
2270 if ans:
2271 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002272
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002273 if exp._isinfinity() or self._isinfinity():
2274 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002275 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002276 return context._raise_error(InvalidOperation,
2277 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002278
2279 # if we're not watching exponents, do a simple rescale
2280 if not watchexp:
2281 ans = self._rescale(exp._exp, rounding)
2282 # raise Inexact and Rounded where appropriate
2283 if ans._exp > self._exp:
2284 context._raise_error(Rounded)
2285 if ans != self:
2286 context._raise_error(Inexact)
2287 return ans
2288
2289 # exp._exp should be between Etiny and Emax
2290 if not (context.Etiny() <= exp._exp <= context.Emax):
2291 return context._raise_error(InvalidOperation,
2292 'target exponent out of bounds in quantize')
2293
2294 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002295 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002296 return ans._fix(context)
2297
2298 self_adjusted = self.adjusted()
2299 if self_adjusted > context.Emax:
2300 return context._raise_error(InvalidOperation,
2301 'exponent of quantize result too large for current context')
2302 if self_adjusted - exp._exp + 1 > context.prec:
2303 return context._raise_error(InvalidOperation,
2304 'quantize result has too many digits for current context')
2305
2306 ans = self._rescale(exp._exp, rounding)
2307 if ans.adjusted() > context.Emax:
2308 return context._raise_error(InvalidOperation,
2309 'exponent of quantize result too large for current context')
2310 if len(ans._int) > context.prec:
2311 return context._raise_error(InvalidOperation,
2312 'quantize result has too many digits for current context')
2313
2314 # raise appropriate flags
2315 if ans._exp > self._exp:
2316 context._raise_error(Rounded)
2317 if ans != self:
2318 context._raise_error(Inexact)
2319 if ans and ans.adjusted() < context.Emin:
2320 context._raise_error(Subnormal)
2321
2322 # call to fix takes care of any necessary folddown
2323 ans = ans._fix(context)
2324 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002325
2326 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002327 """Return True if self and other have the same exponent; otherwise
2328 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002329
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002330 If either operand is a special value, the following rules are used:
2331 * return True if both operands are infinities
2332 * return True if both operands are NaNs
2333 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002334 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002335 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002336 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002337 return (self.is_nan() and other.is_nan() or
2338 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002339 return self._exp == other._exp
2340
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002341 def _rescale(self, exp, rounding):
2342 """Rescale self so that the exponent is exp, either by padding with zeros
2343 or by truncating digits, using the given rounding mode.
2344
2345 Specials are returned without change. This operation is
2346 quiet: it raises no flags, and uses no information from the
2347 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002348
2349 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002350 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002351 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002352 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002353 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002354 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002355 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002356
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357 if self._exp >= exp:
2358 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002359 return _dec_from_triple(self._sign,
2360 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002361
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002362 # too many digits; round and lose data. If self.adjusted() <
2363 # exp-1, replace self by 10**(exp-1) before rounding
2364 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002365 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002366 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002367 digits = 0
2368 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002369 changed = this_function(digits)
2370 coeff = self._int[:digits] or '0'
2371 if changed == 1:
2372 coeff = str(int(coeff)+1)
2373 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002374
Christian Heimesf16baeb2008-02-29 14:57:44 +00002375 def _round(self, places, rounding):
2376 """Round a nonzero, nonspecial Decimal to a fixed number of
2377 significant figures, using the given rounding mode.
2378
2379 Infinities, NaNs and zeros are returned unaltered.
2380
2381 This operation is quiet: it raises no flags, and uses no
2382 information from the context.
2383
2384 """
2385 if places <= 0:
2386 raise ValueError("argument should be at least 1 in _round")
2387 if self._is_special or not self:
2388 return Decimal(self)
2389 ans = self._rescale(self.adjusted()+1-places, rounding)
2390 # it can happen that the rescale alters the adjusted exponent;
2391 # for example when rounding 99.97 to 3 significant figures.
2392 # When this happens we end up with an extra 0 at the end of
2393 # the number; a second rescale fixes this.
2394 if ans.adjusted() != self.adjusted():
2395 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2396 return ans
2397
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002398 def to_integral_exact(self, rounding=None, context=None):
2399 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002400
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002401 If no rounding mode is specified, take the rounding mode from
2402 the context. This method raises the Rounded and Inexact flags
2403 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002404
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002405 See also: to_integral_value, which does exactly the same as
2406 this method except that it doesn't raise Inexact or Rounded.
2407 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002408 if self._is_special:
2409 ans = self._check_nans(context=context)
2410 if ans:
2411 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002412 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002414 return Decimal(self)
2415 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002416 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002417 if context is None:
2418 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002419 if rounding is None:
2420 rounding = context.rounding
2421 context._raise_error(Rounded)
2422 ans = self._rescale(0, rounding)
2423 if ans != self:
2424 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002425 return ans
2426
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002427 def to_integral_value(self, rounding=None, context=None):
2428 """Rounds to the nearest integer, without raising inexact, rounded."""
2429 if context is None:
2430 context = getcontext()
2431 if rounding is None:
2432 rounding = context.rounding
2433 if self._is_special:
2434 ans = self._check_nans(context=context)
2435 if ans:
2436 return ans
2437 return Decimal(self)
2438 if self._exp >= 0:
2439 return Decimal(self)
2440 else:
2441 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002442
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002443 # the method name changed, but we provide also the old one, for compatibility
2444 to_integral = to_integral_value
2445
2446 def sqrt(self, context=None):
2447 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002448 if context is None:
2449 context = getcontext()
2450
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002451 if self._is_special:
2452 ans = self._check_nans(context=context)
2453 if ans:
2454 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002456 if self._isinfinity() and self._sign == 0:
2457 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002458
2459 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002460 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002461 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002462 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002463
2464 if self._sign == 1:
2465 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2466
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002467 # At this point self represents a positive number. Let p be
2468 # the desired precision and express self in the form c*100**e
2469 # with c a positive real number and e an integer, c and e
2470 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2471 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2472 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2473 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2474 # the closest integer to sqrt(c) with the even integer chosen
2475 # in the case of a tie.
2476 #
2477 # To ensure correct rounding in all cases, we use the
2478 # following trick: we compute the square root to an extra
2479 # place (precision p+1 instead of precision p), rounding down.
2480 # Then, if the result is inexact and its last digit is 0 or 5,
2481 # we increase the last digit to 1 or 6 respectively; if it's
2482 # exact we leave the last digit alone. Now the final round to
2483 # p places (or fewer in the case of underflow) will round
2484 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002485
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002486 # use an extra digit of precision
2487 prec = context.prec+1
2488
2489 # write argument in the form c*100**e where e = self._exp//2
2490 # is the 'ideal' exponent, to be used if the square root is
2491 # exactly representable. l is the number of 'digits' of c in
2492 # base 100, so that 100**(l-1) <= c < 100**l.
2493 op = _WorkRep(self)
2494 e = op.exp >> 1
2495 if op.exp & 1:
2496 c = op.int * 10
2497 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002498 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002499 c = op.int
2500 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002501
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002502 # rescale so that c has exactly prec base 100 'digits'
2503 shift = prec-l
2504 if shift >= 0:
2505 c *= 100**shift
2506 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002507 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002508 c, remainder = divmod(c, 100**-shift)
2509 exact = not remainder
2510 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002511
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002512 # find n = floor(sqrt(c)) using Newton's method
2513 n = 10**prec
2514 while True:
2515 q = c//n
2516 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002517 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002518 else:
2519 n = n + q >> 1
2520 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002522 if exact:
2523 # result is exact; rescale to use ideal exponent e
2524 if shift >= 0:
2525 # assert n % 10**shift == 0
2526 n //= 10**shift
2527 else:
2528 n *= 10**-shift
2529 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002530 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002531 # result is not exact; fix last digit as described above
2532 if n % 5 == 0:
2533 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002535 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002536
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002537 # round, and fit to current context
2538 context = context._shallow_copy()
2539 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002540 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002541 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002544
2545 def max(self, other, context=None):
2546 """Returns the larger value.
2547
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002548 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002549 NaN (and signals if one is sNaN). Also rounds.
2550 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002551 other = _convert_other(other, raiseit=True)
2552
2553 if context is None:
2554 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002556 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002557 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002558 # number is always returned
2559 sn = self._isnan()
2560 on = other._isnan()
2561 if sn or on:
2562 if on == 1 and sn != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002563 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002564 if sn == 1 and on != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002565 return other._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002566 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002567
Christian Heimes77c02eb2008-02-09 02:18:51 +00002568 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002569 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002570 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002571 # then an ordering is applied:
2572 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002573 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002574 # positive sign and min returns the operand with the negative sign
2575 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002576 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002577 # the result. This is exactly the ordering used in compare_total.
2578 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002579
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002580 if c == -1:
2581 ans = other
2582 else:
2583 ans = self
2584
Christian Heimes2c181612007-12-17 20:04:13 +00002585 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002586
2587 def min(self, other, context=None):
2588 """Returns the smaller value.
2589
Guido van Rossumd8faa362007-04-27 19:54:29 +00002590 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591 NaN (and signals if one is sNaN). Also rounds.
2592 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002593 other = _convert_other(other, raiseit=True)
2594
2595 if context is None:
2596 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002597
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002598 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002599 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002600 # number is always returned
2601 sn = self._isnan()
2602 on = other._isnan()
2603 if sn or on:
2604 if on == 1 and sn != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002606 if sn == 1 and on != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002607 return other._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002608 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002609
Christian Heimes77c02eb2008-02-09 02:18:51 +00002610 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002611 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002612 c = self.compare_total(other)
2613
2614 if c == -1:
2615 ans = self
2616 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002617 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002618
Christian Heimes2c181612007-12-17 20:04:13 +00002619 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002620
2621 def _isinteger(self):
2622 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002623 if self._is_special:
2624 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002625 if self._exp >= 0:
2626 return True
2627 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002628 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002629
2630 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002631 """Returns True if self is even. Assumes self is an integer."""
2632 if not self or self._exp > 0:
2633 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002634 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002635
2636 def adjusted(self):
2637 """Return the adjusted exponent of self"""
2638 try:
2639 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002640 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641 except TypeError:
2642 return 0
2643
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002644 def canonical(self, context=None):
2645 """Returns the same Decimal object.
2646
2647 As we do not have different encodings for the same number, the
2648 received object already is in its canonical form.
2649 """
2650 return self
2651
2652 def compare_signal(self, other, context=None):
2653 """Compares self to the other operand numerically.
2654
2655 It's pretty much like compare(), but all NaNs signal, with signaling
2656 NaNs taking precedence over quiet NaNs.
2657 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002658 other = _convert_other(other, raiseit = True)
2659 ans = self._compare_check_nans(other, context)
2660 if ans:
2661 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002662 return self.compare(other, context=context)
2663
2664 def compare_total(self, other):
2665 """Compares self to other using the abstract representations.
2666
2667 This is not like the standard compare, which use their numerical
2668 value. Note that a total ordering is defined for all possible abstract
2669 representations.
2670 """
2671 # if one is negative and the other is positive, it's easy
2672 if self._sign and not other._sign:
2673 return Dec_n1
2674 if not self._sign and other._sign:
2675 return Dec_p1
2676 sign = self._sign
2677
2678 # let's handle both NaN types
2679 self_nan = self._isnan()
2680 other_nan = other._isnan()
2681 if self_nan or other_nan:
2682 if self_nan == other_nan:
2683 if self._int < other._int:
2684 if sign:
2685 return Dec_p1
2686 else:
2687 return Dec_n1
2688 if self._int > other._int:
2689 if sign:
2690 return Dec_n1
2691 else:
2692 return Dec_p1
2693 return Dec_0
2694
2695 if sign:
2696 if self_nan == 1:
2697 return Dec_n1
2698 if other_nan == 1:
2699 return Dec_p1
2700 if self_nan == 2:
2701 return Dec_n1
2702 if other_nan == 2:
2703 return Dec_p1
2704 else:
2705 if self_nan == 1:
2706 return Dec_p1
2707 if other_nan == 1:
2708 return Dec_n1
2709 if self_nan == 2:
2710 return Dec_p1
2711 if other_nan == 2:
2712 return Dec_n1
2713
2714 if self < other:
2715 return Dec_n1
2716 if self > other:
2717 return Dec_p1
2718
2719 if self._exp < other._exp:
2720 if sign:
2721 return Dec_p1
2722 else:
2723 return Dec_n1
2724 if self._exp > other._exp:
2725 if sign:
2726 return Dec_n1
2727 else:
2728 return Dec_p1
2729 return Dec_0
2730
2731
2732 def compare_total_mag(self, other):
2733 """Compares self to other using abstract repr., ignoring sign.
2734
2735 Like compare_total, but with operand's sign ignored and assumed to be 0.
2736 """
2737 s = self.copy_abs()
2738 o = other.copy_abs()
2739 return s.compare_total(o)
2740
2741 def copy_abs(self):
2742 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002743 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002744
2745 def copy_negate(self):
2746 """Returns a copy with the sign inverted."""
2747 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002748 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002749 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002750 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002751
2752 def copy_sign(self, other):
2753 """Returns self with the sign of other."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002754 return _dec_from_triple(other._sign, self._int,
2755 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002756
2757 def exp(self, context=None):
2758 """Returns e ** self."""
2759
2760 if context is None:
2761 context = getcontext()
2762
2763 # exp(NaN) = NaN
2764 ans = self._check_nans(context=context)
2765 if ans:
2766 return ans
2767
2768 # exp(-Infinity) = 0
2769 if self._isinfinity() == -1:
2770 return Dec_0
2771
2772 # exp(0) = 1
2773 if not self:
2774 return Dec_p1
2775
2776 # exp(Infinity) = Infinity
2777 if self._isinfinity() == 1:
2778 return Decimal(self)
2779
2780 # the result is now guaranteed to be inexact (the true
2781 # mathematical result is transcendental). There's no need to
2782 # raise Rounded and Inexact here---they'll always be raised as
2783 # a result of the call to _fix.
2784 p = context.prec
2785 adj = self.adjusted()
2786
2787 # we only need to do any computation for quite a small range
2788 # of adjusted exponents---for example, -29 <= adj <= 10 for
2789 # the default context. For smaller exponent the result is
2790 # indistinguishable from 1 at the given precision, while for
2791 # larger exponent the result either overflows or underflows.
2792 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2793 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002794 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002795 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2796 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002797 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002798 elif self._sign == 0 and adj < -p:
2799 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002800 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002801 elif self._sign == 1 and adj < -p-1:
2802 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002803 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002804 # general case
2805 else:
2806 op = _WorkRep(self)
2807 c, e = op.int, op.exp
2808 if op.sign == 1:
2809 c = -c
2810
2811 # compute correctly rounded result: increase precision by
2812 # 3 digits at a time until we get an unambiguously
2813 # roundable result
2814 extra = 3
2815 while True:
2816 coeff, exp = _dexp(c, e, p+extra)
2817 if coeff % (5*10**(len(str(coeff))-p-1)):
2818 break
2819 extra += 3
2820
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002821 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002822
2823 # at this stage, ans should round correctly with *any*
2824 # rounding mode, not just with ROUND_HALF_EVEN
2825 context = context._shallow_copy()
2826 rounding = context._set_rounding(ROUND_HALF_EVEN)
2827 ans = ans._fix(context)
2828 context.rounding = rounding
2829
2830 return ans
2831
2832 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002833 """Return True if self is canonical; otherwise return False.
2834
2835 Currently, the encoding of a Decimal instance is always
2836 canonical, so this method returns True for any Decimal.
2837 """
2838 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002839
2840 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002841 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002842
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002843 A Decimal instance is considered finite if it is neither
2844 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002845 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002846 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002847
2848 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002849 """Return True if self is infinite; otherwise return False."""
2850 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002851
2852 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002853 """Return True if self is a qNaN or sNaN; otherwise return False."""
2854 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002855
2856 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002857 """Return True if self is a normal number; otherwise return False."""
2858 if self._is_special or not self:
2859 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002860 if context is None:
2861 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002862 return context.Emin <= self.adjusted() <= context.Emax
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002863
2864 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002865 """Return True if self is a quiet NaN; otherwise return False."""
2866 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002867
2868 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002869 """Return True if self is negative; otherwise return False."""
2870 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002871
2872 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002873 """Return True if self is a signaling NaN; otherwise return False."""
2874 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002875
2876 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002877 """Return True if self is subnormal; otherwise return False."""
2878 if self._is_special or not self:
2879 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880 if context is None:
2881 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002882 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002883
2884 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002885 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002886 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002887
2888 def _ln_exp_bound(self):
2889 """Compute a lower bound for the adjusted exponent of self.ln().
2890 In other words, compute r such that self.ln() >= 10**r. Assumes
2891 that self is finite and positive and that self != 1.
2892 """
2893
2894 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2895 adj = self._exp + len(self._int) - 1
2896 if adj >= 1:
2897 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2898 return len(str(adj*23//10)) - 1
2899 if adj <= -2:
2900 # argument <= 0.1
2901 return len(str((-1-adj)*23//10)) - 1
2902 op = _WorkRep(self)
2903 c, e = op.int, op.exp
2904 if adj == 0:
2905 # 1 < self < 10
2906 num = str(c-10**-e)
2907 den = str(c)
2908 return len(num) - len(den) - (num < den)
2909 # adj == -1, 0.1 <= self < 1
2910 return e + len(str(10**-e - c)) - 1
2911
2912
2913 def ln(self, context=None):
2914 """Returns the natural (base e) logarithm of self."""
2915
2916 if context is None:
2917 context = getcontext()
2918
2919 # ln(NaN) = NaN
2920 ans = self._check_nans(context=context)
2921 if ans:
2922 return ans
2923
2924 # ln(0.0) == -Infinity
2925 if not self:
2926 return negInf
2927
2928 # ln(Infinity) = Infinity
2929 if self._isinfinity() == 1:
2930 return Inf
2931
2932 # ln(1.0) == 0.0
2933 if self == Dec_p1:
2934 return Dec_0
2935
2936 # ln(negative) raises InvalidOperation
2937 if self._sign == 1:
2938 return context._raise_error(InvalidOperation,
2939 'ln of a negative value')
2940
2941 # result is irrational, so necessarily inexact
2942 op = _WorkRep(self)
2943 c, e = op.int, op.exp
2944 p = context.prec
2945
2946 # correctly rounded result: repeatedly increase precision by 3
2947 # until we get an unambiguously roundable result
2948 places = p - self._ln_exp_bound() + 2 # at least p+3 places
2949 while True:
2950 coeff = _dlog(c, e, places)
2951 # assert len(str(abs(coeff)))-p >= 1
2952 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
2953 break
2954 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002955 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002956
2957 context = context._shallow_copy()
2958 rounding = context._set_rounding(ROUND_HALF_EVEN)
2959 ans = ans._fix(context)
2960 context.rounding = rounding
2961 return ans
2962
2963 def _log10_exp_bound(self):
2964 """Compute a lower bound for the adjusted exponent of self.log10().
2965 In other words, find r such that self.log10() >= 10**r.
2966 Assumes that self is finite and positive and that self != 1.
2967 """
2968
2969 # For x >= 10 or x < 0.1 we only need a bound on the integer
2970 # part of log10(self), and this comes directly from the
2971 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
2972 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
2973 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
2974
2975 adj = self._exp + len(self._int) - 1
2976 if adj >= 1:
2977 # self >= 10
2978 return len(str(adj))-1
2979 if adj <= -2:
2980 # self < 0.1
2981 return len(str(-1-adj))-1
2982 op = _WorkRep(self)
2983 c, e = op.int, op.exp
2984 if adj == 0:
2985 # 1 < self < 10
2986 num = str(c-10**-e)
2987 den = str(231*c)
2988 return len(num) - len(den) - (num < den) + 2
2989 # adj == -1, 0.1 <= self < 1
2990 num = str(10**-e-c)
2991 return len(num) + e - (num < "231") - 1
2992
2993 def log10(self, context=None):
2994 """Returns the base 10 logarithm of self."""
2995
2996 if context is None:
2997 context = getcontext()
2998
2999 # log10(NaN) = NaN
3000 ans = self._check_nans(context=context)
3001 if ans:
3002 return ans
3003
3004 # log10(0.0) == -Infinity
3005 if not self:
3006 return negInf
3007
3008 # log10(Infinity) = Infinity
3009 if self._isinfinity() == 1:
3010 return Inf
3011
3012 # log10(negative or -Infinity) raises InvalidOperation
3013 if self._sign == 1:
3014 return context._raise_error(InvalidOperation,
3015 'log10 of a negative value')
3016
3017 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003018 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003019 # answer may need rounding
3020 ans = Decimal(self._exp + len(self._int) - 1)
3021 else:
3022 # result is irrational, so necessarily inexact
3023 op = _WorkRep(self)
3024 c, e = op.int, op.exp
3025 p = context.prec
3026
3027 # correctly rounded result: repeatedly increase precision
3028 # until result is unambiguously roundable
3029 places = p-self._log10_exp_bound()+2
3030 while True:
3031 coeff = _dlog10(c, e, places)
3032 # assert len(str(abs(coeff)))-p >= 1
3033 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3034 break
3035 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003036 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003037
3038 context = context._shallow_copy()
3039 rounding = context._set_rounding(ROUND_HALF_EVEN)
3040 ans = ans._fix(context)
3041 context.rounding = rounding
3042 return ans
3043
3044 def logb(self, context=None):
3045 """ Returns the exponent of the magnitude of self's MSD.
3046
3047 The result is the integer which is the exponent of the magnitude
3048 of the most significant digit of self (as though it were truncated
3049 to a single digit while maintaining the value of that digit and
3050 without limiting the resulting exponent).
3051 """
3052 # logb(NaN) = NaN
3053 ans = self._check_nans(context=context)
3054 if ans:
3055 return ans
3056
3057 if context is None:
3058 context = getcontext()
3059
3060 # logb(+/-Inf) = +Inf
3061 if self._isinfinity():
3062 return Inf
3063
3064 # logb(0) = -Inf, DivisionByZero
3065 if not self:
3066 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3067
3068 # otherwise, simply return the adjusted exponent of self, as a
3069 # Decimal. Note that no attempt is made to fit the result
3070 # into the current context.
3071 return Decimal(self.adjusted())
3072
3073 def _islogical(self):
3074 """Return True if self is a logical operand.
3075
Christian Heimes679db4a2008-01-18 09:56:22 +00003076 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003077 an exponent of 0, and a coefficient whose digits must all be
3078 either 0 or 1.
3079 """
3080 if self._sign != 0 or self._exp != 0:
3081 return False
3082 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003083 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003084 return False
3085 return True
3086
3087 def _fill_logical(self, context, opa, opb):
3088 dif = context.prec - len(opa)
3089 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003090 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003091 elif dif < 0:
3092 opa = opa[-context.prec:]
3093 dif = context.prec - len(opb)
3094 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003095 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003096 elif dif < 0:
3097 opb = opb[-context.prec:]
3098 return opa, opb
3099
3100 def logical_and(self, other, context=None):
3101 """Applies an 'and' operation between self and other's digits."""
3102 if context is None:
3103 context = getcontext()
3104 if not self._islogical() or not other._islogical():
3105 return context._raise_error(InvalidOperation)
3106
3107 # fill to context.prec
3108 (opa, opb) = self._fill_logical(context, self._int, other._int)
3109
3110 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003111 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3112 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003113
3114 def logical_invert(self, context=None):
3115 """Invert all its digits."""
3116 if context is None:
3117 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003118 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3119 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003120
3121 def logical_or(self, other, context=None):
3122 """Applies an 'or' operation between self and other's digits."""
3123 if context is None:
3124 context = getcontext()
3125 if not self._islogical() or not other._islogical():
3126 return context._raise_error(InvalidOperation)
3127
3128 # fill to context.prec
3129 (opa, opb) = self._fill_logical(context, self._int, other._int)
3130
3131 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003132 result = "".join(str(int(a)|int(b)) for a,b in zip(opa,opb))
3133 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003134
3135 def logical_xor(self, other, context=None):
3136 """Applies an 'xor' operation between self and other's digits."""
3137 if context is None:
3138 context = getcontext()
3139 if not self._islogical() or not other._islogical():
3140 return context._raise_error(InvalidOperation)
3141
3142 # fill to context.prec
3143 (opa, opb) = self._fill_logical(context, self._int, other._int)
3144
3145 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003146 result = "".join(str(int(a)^int(b)) for a,b in zip(opa,opb))
3147 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003148
3149 def max_mag(self, other, context=None):
3150 """Compares the values numerically with their sign ignored."""
3151 other = _convert_other(other, raiseit=True)
3152
3153 if context is None:
3154 context = getcontext()
3155
3156 if self._is_special or other._is_special:
3157 # If one operand is a quiet NaN and the other is number, then the
3158 # number is always returned
3159 sn = self._isnan()
3160 on = other._isnan()
3161 if sn or on:
3162 if on == 1 and sn != 2:
3163 return self._fix_nan(context)
3164 if sn == 1 and on != 2:
3165 return other._fix_nan(context)
3166 return self._check_nans(other, context)
3167
Christian Heimes77c02eb2008-02-09 02:18:51 +00003168 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003169 if c == 0:
3170 c = self.compare_total(other)
3171
3172 if c == -1:
3173 ans = other
3174 else:
3175 ans = self
3176
Christian Heimes2c181612007-12-17 20:04:13 +00003177 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003178
3179 def min_mag(self, other, context=None):
3180 """Compares the values numerically with their sign ignored."""
3181 other = _convert_other(other, raiseit=True)
3182
3183 if context is None:
3184 context = getcontext()
3185
3186 if self._is_special or other._is_special:
3187 # If one operand is a quiet NaN and the other is number, then the
3188 # number is always returned
3189 sn = self._isnan()
3190 on = other._isnan()
3191 if sn or on:
3192 if on == 1 and sn != 2:
3193 return self._fix_nan(context)
3194 if sn == 1 and on != 2:
3195 return other._fix_nan(context)
3196 return self._check_nans(other, context)
3197
Christian Heimes77c02eb2008-02-09 02:18:51 +00003198 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003199 if c == 0:
3200 c = self.compare_total(other)
3201
3202 if c == -1:
3203 ans = self
3204 else:
3205 ans = other
3206
Christian Heimes2c181612007-12-17 20:04:13 +00003207 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003208
3209 def next_minus(self, context=None):
3210 """Returns the largest representable number smaller than itself."""
3211 if context is None:
3212 context = getcontext()
3213
3214 ans = self._check_nans(context=context)
3215 if ans:
3216 return ans
3217
3218 if self._isinfinity() == -1:
3219 return negInf
3220 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003221 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003222
3223 context = context.copy()
3224 context._set_rounding(ROUND_FLOOR)
3225 context._ignore_all_flags()
3226 new_self = self._fix(context)
3227 if new_self != self:
3228 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003229 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3230 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003231
3232 def next_plus(self, context=None):
3233 """Returns the smallest representable number larger than itself."""
3234 if context is None:
3235 context = getcontext()
3236
3237 ans = self._check_nans(context=context)
3238 if ans:
3239 return ans
3240
3241 if self._isinfinity() == 1:
3242 return Inf
3243 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003244 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003245
3246 context = context.copy()
3247 context._set_rounding(ROUND_CEILING)
3248 context._ignore_all_flags()
3249 new_self = self._fix(context)
3250 if new_self != self:
3251 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003252 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3253 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003254
3255 def next_toward(self, other, context=None):
3256 """Returns the number closest to self, in the direction towards other.
3257
3258 The result is the closest representable number to self
3259 (excluding self) that is in the direction towards other,
3260 unless both have the same value. If the two operands are
3261 numerically equal, then the result is a copy of self with the
3262 sign set to be the same as the sign of other.
3263 """
3264 other = _convert_other(other, raiseit=True)
3265
3266 if context is None:
3267 context = getcontext()
3268
3269 ans = self._check_nans(other, context)
3270 if ans:
3271 return ans
3272
Christian Heimes77c02eb2008-02-09 02:18:51 +00003273 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003274 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003275 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003276
3277 if comparison == -1:
3278 ans = self.next_plus(context)
3279 else: # comparison == 1
3280 ans = self.next_minus(context)
3281
3282 # decide which flags to raise using value of ans
3283 if ans._isinfinity():
3284 context._raise_error(Overflow,
3285 'Infinite result from next_toward',
3286 ans._sign)
3287 context._raise_error(Rounded)
3288 context._raise_error(Inexact)
3289 elif ans.adjusted() < context.Emin:
3290 context._raise_error(Underflow)
3291 context._raise_error(Subnormal)
3292 context._raise_error(Rounded)
3293 context._raise_error(Inexact)
3294 # if precision == 1 then we don't raise Clamped for a
3295 # result 0E-Etiny.
3296 if not ans:
3297 context._raise_error(Clamped)
3298
3299 return ans
3300
3301 def number_class(self, context=None):
3302 """Returns an indication of the class of self.
3303
3304 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003305 sNaN
3306 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003307 -Infinity
3308 -Normal
3309 -Subnormal
3310 -Zero
3311 +Zero
3312 +Subnormal
3313 +Normal
3314 +Infinity
3315 """
3316 if self.is_snan():
3317 return "sNaN"
3318 if self.is_qnan():
3319 return "NaN"
3320 inf = self._isinfinity()
3321 if inf == 1:
3322 return "+Infinity"
3323 if inf == -1:
3324 return "-Infinity"
3325 if self.is_zero():
3326 if self._sign:
3327 return "-Zero"
3328 else:
3329 return "+Zero"
3330 if context is None:
3331 context = getcontext()
3332 if self.is_subnormal(context=context):
3333 if self._sign:
3334 return "-Subnormal"
3335 else:
3336 return "+Subnormal"
3337 # just a normal, regular, boring number, :)
3338 if self._sign:
3339 return "-Normal"
3340 else:
3341 return "+Normal"
3342
3343 def radix(self):
3344 """Just returns 10, as this is Decimal, :)"""
3345 return Decimal(10)
3346
3347 def rotate(self, other, context=None):
3348 """Returns a rotated copy of self, value-of-other times."""
3349 if context is None:
3350 context = getcontext()
3351
3352 ans = self._check_nans(other, context)
3353 if ans:
3354 return ans
3355
3356 if other._exp != 0:
3357 return context._raise_error(InvalidOperation)
3358 if not (-context.prec <= int(other) <= context.prec):
3359 return context._raise_error(InvalidOperation)
3360
3361 if self._isinfinity():
3362 return Decimal(self)
3363
3364 # get values, pad if necessary
3365 torot = int(other)
3366 rotdig = self._int
3367 topad = context.prec - len(rotdig)
3368 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003369 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003370
3371 # let's rotate!
3372 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003373 return _dec_from_triple(self._sign,
3374 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003375
3376 def scaleb (self, other, context=None):
3377 """Returns self operand after adding the second value to its exp."""
3378 if context is None:
3379 context = getcontext()
3380
3381 ans = self._check_nans(other, context)
3382 if ans:
3383 return ans
3384
3385 if other._exp != 0:
3386 return context._raise_error(InvalidOperation)
3387 liminf = -2 * (context.Emax + context.prec)
3388 limsup = 2 * (context.Emax + context.prec)
3389 if not (liminf <= int(other) <= limsup):
3390 return context._raise_error(InvalidOperation)
3391
3392 if self._isinfinity():
3393 return Decimal(self)
3394
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003395 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003396 d = d._fix(context)
3397 return d
3398
3399 def shift(self, other, context=None):
3400 """Returns a shifted copy of self, value-of-other times."""
3401 if context is None:
3402 context = getcontext()
3403
3404 ans = self._check_nans(other, context)
3405 if ans:
3406 return ans
3407
3408 if other._exp != 0:
3409 return context._raise_error(InvalidOperation)
3410 if not (-context.prec <= int(other) <= context.prec):
3411 return context._raise_error(InvalidOperation)
3412
3413 if self._isinfinity():
3414 return Decimal(self)
3415
3416 # get values, pad if necessary
3417 torot = int(other)
3418 if not torot:
3419 return Decimal(self)
3420 rotdig = self._int
3421 topad = context.prec - len(rotdig)
3422 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003423 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003424
3425 # let's shift!
3426 if torot < 0:
3427 rotated = rotdig[:torot]
3428 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003429 rotated = rotdig + '0'*torot
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003430 rotated = rotated[-context.prec:]
3431
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003432 return _dec_from_triple(self._sign,
3433 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003434
Guido van Rossumd8faa362007-04-27 19:54:29 +00003435 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003436 def __reduce__(self):
3437 return (self.__class__, (str(self),))
3438
3439 def __copy__(self):
3440 if type(self) == Decimal:
3441 return self # I'm immutable; therefore I am my own clone
3442 return self.__class__(str(self))
3443
3444 def __deepcopy__(self, memo):
3445 if type(self) == Decimal:
3446 return self # My components are also immutable
3447 return self.__class__(str(self))
3448
Christian Heimesf16baeb2008-02-29 14:57:44 +00003449 # PEP 3101 support. See also _parse_format_specifier and _format_align
3450 def __format__(self, specifier, context=None):
3451 """Format a Decimal instance according to the given specifier.
3452
3453 The specifier should be a standard format specifier, with the
3454 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3455 'F', 'g', 'G', and '%' are supported. If the formatting type
3456 is omitted it defaults to 'g' or 'G', depending on the value
3457 of context.capitals.
3458
3459 At this time the 'n' format specifier type (which is supposed
3460 to use the current locale) is not supported.
3461 """
3462
3463 # Note: PEP 3101 says that if the type is not present then
3464 # there should be at least one digit after the decimal point.
3465 # We take the liberty of ignoring this requirement for
3466 # Decimal---it's presumably there to make sure that
3467 # format(float, '') behaves similarly to str(float).
3468 if context is None:
3469 context = getcontext()
3470
3471 spec = _parse_format_specifier(specifier)
3472
3473 # special values don't care about the type or precision...
3474 if self._is_special:
3475 return _format_align(str(self), spec)
3476
3477 # a type of None defaults to 'g' or 'G', depending on context
3478 # if type is '%', adjust exponent of self accordingly
3479 if spec['type'] is None:
3480 spec['type'] = ['g', 'G'][context.capitals]
3481 elif spec['type'] == '%':
3482 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3483
3484 # round if necessary, taking rounding mode from the context
3485 rounding = context.rounding
3486 precision = spec['precision']
3487 if precision is not None:
3488 if spec['type'] in 'eE':
3489 self = self._round(precision+1, rounding)
3490 elif spec['type'] in 'gG':
3491 if len(self._int) > precision:
3492 self = self._round(precision, rounding)
3493 elif spec['type'] in 'fF%':
3494 self = self._rescale(-precision, rounding)
3495 # special case: zeros with a positive exponent can't be
3496 # represented in fixed point; rescale them to 0e0.
3497 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3498 self = self._rescale(0, rounding)
3499
3500 # figure out placement of the decimal point
3501 leftdigits = self._exp + len(self._int)
3502 if spec['type'] in 'fF%':
3503 dotplace = leftdigits
3504 elif spec['type'] in 'eE':
3505 if not self and precision is not None:
3506 dotplace = 1 - precision
3507 else:
3508 dotplace = 1
3509 elif spec['type'] in 'gG':
3510 if self._exp <= 0 and leftdigits > -6:
3511 dotplace = leftdigits
3512 else:
3513 dotplace = 1
3514
3515 # figure out main part of numeric string...
3516 if dotplace <= 0:
3517 num = '0.' + '0'*(-dotplace) + self._int
3518 elif dotplace >= len(self._int):
3519 # make sure we're not padding a '0' with extra zeros on the right
3520 assert dotplace==len(self._int) or self._int != '0'
3521 num = self._int + '0'*(dotplace-len(self._int))
3522 else:
3523 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3524
3525 # ...then the trailing exponent, or trailing '%'
3526 if leftdigits != dotplace or spec['type'] in 'eE':
3527 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3528 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3529 elif spec['type'] == '%':
3530 num = num + '%'
3531
3532 # add sign
3533 if self._sign == 1:
3534 num = '-' + num
3535 return _format_align(num, spec)
3536
3537
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003538def _dec_from_triple(sign, coefficient, exponent, special=False):
3539 """Create a decimal instance directly, without any validation,
3540 normalization (e.g. removal of leading zeros) or argument
3541 conversion.
3542
3543 This function is for *internal use only*.
3544 """
3545
3546 self = object.__new__(Decimal)
3547 self._sign = sign
3548 self._int = coefficient
3549 self._exp = exponent
3550 self._is_special = special
3551
3552 return self
3553
Guido van Rossumd8faa362007-04-27 19:54:29 +00003554##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003555
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003556
3557# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003558rounding_functions = [name for name in Decimal.__dict__.keys()
3559 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003560for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003561 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003562 globalname = name[1:].upper()
3563 val = globals()[globalname]
3564 Decimal._pick_rounding_function[val] = name
3565
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003566del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003567
Thomas Wouters89f507f2006-12-13 04:49:30 +00003568class _ContextManager(object):
3569 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003570
Thomas Wouters89f507f2006-12-13 04:49:30 +00003571 Sets a copy of the supplied context in __enter__() and restores
3572 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003573 """
3574 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003575 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003576 def __enter__(self):
3577 self.saved_context = getcontext()
3578 setcontext(self.new_context)
3579 return self.new_context
3580 def __exit__(self, t, v, tb):
3581 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003582
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003583class Context(object):
3584 """Contains the context for a Decimal instance.
3585
3586 Contains:
3587 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003588 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003589 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003590 raised when it is caused. Otherwise, a value is
3591 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003592 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003593 (Whether or not the trap_enabler is set)
3594 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003595 Emin - Minimum exponent
3596 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003597 capitals - If 1, 1*10^1 is printed as 1E+1.
3598 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003599 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003600 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003601
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003602 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003603 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003604 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003605 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003606 _ignored_flags=None):
3607 if flags is None:
3608 flags = []
3609 if _ignored_flags is None:
3610 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003611 if not isinstance(flags, dict):
Raymond Hettingerfed52962004-07-14 15:41:57 +00003612 flags = dict([(s,s in flags) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003613 if traps is not None and not isinstance(traps, dict):
Raymond Hettingerfed52962004-07-14 15:41:57 +00003614 traps = dict([(s,s in traps) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003615 for name, val in locals().items():
3616 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003617 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003618 else:
3619 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003620 del self.self
3621
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003622 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003623 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003624 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003625 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3626 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3627 % vars(self))
3628 names = [f.__name__ for f, v in self.flags.items() if v]
3629 s.append('flags=[' + ', '.join(names) + ']')
3630 names = [t.__name__ for t, v in self.traps.items() if v]
3631 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003632 return ', '.join(s) + ')'
3633
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003634 def clear_flags(self):
3635 """Reset all flags to zero"""
3636 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003637 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003638
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003639 def _shallow_copy(self):
3640 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003641 nc = Context(self.prec, self.rounding, self.traps,
3642 self.flags, self.Emin, self.Emax,
3643 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003644 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003645
3646 def copy(self):
3647 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003648 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003649 self.flags.copy(), self.Emin, self.Emax,
3650 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003651 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003652 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003653
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003654 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003655 """Handles an error
3656
3657 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003658 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003659 trap_enabler is set, it reaises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003660 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003661 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003662 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003663 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003664 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003665 return error().handle(self, *args)
3666
Raymond Hettinger86173da2008-02-01 20:38:12 +00003667 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003668 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003669 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003670 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003671
3672 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003673 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003674 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003675
3676 def _ignore_all_flags(self):
3677 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003678 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003679
3680 def _ignore_flags(self, *flags):
3681 """Ignore the flags, if they are raised"""
3682 # Do not mutate-- This way, copies of a context leave the original
3683 # alone.
3684 self._ignored_flags = (self._ignored_flags + list(flags))
3685 return list(flags)
3686
3687 def _regard_flags(self, *flags):
3688 """Stop ignoring the flags, if they are raised"""
3689 if flags and isinstance(flags[0], (tuple,list)):
3690 flags = flags[0]
3691 for flag in flags:
3692 self._ignored_flags.remove(flag)
3693
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003694 def __hash__(self):
3695 """A Context cannot be hashed."""
3696 # We inherit object.__hash__, so we must deny this explicitly
Guido van Rossumd8faa362007-04-27 19:54:29 +00003697 raise TypeError("Cannot hash a Context.")
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003698
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003699 def Etiny(self):
3700 """Returns Etiny (= Emin - prec + 1)"""
3701 return int(self.Emin - self.prec + 1)
3702
3703 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003704 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003705 return int(self.Emax - self.prec + 1)
3706
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003707 def _set_rounding(self, type):
3708 """Sets the rounding type.
3709
3710 Sets the rounding type, and returns the current (previous)
3711 rounding type. Often used like:
3712
3713 context = context.copy()
3714 # so you don't change the calling context
3715 # if an error occurs in the middle.
3716 rounding = context._set_rounding(ROUND_UP)
3717 val = self.__sub__(other, context=context)
3718 context._set_rounding(rounding)
3719
3720 This will make it round up for that operation.
3721 """
3722 rounding = self.rounding
3723 self.rounding= type
3724 return rounding
3725
Raymond Hettingerfed52962004-07-14 15:41:57 +00003726 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003727 """Creates a new Decimal instance but using self as context.
3728
3729 This method implements the to-number operation of the
3730 IBM Decimal specification."""
3731
3732 if isinstance(num, str) and num != num.strip():
3733 return self._raise_error(ConversionSyntax,
3734 "no trailing or leading whitespace is "
3735 "permitted.")
3736
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003737 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003738 if d._isnan() and len(d._int) > self.prec - self._clamp:
3739 return self._raise_error(ConversionSyntax,
3740 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003741 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003742
Guido van Rossumd8faa362007-04-27 19:54:29 +00003743 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003744 def abs(self, a):
3745 """Returns the absolute value of the operand.
3746
3747 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003748 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003749 the plus operation on the operand.
3750
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003751 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003752 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003753 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003754 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003755 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003756 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003757 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003758 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003759 """
3760 return a.__abs__(context=self)
3761
3762 def add(self, a, b):
3763 """Return the sum of the two operands.
3764
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003765 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003766 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003767 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003768 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003769 """
3770 return a.__add__(b, context=self)
3771
3772 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003773 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003774
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003775 def canonical(self, a):
3776 """Returns the same Decimal object.
3777
3778 As we do not have different encodings for the same number, the
3779 received object already is in its canonical form.
3780
3781 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003782 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003783 """
3784 return a.canonical(context=self)
3785
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003786 def compare(self, a, b):
3787 """Compares values numerically.
3788
3789 If the signs of the operands differ, a value representing each operand
3790 ('-1' if the operand is less than zero, '0' if the operand is zero or
3791 negative zero, or '1' if the operand is greater than zero) is used in
3792 place of that operand for the comparison instead of the actual
3793 operand.
3794
3795 The comparison is then effected by subtracting the second operand from
3796 the first and then returning a value according to the result of the
3797 subtraction: '-1' if the result is less than zero, '0' if the result is
3798 zero or negative zero, or '1' if the result is greater than zero.
3799
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003800 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003801 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003802 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003803 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003804 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003805 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003806 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003807 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003808 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003809 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003810 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003811 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003812 """
3813 return a.compare(b, context=self)
3814
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003815 def compare_signal(self, a, b):
3816 """Compares the values of the two operands numerically.
3817
3818 It's pretty much like compare(), but all NaNs signal, with signaling
3819 NaNs taking precedence over quiet NaNs.
3820
3821 >>> c = ExtendedContext
3822 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003823 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003824 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003825 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003826 >>> c.flags[InvalidOperation] = 0
3827 >>> print(c.flags[InvalidOperation])
3828 0
3829 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003830 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003831 >>> print(c.flags[InvalidOperation])
3832 1
3833 >>> c.flags[InvalidOperation] = 0
3834 >>> print(c.flags[InvalidOperation])
3835 0
3836 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003837 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003838 >>> print(c.flags[InvalidOperation])
3839 1
3840 """
3841 return a.compare_signal(b, context=self)
3842
3843 def compare_total(self, a, b):
3844 """Compares two operands using their abstract representation.
3845
3846 This is not like the standard compare, which use their numerical
3847 value. Note that a total ordering is defined for all possible abstract
3848 representations.
3849
3850 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003851 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003852 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003853 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003854 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003855 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003856 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003857 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003858 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003859 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003860 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003861 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003862 """
3863 return a.compare_total(b)
3864
3865 def compare_total_mag(self, a, b):
3866 """Compares two operands using their abstract representation ignoring sign.
3867
3868 Like compare_total, but with operand's sign ignored and assumed to be 0.
3869 """
3870 return a.compare_total_mag(b)
3871
3872 def copy_abs(self, a):
3873 """Returns a copy of the operand with the sign set to 0.
3874
3875 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003876 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003877 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003878 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003879 """
3880 return a.copy_abs()
3881
3882 def copy_decimal(self, a):
3883 """Returns a copy of the decimal objet.
3884
3885 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003886 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003887 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003888 Decimal('-1.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003889 """
3890 return Decimal(a)
3891
3892 def copy_negate(self, a):
3893 """Returns a copy of the operand with the sign inverted.
3894
3895 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003896 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003897 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003898 Decimal('101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003899 """
3900 return a.copy_negate()
3901
3902 def copy_sign(self, a, b):
3903 """Copies the second operand's sign to the first one.
3904
3905 In detail, it returns a copy of the first operand with the sign
3906 equal to the sign of the second operand.
3907
3908 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003909 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003910 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003911 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003912 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003913 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003914 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003915 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003916 """
3917 return a.copy_sign(b)
3918
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003919 def divide(self, a, b):
3920 """Decimal division in a specified context.
3921
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003922 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003923 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003924 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003925 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003926 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003927 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003928 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003929 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003930 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003931 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003932 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003933 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003934 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003935 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003936 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003937 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003938 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003939 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003940 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003941 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003942 """
Neal Norwitzbcc0db82006-03-24 08:14:36 +00003943 return a.__truediv__(b, context=self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003944
3945 def divide_int(self, a, b):
3946 """Divides two numbers and returns the integer part of the result.
3947
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003948 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003949 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003950 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003951 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003952 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003953 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003954 """
3955 return a.__floordiv__(b, context=self)
3956
3957 def divmod(self, a, b):
3958 return a.__divmod__(b, context=self)
3959
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003960 def exp(self, a):
3961 """Returns e ** a.
3962
3963 >>> c = ExtendedContext.copy()
3964 >>> c.Emin = -999
3965 >>> c.Emax = 999
3966 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003967 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003968 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003969 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003970 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003971 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003972 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003973 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003974 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003975 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003976 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003977 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003978 """
3979 return a.exp(context=self)
3980
3981 def fma(self, a, b, c):
3982 """Returns a multiplied by b, plus c.
3983
3984 The first two operands are multiplied together, using multiply,
3985 the third operand is then added to the result of that
3986 multiplication, using add, all with only one final rounding.
3987
3988 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003989 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003990 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003991 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003992 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003993 Decimal('1.38435736E+12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003994 """
3995 return a.fma(b, c, context=self)
3996
3997 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003998 """Return True if the operand is canonical; otherwise return False.
3999
4000 Currently, the encoding of a Decimal instance is always
4001 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004002
4003 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004004 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004005 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004006 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004007
4008 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004009 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004010
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004011 A Decimal instance is considered finite if it is neither
4012 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004013
4014 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004015 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004016 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004017 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004018 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004019 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004020 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004021 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004022 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004023 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004024 """
4025 return a.is_finite()
4026
4027 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004028 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004029
4030 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004031 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004032 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004033 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004034 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004035 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004036 """
4037 return a.is_infinite()
4038
4039 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004040 """Return True if the operand is a qNaN or sNaN;
4041 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004042
4043 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004044 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004045 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004046 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004047 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004048 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004049 """
4050 return a.is_nan()
4051
4052 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004053 """Return True if the operand is a normal number;
4054 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004055
4056 >>> c = ExtendedContext.copy()
4057 >>> c.Emin = -999
4058 >>> c.Emax = 999
4059 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004060 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004061 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004062 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004063 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004064 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004065 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004066 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004067 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004068 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004069 """
4070 return a.is_normal(context=self)
4071
4072 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004073 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004074
4075 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004076 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004077 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004078 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004079 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004080 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004081 """
4082 return a.is_qnan()
4083
4084 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004085 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004086
4087 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004088 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004089 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004090 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004091 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004092 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004093 """
4094 return a.is_signed()
4095
4096 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004097 """Return True if the operand is a signaling NaN;
4098 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004099
4100 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004101 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004102 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004103 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004104 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004105 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004106 """
4107 return a.is_snan()
4108
4109 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004110 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004111
4112 >>> c = ExtendedContext.copy()
4113 >>> c.Emin = -999
4114 >>> c.Emax = 999
4115 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004116 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004117 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004118 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004119 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004120 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004121 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004122 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004123 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004124 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004125 """
4126 return a.is_subnormal(context=self)
4127
4128 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004129 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004130
4131 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004132 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004133 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004134 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004135 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004136 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004137 """
4138 return a.is_zero()
4139
4140 def ln(self, a):
4141 """Returns the natural (base e) logarithm of the operand.
4142
4143 >>> c = ExtendedContext.copy()
4144 >>> c.Emin = -999
4145 >>> c.Emax = 999
4146 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004147 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004148 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004149 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004150 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004151 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004152 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004153 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004154 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004155 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004156 """
4157 return a.ln(context=self)
4158
4159 def log10(self, a):
4160 """Returns the base 10 logarithm of the operand.
4161
4162 >>> c = ExtendedContext.copy()
4163 >>> c.Emin = -999
4164 >>> c.Emax = 999
4165 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004166 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004167 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004168 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004169 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004170 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004171 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004172 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004173 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004174 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004175 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004176 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004177 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004178 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004179 """
4180 return a.log10(context=self)
4181
4182 def logb(self, a):
4183 """ Returns the exponent of the magnitude of the operand's MSD.
4184
4185 The result is the integer which is the exponent of the magnitude
4186 of the most significant digit of the operand (as though the
4187 operand were truncated to a single digit while maintaining the
4188 value of that digit and without limiting the resulting exponent).
4189
4190 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004191 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004192 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004193 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004194 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004195 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004196 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004197 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004198 """
4199 return a.logb(context=self)
4200
4201 def logical_and(self, a, b):
4202 """Applies the logical operation 'and' between each operand's digits.
4203
4204 The operands must be both logical numbers.
4205
4206 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004207 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004208 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004209 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004210 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004211 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004212 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004213 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004214 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004215 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004216 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004217 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004218 """
4219 return a.logical_and(b, context=self)
4220
4221 def logical_invert(self, a):
4222 """Invert all the digits in the operand.
4223
4224 The operand must be a logical number.
4225
4226 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004227 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004228 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004229 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004230 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004231 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004232 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004233 Decimal('10101010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004234 """
4235 return a.logical_invert(context=self)
4236
4237 def logical_or(self, a, b):
4238 """Applies the logical operation 'or' between each operand's digits.
4239
4240 The operands must be both logical numbers.
4241
4242 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004243 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004244 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004245 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004246 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004247 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004248 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004249 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004250 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004251 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004252 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004253 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004254 """
4255 return a.logical_or(b, context=self)
4256
4257 def logical_xor(self, a, b):
4258 """Applies the logical operation 'xor' between each operand's digits.
4259
4260 The operands must be both logical numbers.
4261
4262 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004263 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004264 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004265 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004266 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004267 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004268 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004269 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004270 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004271 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004272 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004273 Decimal('1101')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004274 """
4275 return a.logical_xor(b, context=self)
4276
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004277 def max(self, a,b):
4278 """max compares two values numerically and returns the maximum.
4279
4280 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004281 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004282 operation. If they are numerically equal then the left-hand operand
4283 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004284 infinity) of the two operands is chosen as the result.
4285
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004286 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004287 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004288 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004289 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004290 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004291 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004292 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004293 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004294 """
4295 return a.max(b, context=self)
4296
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004297 def max_mag(self, a, b):
4298 """Compares the values numerically with their sign ignored."""
4299 return a.max_mag(b, context=self)
4300
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004301 def min(self, a,b):
4302 """min compares two values numerically and returns the minimum.
4303
4304 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004305 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004306 operation. If they are numerically equal then the left-hand operand
4307 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004308 infinity) of the two operands is chosen as the result.
4309
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004310 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004311 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004312 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004313 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004314 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004315 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004316 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004317 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004318 """
4319 return a.min(b, context=self)
4320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004321 def min_mag(self, a, b):
4322 """Compares the values numerically with their sign ignored."""
4323 return a.min_mag(b, context=self)
4324
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004325 def minus(self, a):
4326 """Minus corresponds to unary prefix minus in Python.
4327
4328 The operation is evaluated using the same rules as subtract; the
4329 operation minus(a) is calculated as subtract('0', a) where the '0'
4330 has the same exponent as the operand.
4331
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004332 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004333 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004334 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004335 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004336 """
4337 return a.__neg__(context=self)
4338
4339 def multiply(self, a, b):
4340 """multiply multiplies two operands.
4341
4342 If either operand is a special value then the general rules apply.
4343 Otherwise, the operands are multiplied together ('long multiplication'),
4344 resulting in a number which may be as long as the sum of the lengths
4345 of the two operands.
4346
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004347 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004348 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004349 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004350 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004351 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004352 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004353 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004354 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004355 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004356 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004357 """
4358 return a.__mul__(b, context=self)
4359
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004360 def next_minus(self, a):
4361 """Returns the largest representable number smaller than a.
4362
4363 >>> c = ExtendedContext.copy()
4364 >>> c.Emin = -999
4365 >>> c.Emax = 999
4366 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004367 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004368 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004369 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004370 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004371 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004372 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004373 Decimal('9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374 """
4375 return a.next_minus(context=self)
4376
4377 def next_plus(self, a):
4378 """Returns the smallest representable number larger than a.
4379
4380 >>> c = ExtendedContext.copy()
4381 >>> c.Emin = -999
4382 >>> c.Emax = 999
4383 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004384 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004386 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004387 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004388 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004390 Decimal('-9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004391 """
4392 return a.next_plus(context=self)
4393
4394 def next_toward(self, a, b):
4395 """Returns the number closest to a, in direction towards b.
4396
4397 The result is the closest representable number from the first
4398 operand (but not the first operand) that is in the direction
4399 towards the second operand, unless the operands have the same
4400 value.
4401
4402 >>> c = ExtendedContext.copy()
4403 >>> c.Emin = -999
4404 >>> c.Emax = 999
4405 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004406 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004407 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004408 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004410 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004411 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004412 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004413 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004414 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004415 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004416 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004417 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004418 Decimal('-0.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004419 """
4420 return a.next_toward(b, context=self)
4421
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004422 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004423 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004424
4425 Essentially a plus operation with all trailing zeros removed from the
4426 result.
4427
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004428 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004429 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004430 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004431 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004432 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004433 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004434 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004435 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004436 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004437 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004438 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004439 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004440 """
4441 return a.normalize(context=self)
4442
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 def number_class(self, a):
4444 """Returns an indication of the class of the operand.
4445
4446 The class is one of the following strings:
4447 -sNaN
4448 -NaN
4449 -Infinity
4450 -Normal
4451 -Subnormal
4452 -Zero
4453 +Zero
4454 +Subnormal
4455 +Normal
4456 +Infinity
4457
4458 >>> c = Context(ExtendedContext)
4459 >>> c.Emin = -999
4460 >>> c.Emax = 999
4461 >>> c.number_class(Decimal('Infinity'))
4462 '+Infinity'
4463 >>> c.number_class(Decimal('1E-10'))
4464 '+Normal'
4465 >>> c.number_class(Decimal('2.50'))
4466 '+Normal'
4467 >>> c.number_class(Decimal('0.1E-999'))
4468 '+Subnormal'
4469 >>> c.number_class(Decimal('0'))
4470 '+Zero'
4471 >>> c.number_class(Decimal('-0'))
4472 '-Zero'
4473 >>> c.number_class(Decimal('-0.1E-999'))
4474 '-Subnormal'
4475 >>> c.number_class(Decimal('-1E-10'))
4476 '-Normal'
4477 >>> c.number_class(Decimal('-2.50'))
4478 '-Normal'
4479 >>> c.number_class(Decimal('-Infinity'))
4480 '-Infinity'
4481 >>> c.number_class(Decimal('NaN'))
4482 'NaN'
4483 >>> c.number_class(Decimal('-NaN'))
4484 'NaN'
4485 >>> c.number_class(Decimal('sNaN'))
4486 'sNaN'
4487 """
4488 return a.number_class(context=self)
4489
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004490 def plus(self, a):
4491 """Plus corresponds to unary prefix plus in Python.
4492
4493 The operation is evaluated using the same rules as add; the
4494 operation plus(a) is calculated as add('0', a) where the '0'
4495 has the same exponent as the operand.
4496
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004497 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004498 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004499 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004500 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004501 """
4502 return a.__pos__(context=self)
4503
4504 def power(self, a, b, modulo=None):
4505 """Raises a to the power of b, to modulo if given.
4506
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004507 With two arguments, compute a**b. If a is negative then b
4508 must be integral. The result will be inexact unless b is
4509 integral and the result is finite and can be expressed exactly
4510 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004511
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004512 With three arguments, compute (a**b) % modulo. For the
4513 three argument form, the following restrictions on the
4514 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004515
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004516 - all three arguments must be integral
4517 - b must be nonnegative
4518 - at least one of a or b must be nonzero
4519 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004520
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004521 The result of pow(a, b, modulo) is identical to the result
4522 that would be obtained by computing (a**b) % modulo with
4523 unbounded precision, but is computed more efficiently. It is
4524 always exact.
4525
4526 >>> c = ExtendedContext.copy()
4527 >>> c.Emin = -999
4528 >>> c.Emax = 999
4529 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004530 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004531 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004532 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004533 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004534 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004535 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004536 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004537 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004538 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004539 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004540 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004541 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004542 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004543 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004544 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004545 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004546 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004547 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004548 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004549 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004550 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004551 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004552 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004553 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004554 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004555
4556 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004557 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004558 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004559 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004560 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004561 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004562 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004563 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004564 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004565 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004566 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004567 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004568 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004569 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004570 """
4571 return a.__pow__(b, modulo, context=self)
4572
4573 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004574 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004575
4576 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00004577 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004578 exponent is being increased), multiplied by a positive power of ten (if
4579 the exponent is being decreased), or is unchanged (if the exponent is
4580 already equal to that of the right-hand operand).
4581
4582 Unlike other operations, if the length of the coefficient after the
4583 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00004584 operation condition is raised. This guarantees that, unless there is
4585 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004586 equal to that of the right-hand operand.
4587
4588 Also unlike other operations, quantize will never raise Underflow, even
4589 if the result is subnormal and inexact.
4590
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004591 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004592 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004593 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004594 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004595 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004596 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004597 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004598 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004599 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004600 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004601 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004602 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004603 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004604 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004605 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004606 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004607 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004608 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004609 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004610 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004611 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004612 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004613 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004614 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004615 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004616 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004617 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004618 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004619 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004620 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004621 """
4622 return a.quantize(b, context=self)
4623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004624 def radix(self):
4625 """Just returns 10, as this is Decimal, :)
4626
4627 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 """
4630 return Decimal(10)
4631
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004632 def remainder(self, a, b):
4633 """Returns the remainder from integer division.
4634
4635 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00004636 calculating integer division as described for divide-integer, rounded
4637 to precision digits if necessary. The sign of the result, if
4638 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004639
4640 This operation will fail under the same conditions as integer division
4641 (that is, if integer division on the same two operands would fail, the
4642 remainder cannot be calculated).
4643
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004644 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004645 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004646 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004647 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004648 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004650 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004652 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004654 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004656 """
4657 return a.__mod__(b, context=self)
4658
4659 def remainder_near(self, a, b):
4660 """Returns to be "a - b * n", where n is the integer nearest the exact
4661 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00004662 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004663 sign of a.
4664
4665 This operation will fail under the same conditions as integer division
4666 (that is, if integer division on the same two operands would fail, the
4667 remainder cannot be calculated).
4668
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004669 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004670 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004671 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004672 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004677 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004679 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004680 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004681 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004682 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004683 """
4684 return a.remainder_near(b, context=self)
4685
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004686 def rotate(self, a, b):
4687 """Returns a rotated copy of a, b times.
4688
4689 The coefficient of the result is a rotated copy of the digits in
4690 the coefficient of the first operand. The number of places of
4691 rotation is taken from the absolute value of the second operand,
4692 with the rotation being to the left if the second operand is
4693 positive or to the right otherwise.
4694
4695 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004696 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004697 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004698 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004699 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004700 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004701 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004702 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004703 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004704 Decimal('345678912')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004705 """
4706 return a.rotate(b, context=self)
4707
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004708 def same_quantum(self, a, b):
4709 """Returns True if the two operands have the same exponent.
4710
4711 The result is never affected by either the sign or the coefficient of
4712 either operand.
4713
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004714 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004715 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004716 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004717 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004718 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004719 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004720 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004721 True
4722 """
4723 return a.same_quantum(b)
4724
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004725 def scaleb (self, a, b):
4726 """Returns the first operand after adding the second value its exp.
4727
4728 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004729 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004730 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004731 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004732 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004733 Decimal('7.50E+3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004734 """
4735 return a.scaleb (b, context=self)
4736
4737 def shift(self, a, b):
4738 """Returns a shifted copy of a, b times.
4739
4740 The coefficient of the result is a shifted copy of the digits
4741 in the coefficient of the first operand. The number of places
4742 to shift is taken from the absolute value of the second operand,
4743 with the shift being to the left if the second operand is
4744 positive or to the right otherwise. Digits shifted into the
4745 coefficient are zeros.
4746
4747 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004748 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004749 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004750 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004751 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004752 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004753 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004754 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004755 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004756 Decimal('345678900')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004757 """
4758 return a.shift(b, context=self)
4759
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004760 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004761 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004762
4763 If the result must be inexact, it is rounded using the round-half-even
4764 algorithm.
4765
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004766 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004767 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004768 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004769 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004770 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004771 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004772 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004773 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004774 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004775 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004776 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004777 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004778 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004779 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004780 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004781 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004782 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004783 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004784 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004785 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004786 """
4787 return a.sqrt(context=self)
4788
4789 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004790 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004791
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004792 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004793 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004794 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004795 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004796 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004797 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004798 """
4799 return a.__sub__(b, context=self)
4800
4801 def to_eng_string(self, a):
4802 """Converts a number to a string, using scientific notation.
4803
4804 The operation is not affected by the context.
4805 """
4806 return a.to_eng_string(context=self)
4807
4808 def to_sci_string(self, a):
4809 """Converts a number to a string, using scientific notation.
4810
4811 The operation is not affected by the context.
4812 """
4813 return a.__str__(context=self)
4814
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004815 def to_integral_exact(self, a):
4816 """Rounds to an integer.
4817
4818 When the operand has a negative exponent, the result is the same
4819 as using the quantize() operation using the given operand as the
4820 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4821 of the operand as the precision setting; Inexact and Rounded flags
4822 are allowed in this operation. The rounding mode is taken from the
4823 context.
4824
4825 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004826 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004827 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004828 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004829 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004830 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004831 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004832 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004833 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004834 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004835 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004836 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004837 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004838 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004839 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004840 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004841 """
4842 return a.to_integral_exact(context=self)
4843
4844 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004845 """Rounds to an integer.
4846
4847 When the operand has a negative exponent, the result is the same
4848 as using the quantize() operation using the given operand as the
4849 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4850 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00004851 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004852
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004853 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004854 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004855 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004856 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004857 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004858 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004859 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004860 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004861 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004862 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004863 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004864 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004865 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004866 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004867 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004868 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004869 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004870 return a.to_integral_value(context=self)
4871
4872 # the method name changed, but we provide also the old one, for compatibility
4873 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004874
4875class _WorkRep(object):
4876 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004877 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004878 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004879 # exp: None, int, or string
4880
4881 def __init__(self, value=None):
4882 if value is None:
4883 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004884 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004885 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004886 elif isinstance(value, Decimal):
4887 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00004888 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004889 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004890 else:
4891 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004892 self.sign = value[0]
4893 self.int = value[1]
4894 self.exp = value[2]
4895
4896 def __repr__(self):
4897 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4898
4899 __str__ = __repr__
4900
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004901
4902
Christian Heimes2c181612007-12-17 20:04:13 +00004903def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004904 """Normalizes op1, op2 to have the same exp and length of coefficient.
4905
4906 Done during addition.
4907 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004908 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004909 tmp = op2
4910 other = op1
4911 else:
4912 tmp = op1
4913 other = op2
4914
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004915 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4916 # Then adding 10**exp to tmp has the same effect (after rounding)
4917 # as adding any positive quantity smaller than 10**exp; similarly
4918 # for subtraction. So if other is smaller than 10**exp we replace
4919 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00004920 tmp_len = len(str(tmp.int))
4921 other_len = len(str(other.int))
4922 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4923 if other_len + other.exp - 1 < exp:
4924 other.int = 1
4925 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004926
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004927 tmp.int *= 10 ** (tmp.exp - other.exp)
4928 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004929 return op1, op2
4930
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004931##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004932
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004933# This function from Tim Peters was taken from here:
4934# http://mail.python.org/pipermail/python-list/1999-July/007758.html
4935# The correction being in the function definition is for speed, and
4936# the whole function is not resolved with math.log because of avoiding
4937# the use of floats.
4938def _nbits(n, correction = {
4939 '0': 4, '1': 3, '2': 2, '3': 2,
4940 '4': 1, '5': 1, '6': 1, '7': 1,
4941 '8': 0, '9': 0, 'a': 0, 'b': 0,
4942 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
4943 """Number of bits in binary representation of the positive integer n,
4944 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004945 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004946 if n < 0:
4947 raise ValueError("The argument to _nbits should be nonnegative.")
4948 hex_n = "%x" % n
4949 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004950
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004951def _sqrt_nearest(n, a):
4952 """Closest integer to the square root of the positive integer n. a is
4953 an initial approximation to the square root. Any positive integer
4954 will do for a, but the closer a is to the square root of n the
4955 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004956
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004957 """
4958 if n <= 0 or a <= 0:
4959 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
4960
4961 b=0
4962 while a != b:
4963 b, a = a, a--n//a>>1
4964 return a
4965
4966def _rshift_nearest(x, shift):
4967 """Given an integer x and a nonnegative integer shift, return closest
4968 integer to x / 2**shift; use round-to-even in case of a tie.
4969
4970 """
4971 b, q = 1 << shift, x >> shift
4972 return q + (2*(x & (b-1)) + (q&1) > b)
4973
4974def _div_nearest(a, b):
4975 """Closest integer to a/b, a and b positive integers; rounds to even
4976 in the case of a tie.
4977
4978 """
4979 q, r = divmod(a, b)
4980 return q + (2*r + (q&1) > b)
4981
4982def _ilog(x, M, L = 8):
4983 """Integer approximation to M*log(x/M), with absolute error boundable
4984 in terms only of x/M.
4985
4986 Given positive integers x and M, return an integer approximation to
4987 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
4988 between the approximation and the exact result is at most 22. For
4989 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
4990 both cases these are upper bounds on the error; it will usually be
4991 much smaller."""
4992
4993 # The basic algorithm is the following: let log1p be the function
4994 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
4995 # the reduction
4996 #
4997 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
4998 #
4999 # repeatedly until the argument to log1p is small (< 2**-L in
5000 # absolute value). For small y we can use the Taylor series
5001 # expansion
5002 #
5003 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5004 #
5005 # truncating at T such that y**T is small enough. The whole
5006 # computation is carried out in a form of fixed-point arithmetic,
5007 # with a real number z being represented by an integer
5008 # approximation to z*M. To avoid loss of precision, the y below
5009 # is actually an integer approximation to 2**R*y*M, where R is the
5010 # number of reductions performed so far.
5011
5012 y = x-M
5013 # argument reduction; R = number of reductions performed
5014 R = 0
5015 while (R <= L and abs(y) << L-R >= M or
5016 R > L and abs(y) >> R-L >= M):
5017 y = _div_nearest((M*y) << 1,
5018 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5019 R += 1
5020
5021 # Taylor series with T terms
5022 T = -int(-10*len(str(M))//(3*L))
5023 yshift = _rshift_nearest(y, R)
5024 w = _div_nearest(M, T)
5025 for k in range(T-1, 0, -1):
5026 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5027
5028 return _div_nearest(w*y, M)
5029
5030def _dlog10(c, e, p):
5031 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5032 approximation to 10**p * log10(c*10**e), with an absolute error of
5033 at most 1. Assumes that c*10**e is not exactly 1."""
5034
5035 # increase precision by 2; compensate for this by dividing
5036 # final result by 100
5037 p += 2
5038
5039 # write c*10**e as d*10**f with either:
5040 # f >= 0 and 1 <= d <= 10, or
5041 # f <= 0 and 0.1 <= d <= 1.
5042 # Thus for c*10**e close to 1, f = 0
5043 l = len(str(c))
5044 f = e+l - (e+l >= 1)
5045
5046 if p > 0:
5047 M = 10**p
5048 k = e+p-f
5049 if k >= 0:
5050 c *= 10**k
5051 else:
5052 c = _div_nearest(c, 10**-k)
5053
5054 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005055 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005056 log_d = _div_nearest(log_d*M, log_10)
5057 log_tenpower = f*M # exact
5058 else:
5059 log_d = 0 # error < 2.31
5060 log_tenpower = div_nearest(f, 10**-p) # error < 0.5
5061
5062 return _div_nearest(log_tenpower+log_d, 100)
5063
5064def _dlog(c, e, p):
5065 """Given integers c, e and p with c > 0, compute an integer
5066 approximation to 10**p * log(c*10**e), with an absolute error of
5067 at most 1. Assumes that c*10**e is not exactly 1."""
5068
5069 # Increase precision by 2. The precision increase is compensated
5070 # for at the end with a division by 100.
5071 p += 2
5072
5073 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5074 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5075 # as 10**p * log(d) + 10**p*f * log(10).
5076 l = len(str(c))
5077 f = e+l - (e+l >= 1)
5078
5079 # compute approximation to 10**p*log(d), with error < 27
5080 if p > 0:
5081 k = e+p-f
5082 if k >= 0:
5083 c *= 10**k
5084 else:
5085 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5086
5087 # _ilog magnifies existing error in c by a factor of at most 10
5088 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5089 else:
5090 # p <= 0: just approximate the whole thing by 0; error < 2.31
5091 log_d = 0
5092
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005093 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005094 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005095 extra = len(str(abs(f)))-1
5096 if p + extra >= 0:
5097 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5098 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5099 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005100 else:
5101 f_log_ten = 0
5102 else:
5103 f_log_ten = 0
5104
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005105 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005106 return _div_nearest(f_log_ten + log_d, 100)
5107
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005108class _Log10Memoize(object):
5109 """Class to compute, store, and allow retrieval of, digits of the
5110 constant log(10) = 2.302585.... This constant is needed by
5111 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5112 def __init__(self):
5113 self.digits = "23025850929940456840179914546843642076011014886"
5114
5115 def getdigits(self, p):
5116 """Given an integer p >= 0, return floor(10**p)*log(10).
5117
5118 For example, self.getdigits(3) returns 2302.
5119 """
5120 # digits are stored as a string, for quick conversion to
5121 # integer in the case that we've already computed enough
5122 # digits; the stored digits should always be correct
5123 # (truncated, not rounded to nearest).
5124 if p < 0:
5125 raise ValueError("p should be nonnegative")
5126
5127 if p >= len(self.digits):
5128 # compute p+3, p+6, p+9, ... digits; continue until at
5129 # least one of the extra digits is nonzero
5130 extra = 3
5131 while True:
5132 # compute p+extra digits, correct to within 1ulp
5133 M = 10**(p+extra+2)
5134 digits = str(_div_nearest(_ilog(10*M, M), 100))
5135 if digits[-extra:] != '0'*extra:
5136 break
5137 extra += 3
5138 # keep all reliable digits so far; remove trailing zeros
5139 # and next nonzero digit
5140 self.digits = digits.rstrip('0')[:-1]
5141 return int(self.digits[:p+1])
5142
5143_log10_digits = _Log10Memoize().getdigits
5144
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005145def _iexp(x, M, L=8):
5146 """Given integers x and M, M > 0, such that x/M is small in absolute
5147 value, compute an integer approximation to M*exp(x/M). For 0 <=
5148 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5149 is usually much smaller)."""
5150
5151 # Algorithm: to compute exp(z) for a real number z, first divide z
5152 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5153 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5154 # series
5155 #
5156 # expm1(x) = x + x**2/2! + x**3/3! + ...
5157 #
5158 # Now use the identity
5159 #
5160 # expm1(2x) = expm1(x)*(expm1(x)+2)
5161 #
5162 # R times to compute the sequence expm1(z/2**R),
5163 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5164
5165 # Find R such that x/2**R/M <= 2**-L
5166 R = _nbits((x<<L)//M)
5167
5168 # Taylor series. (2**L)**T > M
5169 T = -int(-10*len(str(M))//(3*L))
5170 y = _div_nearest(x, T)
5171 Mshift = M<<R
5172 for i in range(T-1, 0, -1):
5173 y = _div_nearest(x*(Mshift + y), Mshift * i)
5174
5175 # Expansion
5176 for k in range(R-1, -1, -1):
5177 Mshift = M<<(k+2)
5178 y = _div_nearest(y*(y+Mshift), Mshift)
5179
5180 return M+y
5181
5182def _dexp(c, e, p):
5183 """Compute an approximation to exp(c*10**e), with p decimal places of
5184 precision.
5185
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005186 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005187
5188 10**(p-1) <= d <= 10**p, and
5189 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5190
5191 In other words, d*10**f is an approximation to exp(c*10**e) with p
5192 digits of precision, and with an error in d of at most 1. This is
5193 almost, but not quite, the same as the error being < 1ulp: when d
5194 = 10**(p-1) the error could be up to 10 ulp."""
5195
5196 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5197 p += 2
5198
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005199 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005200 extra = max(0, e + len(str(c)) - 1)
5201 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005202
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005203 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005204 # rounding down
5205 shift = e+q
5206 if shift >= 0:
5207 cshift = c*10**shift
5208 else:
5209 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005210 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005211
5212 # reduce remainder back to original precision
5213 rem = _div_nearest(rem, 10**extra)
5214
5215 # error in result of _iexp < 120; error after division < 0.62
5216 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5217
5218def _dpower(xc, xe, yc, ye, p):
5219 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5220 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5221
5222 10**(p-1) <= c <= 10**p, and
5223 (c-1)*10**e < x**y < (c+1)*10**e
5224
5225 in other words, c*10**e is an approximation to x**y with p digits
5226 of precision, and with an error in c of at most 1. (This is
5227 almost, but not quite, the same as the error being < 1ulp: when c
5228 == 10**(p-1) we can only guarantee error < 10ulp.)
5229
5230 We assume that: x is positive and not equal to 1, and y is nonzero.
5231 """
5232
5233 # Find b such that 10**(b-1) <= |y| <= 10**b
5234 b = len(str(abs(yc))) + ye
5235
5236 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5237 lxc = _dlog(xc, xe, p+b+1)
5238
5239 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5240 shift = ye-b
5241 if shift >= 0:
5242 pc = lxc*yc*10**shift
5243 else:
5244 pc = _div_nearest(lxc*yc, 10**-shift)
5245
5246 if pc == 0:
5247 # we prefer a result that isn't exactly 1; this makes it
5248 # easier to compute a correctly rounded result in __pow__
5249 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5250 coeff, exp = 10**(p-1)+1, 1-p
5251 else:
5252 coeff, exp = 10**p-1, -p
5253 else:
5254 coeff, exp = _dexp(pc, -(p+1), p+1)
5255 coeff = _div_nearest(coeff, 10)
5256 exp += 1
5257
5258 return coeff, exp
5259
5260def _log10_lb(c, correction = {
5261 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5262 '6': 23, '7': 16, '8': 10, '9': 5}):
5263 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5264 if c <= 0:
5265 raise ValueError("The argument to _log10_lb should be nonnegative.")
5266 str_c = str(c)
5267 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005268
Guido van Rossumd8faa362007-04-27 19:54:29 +00005269##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005270
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005271def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005272 """Convert other to Decimal.
5273
5274 Verifies that it's ok to use in an implicit construction.
5275 """
5276 if isinstance(other, Decimal):
5277 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005278 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005279 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005280 if raiseit:
5281 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005282 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005283
Guido van Rossumd8faa362007-04-27 19:54:29 +00005284##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005285
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005286# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005287# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005288
5289DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005290 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005291 traps=[DivisionByZero, Overflow, InvalidOperation],
5292 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005293 Emax=999999999,
5294 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005295 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005296)
5297
5298# Pre-made alternate contexts offered by the specification
5299# Don't change these; the user should be able to select these
5300# contexts and be able to reproduce results from other implementations
5301# of the spec.
5302
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005303BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005304 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005305 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5306 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307)
5308
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005309ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005310 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005311 traps=[],
5312 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005313)
5314
5315
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005316##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005317#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005318# Regular expression used for parsing numeric strings. Additional
5319# comments:
5320#
5321# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5322# whitespace. But note that the specification disallows whitespace in
5323# a numeric string.
5324#
5325# 2. For finite numbers (not infinities and NaNs) the body of the
5326# number between the optional sign and the optional exponent must have
5327# at least one decimal digit, possibly after the decimal point. The
5328# lookahead expression '(?=\d|\.\d)' checks this.
5329#
5330# As the flag UNICODE is not enabled here, we're explicitly avoiding any
5331# other meaning for \d than the numbers [0-9].
5332
5333import re
5334_parser = re.compile(r""" # A numeric string consists of:
5335# \s*
5336 (?P<sign>[-+])? # an optional sign, followed by either...
5337 (
5338 (?=\d|\.\d) # ...a number (with at least one digit)
5339 (?P<int>\d*) # consisting of a (possibly empty) integer part
5340 (\.(?P<frac>\d*))? # followed by an optional fractional part
5341 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
5342 |
5343 Inf(inity)? # ...an infinity, or...
5344 |
5345 (?P<signal>s)? # ...an (optionally signaling)
5346 NaN # NaN
5347 (?P<diag>\d*) # with (possibly empty) diagnostic information.
5348 )
5349# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005350 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005351""", re.VERBOSE | re.IGNORECASE).match
5352
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005353_all_zeros = re.compile('0*$').match
5354_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005355
5356##### PEP3101 support functions ##############################################
5357# The functions parse_format_specifier and format_align have little to do
5358# with the Decimal class, and could potentially be reused for other pure
5359# Python numeric classes that want to implement __format__
5360#
5361# A format specifier for Decimal looks like:
5362#
5363# [[fill]align][sign][0][minimumwidth][.precision][type]
5364#
5365
5366_parse_format_specifier_regex = re.compile(r"""\A
5367(?:
5368 (?P<fill>.)?
5369 (?P<align>[<>=^])
5370)?
5371(?P<sign>[-+ ])?
5372(?P<zeropad>0)?
5373(?P<minimumwidth>(?!0)\d+)?
5374(?:\.(?P<precision>0|(?!0)\d+))?
5375(?P<type>[eEfFgG%])?
5376\Z
5377""", re.VERBOSE)
5378
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005379del re
5380
Christian Heimesf16baeb2008-02-29 14:57:44 +00005381def _parse_format_specifier(format_spec):
5382 """Parse and validate a format specifier.
5383
5384 Turns a standard numeric format specifier into a dict, with the
5385 following entries:
5386
5387 fill: fill character to pad field to minimum width
5388 align: alignment type, either '<', '>', '=' or '^'
5389 sign: either '+', '-' or ' '
5390 minimumwidth: nonnegative integer giving minimum width
5391 precision: nonnegative integer giving precision, or None
5392 type: one of the characters 'eEfFgG%', or None
5393 unicode: either True or False (always True for Python 3.x)
5394
5395 """
5396 m = _parse_format_specifier_regex.match(format_spec)
5397 if m is None:
5398 raise ValueError("Invalid format specifier: " + format_spec)
5399
5400 # get the dictionary
5401 format_dict = m.groupdict()
5402
5403 # defaults for fill and alignment
5404 fill = format_dict['fill']
5405 align = format_dict['align']
5406 if format_dict.pop('zeropad') is not None:
5407 # in the face of conflict, refuse the temptation to guess
5408 if fill is not None and fill != '0':
5409 raise ValueError("Fill character conflicts with '0'"
5410 " in format specifier: " + format_spec)
5411 if align is not None and align != '=':
5412 raise ValueError("Alignment conflicts with '0' in "
5413 "format specifier: " + format_spec)
5414 fill = '0'
5415 align = '='
5416 format_dict['fill'] = fill or ' '
5417 format_dict['align'] = align or '<'
5418
5419 if format_dict['sign'] is None:
5420 format_dict['sign'] = '-'
5421
5422 # turn minimumwidth and precision entries into integers.
5423 # minimumwidth defaults to 0; precision remains None if not given
5424 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5425 if format_dict['precision'] is not None:
5426 format_dict['precision'] = int(format_dict['precision'])
5427
5428 # if format type is 'g' or 'G' then a precision of 0 makes little
5429 # sense; convert it to 1. Same if format type is unspecified.
5430 if format_dict['precision'] == 0:
5431 if format_dict['type'] in 'gG' or format_dict['type'] is None:
5432 format_dict['precision'] = 1
5433
5434 # record whether return type should be str or unicode
Christian Heimes295f4fa2008-02-29 15:03:39 +00005435 format_dict['unicode'] = True
Christian Heimesf16baeb2008-02-29 14:57:44 +00005436
5437 return format_dict
5438
5439def _format_align(body, spec_dict):
5440 """Given an unpadded, non-aligned numeric string, add padding and
5441 aligment to conform with the given format specifier dictionary (as
5442 output from parse_format_specifier).
5443
5444 It's assumed that if body is negative then it starts with '-'.
5445 Any leading sign ('-' or '+') is stripped from the body before
5446 applying the alignment and padding rules, and replaced in the
5447 appropriate position.
5448
5449 """
5450 # figure out the sign; we only examine the first character, so if
5451 # body has leading whitespace the results may be surprising.
5452 if len(body) > 0 and body[0] in '-+':
5453 sign = body[0]
5454 body = body[1:]
5455 else:
5456 sign = ''
5457
5458 if sign != '-':
5459 if spec_dict['sign'] in ' +':
5460 sign = spec_dict['sign']
5461 else:
5462 sign = ''
5463
5464 # how much extra space do we have to play with?
5465 minimumwidth = spec_dict['minimumwidth']
5466 fill = spec_dict['fill']
5467 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5468
5469 align = spec_dict['align']
5470 if align == '<':
5471 result = padding + sign + body
5472 elif align == '>':
5473 result = sign + body + padding
5474 elif align == '=':
5475 result = sign + padding + body
5476 else: #align == '^'
5477 half = len(padding)//2
5478 result = padding[:half] + sign + body + padding[half:]
5479
Christian Heimesf16baeb2008-02-29 14:57:44 +00005480 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005481
Guido van Rossumd8faa362007-04-27 19:54:29 +00005482##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005483
Guido van Rossumd8faa362007-04-27 19:54:29 +00005484# Reusable defaults
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005485Inf = Decimal('Inf')
5486negInf = Decimal('-Inf')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005487NaN = Decimal('NaN')
5488Dec_0 = Decimal(0)
5489Dec_p1 = Decimal(1)
5490Dec_n1 = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005491
Guido van Rossumd8faa362007-04-27 19:54:29 +00005492# Infsign[sign] is infinity w/ that sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005493Infsign = (Inf, negInf)
5494
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005495
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005496
5497if __name__ == '__main__':
5498 import doctest, sys
5499 doctest.testmod(sys.modules[__name__])