blob: 6706402e4dd5d187c211aff1b89f20e0bc84e680 [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
Guido van Rossuma13f4a12007-12-10 20:04:04 +0000507class Decimal(_numbers.Real, _numbers.Inexact):
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
Christian Heimes9e7f1d22008-02-28 12:27:11 +00001652 def __round__(self):
1653 return self._round_down(0)
1654
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001655 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001656 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001657 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001658
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001659 def _round_half_up(self, prec):
1660 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001661 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001662 return 1
1663 elif _all_zeros(self._int, prec):
1664 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001665 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001666 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001667
1668 def _round_half_down(self, prec):
1669 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001670 if _exact_half(self._int, prec):
1671 return -1
1672 else:
1673 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001674
1675 def _round_half_even(self, prec):
1676 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001677 if _exact_half(self._int, prec) and \
1678 (prec == 0 or self._int[prec-1] in '02468'):
1679 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001680 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001681 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001682
1683 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684 """Rounds up (not away from 0 if negative.)"""
1685 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001686 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001687 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001688 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001689
Christian Heimes9e7f1d22008-02-28 12:27:11 +00001690 def __ceil__(self):
1691 return self._round_ceiling(0)
1692
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001693 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001694 """Rounds down (not towards 0 if negative)"""
1695 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001696 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001697 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001698 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001699
Christian Heimes9e7f1d22008-02-28 12:27:11 +00001700 def __floor__(self):
1701 return self._round_floor(0)
1702
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001703 def _round_05up(self, prec):
1704 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001705 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001706 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001707 else:
1708 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001709
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001710 def fma(self, other, third, context=None):
1711 """Fused multiply-add.
1712
1713 Returns self*other+third with no rounding of the intermediate
1714 product self*other.
1715
1716 self and other are multiplied together, with no rounding of
1717 the result. The third operand is then added to the result,
1718 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001719 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001720
1721 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001722
1723 # compute product; raise InvalidOperation if either operand is
1724 # a signaling NaN or if the product is zero times infinity.
1725 if self._is_special or other._is_special:
1726 if context is None:
1727 context = getcontext()
1728 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001729 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001730 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001731 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001732 if self._exp == 'n':
1733 product = self
1734 elif other._exp == 'n':
1735 product = other
1736 elif self._exp == 'F':
1737 if not other:
1738 return context._raise_error(InvalidOperation,
1739 'INF * 0 in fma')
1740 product = Infsign[self._sign ^ other._sign]
1741 elif other._exp == 'F':
1742 if not self:
1743 return context._raise_error(InvalidOperation,
1744 '0 * INF in fma')
1745 product = Infsign[self._sign ^ other._sign]
1746 else:
1747 product = _dec_from_triple(self._sign ^ other._sign,
1748 str(int(self._int) * int(other._int)),
1749 self._exp + other._exp)
1750
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001751 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001752 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001753
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001754 def _power_modulo(self, other, modulo, context=None):
1755 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001756
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001757 # if can't convert other and modulo to Decimal, raise
1758 # TypeError; there's no point returning NotImplemented (no
1759 # equivalent of __rpow__ for three argument pow)
1760 other = _convert_other(other, raiseit=True)
1761 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001762
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001763 if context is None:
1764 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001766 # deal with NaNs: if there are any sNaNs then first one wins,
1767 # (i.e. behaviour for NaNs is identical to that of fma)
1768 self_is_nan = self._isnan()
1769 other_is_nan = other._isnan()
1770 modulo_is_nan = modulo._isnan()
1771 if self_is_nan or other_is_nan or modulo_is_nan:
1772 if self_is_nan == 2:
1773 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001774 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001775 if other_is_nan == 2:
1776 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001777 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001778 if modulo_is_nan == 2:
1779 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001780 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001781 if self_is_nan:
1782 return self._fix_nan(context)
1783 if other_is_nan:
1784 return other._fix_nan(context)
1785 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001786
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001787 # check inputs: we apply same restrictions as Python's pow()
1788 if not (self._isinteger() and
1789 other._isinteger() and
1790 modulo._isinteger()):
1791 return context._raise_error(InvalidOperation,
1792 'pow() 3rd argument not allowed '
1793 'unless all arguments are integers')
1794 if other < 0:
1795 return context._raise_error(InvalidOperation,
1796 'pow() 2nd argument cannot be '
1797 'negative when 3rd argument specified')
1798 if not modulo:
1799 return context._raise_error(InvalidOperation,
1800 'pow() 3rd argument cannot be 0')
1801
1802 # additional restriction for decimal: the modulus must be less
1803 # than 10**prec in absolute value
1804 if modulo.adjusted() >= context.prec:
1805 return context._raise_error(InvalidOperation,
1806 'insufficient precision: pow() 3rd '
1807 'argument must not have more than '
1808 'precision digits')
1809
1810 # define 0**0 == NaN, for consistency with two-argument pow
1811 # (even though it hurts!)
1812 if not other and not self:
1813 return context._raise_error(InvalidOperation,
1814 'at least one of pow() 1st argument '
1815 'and 2nd argument must be nonzero ;'
1816 '0**0 is not defined')
1817
1818 # compute sign of result
1819 if other._iseven():
1820 sign = 0
1821 else:
1822 sign = self._sign
1823
1824 # convert modulo to a Python integer, and self and other to
1825 # Decimal integers (i.e. force their exponents to be >= 0)
1826 modulo = abs(int(modulo))
1827 base = _WorkRep(self.to_integral_value())
1828 exponent = _WorkRep(other.to_integral_value())
1829
1830 # compute result using integer pow()
1831 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1832 for i in range(exponent.exp):
1833 base = pow(base, 10, modulo)
1834 base = pow(base, exponent.int, modulo)
1835
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001836 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001837
1838 def _power_exact(self, other, p):
1839 """Attempt to compute self**other exactly.
1840
1841 Given Decimals self and other and an integer p, attempt to
1842 compute an exact result for the power self**other, with p
1843 digits of precision. Return None if self**other is not
1844 exactly representable in p digits.
1845
1846 Assumes that elimination of special cases has already been
1847 performed: self and other must both be nonspecial; self must
1848 be positive and not numerically equal to 1; other must be
1849 nonzero. For efficiency, other._exp should not be too large,
1850 so that 10**abs(other._exp) is a feasible calculation."""
1851
1852 # In the comments below, we write x for the value of self and
1853 # y for the value of other. Write x = xc*10**xe and y =
1854 # yc*10**ye.
1855
1856 # The main purpose of this method is to identify the *failure*
1857 # of x**y to be exactly representable with as little effort as
1858 # possible. So we look for cheap and easy tests that
1859 # eliminate the possibility of x**y being exact. Only if all
1860 # these tests are passed do we go on to actually compute x**y.
1861
1862 # Here's the main idea. First normalize both x and y. We
1863 # express y as a rational m/n, with m and n relatively prime
1864 # and n>0. Then for x**y to be exactly representable (at
1865 # *any* precision), xc must be the nth power of a positive
1866 # integer and xe must be divisible by n. If m is negative
1867 # then additionally xc must be a power of either 2 or 5, hence
1868 # a power of 2**n or 5**n.
1869 #
1870 # There's a limit to how small |y| can be: if y=m/n as above
1871 # then:
1872 #
1873 # (1) if xc != 1 then for the result to be representable we
1874 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1875 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1876 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1877 # representable.
1878 #
1879 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1880 # |y| < 1/|xe| then the result is not representable.
1881 #
1882 # Note that since x is not equal to 1, at least one of (1) and
1883 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1884 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1885 #
1886 # There's also a limit to how large y can be, at least if it's
1887 # positive: the normalized result will have coefficient xc**y,
1888 # so if it's representable then xc**y < 10**p, and y <
1889 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1890 # not exactly representable.
1891
1892 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1893 # so |y| < 1/xe and the result is not representable.
1894 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1895 # < 1/nbits(xc).
1896
1897 x = _WorkRep(self)
1898 xc, xe = x.int, x.exp
1899 while xc % 10 == 0:
1900 xc //= 10
1901 xe += 1
1902
1903 y = _WorkRep(other)
1904 yc, ye = y.int, y.exp
1905 while yc % 10 == 0:
1906 yc //= 10
1907 ye += 1
1908
1909 # case where xc == 1: result is 10**(xe*y), with xe*y
1910 # required to be an integer
1911 if xc == 1:
1912 if ye >= 0:
1913 exponent = xe*yc*10**ye
1914 else:
1915 exponent, remainder = divmod(xe*yc, 10**-ye)
1916 if remainder:
1917 return None
1918 if y.sign == 1:
1919 exponent = -exponent
1920 # if other is a nonnegative integer, use ideal exponent
1921 if other._isinteger() and other._sign == 0:
1922 ideal_exponent = self._exp*int(other)
1923 zeros = min(exponent-ideal_exponent, p-1)
1924 else:
1925 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001926 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001927
1928 # case where y is negative: xc must be either a power
1929 # of 2 or a power of 5.
1930 if y.sign == 1:
1931 last_digit = xc % 10
1932 if last_digit in (2,4,6,8):
1933 # quick test for power of 2
1934 if xc & -xc != xc:
1935 return None
1936 # now xc is a power of 2; e is its exponent
1937 e = _nbits(xc)-1
1938 # find e*y and xe*y; both must be integers
1939 if ye >= 0:
1940 y_as_int = yc*10**ye
1941 e = e*y_as_int
1942 xe = xe*y_as_int
1943 else:
1944 ten_pow = 10**-ye
1945 e, remainder = divmod(e*yc, ten_pow)
1946 if remainder:
1947 return None
1948 xe, remainder = divmod(xe*yc, ten_pow)
1949 if remainder:
1950 return None
1951
1952 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1953 return None
1954 xc = 5**e
1955
1956 elif last_digit == 5:
1957 # e >= log_5(xc) if xc is a power of 5; we have
1958 # equality all the way up to xc=5**2658
1959 e = _nbits(xc)*28//65
1960 xc, remainder = divmod(5**e, xc)
1961 if remainder:
1962 return None
1963 while xc % 5 == 0:
1964 xc //= 5
1965 e -= 1
1966 if ye >= 0:
1967 y_as_integer = yc*10**ye
1968 e = e*y_as_integer
1969 xe = xe*y_as_integer
1970 else:
1971 ten_pow = 10**-ye
1972 e, remainder = divmod(e*yc, ten_pow)
1973 if remainder:
1974 return None
1975 xe, remainder = divmod(xe*yc, ten_pow)
1976 if remainder:
1977 return None
1978 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1979 return None
1980 xc = 2**e
1981 else:
1982 return None
1983
1984 if xc >= 10**p:
1985 return None
1986 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001987 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001988
1989 # now y is positive; find m and n such that y = m/n
1990 if ye >= 0:
1991 m, n = yc*10**ye, 1
1992 else:
1993 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
1994 return None
1995 xc_bits = _nbits(xc)
1996 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
1997 return None
1998 m, n = yc, 10**(-ye)
1999 while m % 2 == n % 2 == 0:
2000 m //= 2
2001 n //= 2
2002 while m % 5 == n % 5 == 0:
2003 m //= 5
2004 n //= 5
2005
2006 # compute nth root of xc*10**xe
2007 if n > 1:
2008 # if 1 < xc < 2**n then xc isn't an nth power
2009 if xc != 1 and xc_bits <= n:
2010 return None
2011
2012 xe, rem = divmod(xe, n)
2013 if rem != 0:
2014 return None
2015
2016 # compute nth root of xc using Newton's method
2017 a = 1 << -(-_nbits(xc)//n) # initial estimate
2018 while True:
2019 q, r = divmod(xc, a**(n-1))
2020 if a <= q:
2021 break
2022 else:
2023 a = (a*(n-1) + q)//n
2024 if not (a == q and r == 0):
2025 return None
2026 xc = a
2027
2028 # now xc*10**xe is the nth root of the original xc*10**xe
2029 # compute mth power of xc*10**xe
2030
2031 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2032 # 10**p and the result is not representable.
2033 if xc > 1 and m > p*100//_log10_lb(xc):
2034 return None
2035 xc = xc**m
2036 xe *= m
2037 if xc > 10**p:
2038 return None
2039
2040 # by this point the result *is* exactly representable
2041 # adjust the exponent to get as close as possible to the ideal
2042 # exponent, if necessary
2043 str_xc = str(xc)
2044 if other._isinteger() and other._sign == 0:
2045 ideal_exponent = self._exp*int(other)
2046 zeros = min(xe-ideal_exponent, p-len(str_xc))
2047 else:
2048 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002049 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002050
2051 def __pow__(self, other, modulo=None, context=None):
2052 """Return self ** other [ % modulo].
2053
2054 With two arguments, compute self**other.
2055
2056 With three arguments, compute (self**other) % modulo. For the
2057 three argument form, the following restrictions on the
2058 arguments hold:
2059
2060 - all three arguments must be integral
2061 - other must be nonnegative
2062 - either self or other (or both) must be nonzero
2063 - modulo must be nonzero and must have at most p digits,
2064 where p is the context precision.
2065
2066 If any of these restrictions is violated the InvalidOperation
2067 flag is raised.
2068
2069 The result of pow(self, other, modulo) is identical to the
2070 result that would be obtained by computing (self**other) %
2071 modulo with unbounded precision, but is computed more
2072 efficiently. It is always exact.
2073 """
2074
2075 if modulo is not None:
2076 return self._power_modulo(other, modulo, context)
2077
2078 other = _convert_other(other)
2079 if other is NotImplemented:
2080 return other
2081
2082 if context is None:
2083 context = getcontext()
2084
2085 # either argument is a NaN => result is NaN
2086 ans = self._check_nans(other, context)
2087 if ans:
2088 return ans
2089
2090 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2091 if not other:
2092 if not self:
2093 return context._raise_error(InvalidOperation, '0 ** 0')
2094 else:
2095 return Dec_p1
2096
2097 # result has sign 1 iff self._sign is 1 and other is an odd integer
2098 result_sign = 0
2099 if self._sign == 1:
2100 if other._isinteger():
2101 if not other._iseven():
2102 result_sign = 1
2103 else:
2104 # -ve**noninteger = NaN
2105 # (-0)**noninteger = 0**noninteger
2106 if self:
2107 return context._raise_error(InvalidOperation,
2108 'x ** y with x negative and y not an integer')
2109 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002110 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002111
2112 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2113 if not self:
2114 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002115 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002116 else:
2117 return Infsign[result_sign]
2118
2119 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002120 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002121 if other._sign == 0:
2122 return Infsign[result_sign]
2123 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002124 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002125
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002126 # 1**other = 1, but the choice of exponent and the flags
2127 # depend on the exponent of self, and on whether other is a
2128 # positive integer, a negative integer, or neither
2129 if self == Dec_p1:
2130 if other._isinteger():
2131 # exp = max(self._exp*max(int(other), 0),
2132 # 1-context.prec) but evaluating int(other) directly
2133 # is dangerous until we know other is small (other
2134 # could be 1e999999999)
2135 if other._sign == 1:
2136 multiplier = 0
2137 elif other > context.prec:
2138 multiplier = context.prec
2139 else:
2140 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002141
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002142 exp = self._exp * multiplier
2143 if exp < 1-context.prec:
2144 exp = 1-context.prec
2145 context._raise_error(Rounded)
2146 else:
2147 context._raise_error(Inexact)
2148 context._raise_error(Rounded)
2149 exp = 1-context.prec
2150
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002151 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002152
2153 # compute adjusted exponent of self
2154 self_adj = self.adjusted()
2155
2156 # self ** infinity is infinity if self > 1, 0 if self < 1
2157 # self ** -infinity is infinity if self < 1, 0 if self > 1
2158 if other._isinfinity():
2159 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002160 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002161 else:
2162 return Infsign[result_sign]
2163
2164 # from here on, the result always goes through the call
2165 # to _fix at the end of this function.
2166 ans = None
2167
2168 # crude test to catch cases of extreme overflow/underflow. If
2169 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2170 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2171 # self**other >= 10**(Emax+1), so overflow occurs. The test
2172 # for underflow is similar.
2173 bound = self._log10_exp_bound() + other.adjusted()
2174 if (self_adj >= 0) == (other._sign == 0):
2175 # self > 1 and other +ve, or self < 1 and other -ve
2176 # possibility of overflow
2177 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002178 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002179 else:
2180 # self > 1 and other -ve, or self < 1 and other +ve
2181 # possibility of underflow to 0
2182 Etiny = context.Etiny()
2183 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002184 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002185
2186 # try for an exact result with precision +1
2187 if ans is None:
2188 ans = self._power_exact(other, context.prec + 1)
2189 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002190 ans = _dec_from_triple(1, ans._int, ans._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002191
2192 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2193 if ans is None:
2194 p = context.prec
2195 x = _WorkRep(self)
2196 xc, xe = x.int, x.exp
2197 y = _WorkRep(other)
2198 yc, ye = y.int, y.exp
2199 if y.sign == 1:
2200 yc = -yc
2201
2202 # compute correctly rounded result: start with precision +3,
2203 # then increase precision until result is unambiguously roundable
2204 extra = 3
2205 while True:
2206 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2207 if coeff % (5*10**(len(str(coeff))-p-1)):
2208 break
2209 extra += 3
2210
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002211 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002212
2213 # the specification says that for non-integer other we need to
2214 # raise Inexact, even when the result is actually exact. In
2215 # the same way, we need to raise Underflow here if the result
2216 # is subnormal. (The call to _fix will take care of raising
2217 # Rounded and Subnormal, as usual.)
2218 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002219 context._raise_error(Inexact)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002220 # pad with zeros up to length context.prec+1 if necessary
2221 if len(ans._int) <= context.prec:
2222 expdiff = context.prec+1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002223 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2224 ans._exp-expdiff)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002225 if ans.adjusted() < context.Emin:
2226 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002227
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002228 # unlike exp, ln and log10, the power function respects the
2229 # rounding mode; no need to use ROUND_HALF_EVEN here
2230 ans = ans._fix(context)
2231 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002232
2233 def __rpow__(self, other, context=None):
2234 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002235 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002236 if other is NotImplemented:
2237 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002238 return other.__pow__(self, context=context)
2239
2240 def normalize(self, context=None):
2241 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002242
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002243 if context is None:
2244 context = getcontext()
2245
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002246 if self._is_special:
2247 ans = self._check_nans(context=context)
2248 if ans:
2249 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002250
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002251 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002252 if dup._isinfinity():
2253 return dup
2254
2255 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002256 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002257 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002258 end = len(dup._int)
2259 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002260 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002261 exp += 1
2262 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002263 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002264
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002265 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002266 """Quantize self so its exponent is the same as that of exp.
2267
2268 Similar to self._rescale(exp._exp) but with error checking.
2269 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002270 exp = _convert_other(exp, raiseit=True)
2271
2272 if context is None:
2273 context = getcontext()
2274 if rounding is None:
2275 rounding = context.rounding
2276
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002277 if self._is_special or exp._is_special:
2278 ans = self._check_nans(exp, context)
2279 if ans:
2280 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002281
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002282 if exp._isinfinity() or self._isinfinity():
2283 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002284 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002285 return context._raise_error(InvalidOperation,
2286 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002287
2288 # if we're not watching exponents, do a simple rescale
2289 if not watchexp:
2290 ans = self._rescale(exp._exp, rounding)
2291 # raise Inexact and Rounded where appropriate
2292 if ans._exp > self._exp:
2293 context._raise_error(Rounded)
2294 if ans != self:
2295 context._raise_error(Inexact)
2296 return ans
2297
2298 # exp._exp should be between Etiny and Emax
2299 if not (context.Etiny() <= exp._exp <= context.Emax):
2300 return context._raise_error(InvalidOperation,
2301 'target exponent out of bounds in quantize')
2302
2303 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002304 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002305 return ans._fix(context)
2306
2307 self_adjusted = self.adjusted()
2308 if self_adjusted > context.Emax:
2309 return context._raise_error(InvalidOperation,
2310 'exponent of quantize result too large for current context')
2311 if self_adjusted - exp._exp + 1 > context.prec:
2312 return context._raise_error(InvalidOperation,
2313 'quantize result has too many digits for current context')
2314
2315 ans = self._rescale(exp._exp, rounding)
2316 if ans.adjusted() > context.Emax:
2317 return context._raise_error(InvalidOperation,
2318 'exponent of quantize result too large for current context')
2319 if len(ans._int) > context.prec:
2320 return context._raise_error(InvalidOperation,
2321 'quantize result has too many digits for current context')
2322
2323 # raise appropriate flags
2324 if ans._exp > self._exp:
2325 context._raise_error(Rounded)
2326 if ans != self:
2327 context._raise_error(Inexact)
2328 if ans and ans.adjusted() < context.Emin:
2329 context._raise_error(Subnormal)
2330
2331 # call to fix takes care of any necessary folddown
2332 ans = ans._fix(context)
2333 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002334
2335 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002336 """Return True if self and other have the same exponent; otherwise
2337 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002338
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002339 If either operand is a special value, the following rules are used:
2340 * return True if both operands are infinities
2341 * return True if both operands are NaNs
2342 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002343 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002344 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002345 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002346 return (self.is_nan() and other.is_nan() or
2347 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002348 return self._exp == other._exp
2349
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002350 def _rescale(self, exp, rounding):
2351 """Rescale self so that the exponent is exp, either by padding with zeros
2352 or by truncating digits, using the given rounding mode.
2353
2354 Specials are returned without change. This operation is
2355 quiet: it raises no flags, and uses no information from the
2356 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002357
2358 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002359 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002360 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002361 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002362 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002363 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002364 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002365
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002366 if self._exp >= exp:
2367 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002368 return _dec_from_triple(self._sign,
2369 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002370
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002371 # too many digits; round and lose data. If self.adjusted() <
2372 # exp-1, replace self by 10**(exp-1) before rounding
2373 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002374 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002375 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002376 digits = 0
2377 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002378 changed = this_function(digits)
2379 coeff = self._int[:digits] or '0'
2380 if changed == 1:
2381 coeff = str(int(coeff)+1)
2382 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002383
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002384 def to_integral_exact(self, rounding=None, context=None):
2385 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002387 If no rounding mode is specified, take the rounding mode from
2388 the context. This method raises the Rounded and Inexact flags
2389 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002390
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002391 See also: to_integral_value, which does exactly the same as
2392 this method except that it doesn't raise Inexact or Rounded.
2393 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002394 if self._is_special:
2395 ans = self._check_nans(context=context)
2396 if ans:
2397 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002398 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002399 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002400 return Decimal(self)
2401 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002402 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002403 if context is None:
2404 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002405 if rounding is None:
2406 rounding = context.rounding
2407 context._raise_error(Rounded)
2408 ans = self._rescale(0, rounding)
2409 if ans != self:
2410 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002411 return ans
2412
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002413 def to_integral_value(self, rounding=None, context=None):
2414 """Rounds to the nearest integer, without raising inexact, rounded."""
2415 if context is None:
2416 context = getcontext()
2417 if rounding is None:
2418 rounding = context.rounding
2419 if self._is_special:
2420 ans = self._check_nans(context=context)
2421 if ans:
2422 return ans
2423 return Decimal(self)
2424 if self._exp >= 0:
2425 return Decimal(self)
2426 else:
2427 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002428
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002429 # the method name changed, but we provide also the old one, for compatibility
2430 to_integral = to_integral_value
2431
2432 def sqrt(self, context=None):
2433 """Return the square root of self."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002434 if self._is_special:
2435 ans = self._check_nans(context=context)
2436 if ans:
2437 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002438
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002439 if self._isinfinity() and self._sign == 0:
2440 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002441
2442 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002443 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002444 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002445 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002446
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002447 if context is None:
2448 context = getcontext()
2449
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002450 if self._sign == 1:
2451 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2452
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002453 # At this point self represents a positive number. Let p be
2454 # the desired precision and express self in the form c*100**e
2455 # with c a positive real number and e an integer, c and e
2456 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2457 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2458 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2459 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2460 # the closest integer to sqrt(c) with the even integer chosen
2461 # in the case of a tie.
2462 #
2463 # To ensure correct rounding in all cases, we use the
2464 # following trick: we compute the square root to an extra
2465 # place (precision p+1 instead of precision p), rounding down.
2466 # Then, if the result is inexact and its last digit is 0 or 5,
2467 # we increase the last digit to 1 or 6 respectively; if it's
2468 # exact we leave the last digit alone. Now the final round to
2469 # p places (or fewer in the case of underflow) will round
2470 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002471
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002472 # use an extra digit of precision
2473 prec = context.prec+1
2474
2475 # write argument in the form c*100**e where e = self._exp//2
2476 # is the 'ideal' exponent, to be used if the square root is
2477 # exactly representable. l is the number of 'digits' of c in
2478 # base 100, so that 100**(l-1) <= c < 100**l.
2479 op = _WorkRep(self)
2480 e = op.exp >> 1
2481 if op.exp & 1:
2482 c = op.int * 10
2483 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002484 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002485 c = op.int
2486 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002487
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002488 # rescale so that c has exactly prec base 100 'digits'
2489 shift = prec-l
2490 if shift >= 0:
2491 c *= 100**shift
2492 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002493 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002494 c, remainder = divmod(c, 100**-shift)
2495 exact = not remainder
2496 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002498 # find n = floor(sqrt(c)) using Newton's method
2499 n = 10**prec
2500 while True:
2501 q = c//n
2502 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002503 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002504 else:
2505 n = n + q >> 1
2506 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002507
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002508 if exact:
2509 # result is exact; rescale to use ideal exponent e
2510 if shift >= 0:
2511 # assert n % 10**shift == 0
2512 n //= 10**shift
2513 else:
2514 n *= 10**-shift
2515 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002516 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002517 # result is not exact; fix last digit as described above
2518 if n % 5 == 0:
2519 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002521 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002522
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002523 # round, and fit to current context
2524 context = context._shallow_copy()
2525 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002526 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002527 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002528
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002529 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002530
2531 def max(self, other, context=None):
2532 """Returns the larger value.
2533
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002534 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002535 NaN (and signals if one is sNaN). Also rounds.
2536 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002537 other = _convert_other(other, raiseit=True)
2538
2539 if context is None:
2540 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002541
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002542 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002543 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002544 # number is always returned
2545 sn = self._isnan()
2546 on = other._isnan()
2547 if sn or on:
2548 if on == 1 and sn != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002549 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002550 if sn == 1 and on != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002551 return other._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002552 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002553
Christian Heimes77c02eb2008-02-09 02:18:51 +00002554 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002555 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002556 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002557 # then an ordering is applied:
2558 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002559 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002560 # positive sign and min returns the operand with the negative sign
2561 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002562 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002563 # the result. This is exactly the ordering used in compare_total.
2564 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002565
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002566 if c == -1:
2567 ans = other
2568 else:
2569 ans = self
2570
Christian Heimes2c181612007-12-17 20:04:13 +00002571 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002572
2573 def min(self, other, context=None):
2574 """Returns the smaller value.
2575
Guido van Rossumd8faa362007-04-27 19:54:29 +00002576 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002577 NaN (and signals if one is sNaN). Also rounds.
2578 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002579 other = _convert_other(other, raiseit=True)
2580
2581 if context is None:
2582 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002583
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002584 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002585 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002586 # number is always returned
2587 sn = self._isnan()
2588 on = other._isnan()
2589 if sn or on:
2590 if on == 1 and sn != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002591 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002592 if sn == 1 and on != 2:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002593 return other._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002594 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002595
Christian Heimes77c02eb2008-02-09 02:18:51 +00002596 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002597 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002598 c = self.compare_total(other)
2599
2600 if c == -1:
2601 ans = self
2602 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002603 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002604
Christian Heimes2c181612007-12-17 20:04:13 +00002605 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606
2607 def _isinteger(self):
2608 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002609 if self._is_special:
2610 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002611 if self._exp >= 0:
2612 return True
2613 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002614 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002615
2616 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002617 """Returns True if self is even. Assumes self is an integer."""
2618 if not self or self._exp > 0:
2619 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002620 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002621
2622 def adjusted(self):
2623 """Return the adjusted exponent of self"""
2624 try:
2625 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002626 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002627 except TypeError:
2628 return 0
2629
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002630 def canonical(self, context=None):
2631 """Returns the same Decimal object.
2632
2633 As we do not have different encodings for the same number, the
2634 received object already is in its canonical form.
2635 """
2636 return self
2637
2638 def compare_signal(self, other, context=None):
2639 """Compares self to the other operand numerically.
2640
2641 It's pretty much like compare(), but all NaNs signal, with signaling
2642 NaNs taking precedence over quiet NaNs.
2643 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002644 other = _convert_other(other, raiseit = True)
2645 ans = self._compare_check_nans(other, context)
2646 if ans:
2647 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002648 return self.compare(other, context=context)
2649
2650 def compare_total(self, other):
2651 """Compares self to other using the abstract representations.
2652
2653 This is not like the standard compare, which use their numerical
2654 value. Note that a total ordering is defined for all possible abstract
2655 representations.
2656 """
2657 # if one is negative and the other is positive, it's easy
2658 if self._sign and not other._sign:
2659 return Dec_n1
2660 if not self._sign and other._sign:
2661 return Dec_p1
2662 sign = self._sign
2663
2664 # let's handle both NaN types
2665 self_nan = self._isnan()
2666 other_nan = other._isnan()
2667 if self_nan or other_nan:
2668 if self_nan == other_nan:
2669 if self._int < other._int:
2670 if sign:
2671 return Dec_p1
2672 else:
2673 return Dec_n1
2674 if self._int > other._int:
2675 if sign:
2676 return Dec_n1
2677 else:
2678 return Dec_p1
2679 return Dec_0
2680
2681 if sign:
2682 if self_nan == 1:
2683 return Dec_n1
2684 if other_nan == 1:
2685 return Dec_p1
2686 if self_nan == 2:
2687 return Dec_n1
2688 if other_nan == 2:
2689 return Dec_p1
2690 else:
2691 if self_nan == 1:
2692 return Dec_p1
2693 if other_nan == 1:
2694 return Dec_n1
2695 if self_nan == 2:
2696 return Dec_p1
2697 if other_nan == 2:
2698 return Dec_n1
2699
2700 if self < other:
2701 return Dec_n1
2702 if self > other:
2703 return Dec_p1
2704
2705 if self._exp < other._exp:
2706 if sign:
2707 return Dec_p1
2708 else:
2709 return Dec_n1
2710 if self._exp > other._exp:
2711 if sign:
2712 return Dec_n1
2713 else:
2714 return Dec_p1
2715 return Dec_0
2716
2717
2718 def compare_total_mag(self, other):
2719 """Compares self to other using abstract repr., ignoring sign.
2720
2721 Like compare_total, but with operand's sign ignored and assumed to be 0.
2722 """
2723 s = self.copy_abs()
2724 o = other.copy_abs()
2725 return s.compare_total(o)
2726
2727 def copy_abs(self):
2728 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002729 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002730
2731 def copy_negate(self):
2732 """Returns a copy with the sign inverted."""
2733 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002734 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002735 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002736 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002737
2738 def copy_sign(self, other):
2739 """Returns self with the sign of other."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002740 return _dec_from_triple(other._sign, self._int,
2741 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002742
2743 def exp(self, context=None):
2744 """Returns e ** self."""
2745
2746 if context is None:
2747 context = getcontext()
2748
2749 # exp(NaN) = NaN
2750 ans = self._check_nans(context=context)
2751 if ans:
2752 return ans
2753
2754 # exp(-Infinity) = 0
2755 if self._isinfinity() == -1:
2756 return Dec_0
2757
2758 # exp(0) = 1
2759 if not self:
2760 return Dec_p1
2761
2762 # exp(Infinity) = Infinity
2763 if self._isinfinity() == 1:
2764 return Decimal(self)
2765
2766 # the result is now guaranteed to be inexact (the true
2767 # mathematical result is transcendental). There's no need to
2768 # raise Rounded and Inexact here---they'll always be raised as
2769 # a result of the call to _fix.
2770 p = context.prec
2771 adj = self.adjusted()
2772
2773 # we only need to do any computation for quite a small range
2774 # of adjusted exponents---for example, -29 <= adj <= 10 for
2775 # the default context. For smaller exponent the result is
2776 # indistinguishable from 1 at the given precision, while for
2777 # larger exponent the result either overflows or underflows.
2778 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2779 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002780 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002781 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2782 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002783 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002784 elif self._sign == 0 and adj < -p:
2785 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002786 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002787 elif self._sign == 1 and adj < -p-1:
2788 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002789 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002790 # general case
2791 else:
2792 op = _WorkRep(self)
2793 c, e = op.int, op.exp
2794 if op.sign == 1:
2795 c = -c
2796
2797 # compute correctly rounded result: increase precision by
2798 # 3 digits at a time until we get an unambiguously
2799 # roundable result
2800 extra = 3
2801 while True:
2802 coeff, exp = _dexp(c, e, p+extra)
2803 if coeff % (5*10**(len(str(coeff))-p-1)):
2804 break
2805 extra += 3
2806
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002807 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002808
2809 # at this stage, ans should round correctly with *any*
2810 # rounding mode, not just with ROUND_HALF_EVEN
2811 context = context._shallow_copy()
2812 rounding = context._set_rounding(ROUND_HALF_EVEN)
2813 ans = ans._fix(context)
2814 context.rounding = rounding
2815
2816 return ans
2817
2818 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002819 """Return True if self is canonical; otherwise return False.
2820
2821 Currently, the encoding of a Decimal instance is always
2822 canonical, so this method returns True for any Decimal.
2823 """
2824 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002825
2826 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002827 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002828
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002829 A Decimal instance is considered finite if it is neither
2830 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002831 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002832 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002833
2834 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002835 """Return True if self is infinite; otherwise return False."""
2836 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002837
2838 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002839 """Return True if self is a qNaN or sNaN; otherwise return False."""
2840 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002841
2842 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002843 """Return True if self is a normal number; otherwise return False."""
2844 if self._is_special or not self:
2845 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002846 if context is None:
2847 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002848 return context.Emin <= self.adjusted() <= context.Emax
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002849
2850 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002851 """Return True if self is a quiet NaN; otherwise return False."""
2852 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002853
2854 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002855 """Return True if self is negative; otherwise return False."""
2856 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002857
2858 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002859 """Return True if self is a signaling NaN; otherwise return False."""
2860 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002861
2862 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002863 """Return True if self is subnormal; otherwise return False."""
2864 if self._is_special or not self:
2865 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002866 if context is None:
2867 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002868 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002869
2870 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002871 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002872 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002873
2874 def _ln_exp_bound(self):
2875 """Compute a lower bound for the adjusted exponent of self.ln().
2876 In other words, compute r such that self.ln() >= 10**r. Assumes
2877 that self is finite and positive and that self != 1.
2878 """
2879
2880 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2881 adj = self._exp + len(self._int) - 1
2882 if adj >= 1:
2883 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2884 return len(str(adj*23//10)) - 1
2885 if adj <= -2:
2886 # argument <= 0.1
2887 return len(str((-1-adj)*23//10)) - 1
2888 op = _WorkRep(self)
2889 c, e = op.int, op.exp
2890 if adj == 0:
2891 # 1 < self < 10
2892 num = str(c-10**-e)
2893 den = str(c)
2894 return len(num) - len(den) - (num < den)
2895 # adj == -1, 0.1 <= self < 1
2896 return e + len(str(10**-e - c)) - 1
2897
2898
2899 def ln(self, context=None):
2900 """Returns the natural (base e) logarithm of self."""
2901
2902 if context is None:
2903 context = getcontext()
2904
2905 # ln(NaN) = NaN
2906 ans = self._check_nans(context=context)
2907 if ans:
2908 return ans
2909
2910 # ln(0.0) == -Infinity
2911 if not self:
2912 return negInf
2913
2914 # ln(Infinity) = Infinity
2915 if self._isinfinity() == 1:
2916 return Inf
2917
2918 # ln(1.0) == 0.0
2919 if self == Dec_p1:
2920 return Dec_0
2921
2922 # ln(negative) raises InvalidOperation
2923 if self._sign == 1:
2924 return context._raise_error(InvalidOperation,
2925 'ln of a negative value')
2926
2927 # result is irrational, so necessarily inexact
2928 op = _WorkRep(self)
2929 c, e = op.int, op.exp
2930 p = context.prec
2931
2932 # correctly rounded result: repeatedly increase precision by 3
2933 # until we get an unambiguously roundable result
2934 places = p - self._ln_exp_bound() + 2 # at least p+3 places
2935 while True:
2936 coeff = _dlog(c, e, places)
2937 # assert len(str(abs(coeff)))-p >= 1
2938 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
2939 break
2940 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002941 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002942
2943 context = context._shallow_copy()
2944 rounding = context._set_rounding(ROUND_HALF_EVEN)
2945 ans = ans._fix(context)
2946 context.rounding = rounding
2947 return ans
2948
2949 def _log10_exp_bound(self):
2950 """Compute a lower bound for the adjusted exponent of self.log10().
2951 In other words, find r such that self.log10() >= 10**r.
2952 Assumes that self is finite and positive and that self != 1.
2953 """
2954
2955 # For x >= 10 or x < 0.1 we only need a bound on the integer
2956 # part of log10(self), and this comes directly from the
2957 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
2958 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
2959 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
2960
2961 adj = self._exp + len(self._int) - 1
2962 if adj >= 1:
2963 # self >= 10
2964 return len(str(adj))-1
2965 if adj <= -2:
2966 # self < 0.1
2967 return len(str(-1-adj))-1
2968 op = _WorkRep(self)
2969 c, e = op.int, op.exp
2970 if adj == 0:
2971 # 1 < self < 10
2972 num = str(c-10**-e)
2973 den = str(231*c)
2974 return len(num) - len(den) - (num < den) + 2
2975 # adj == -1, 0.1 <= self < 1
2976 num = str(10**-e-c)
2977 return len(num) + e - (num < "231") - 1
2978
2979 def log10(self, context=None):
2980 """Returns the base 10 logarithm of self."""
2981
2982 if context is None:
2983 context = getcontext()
2984
2985 # log10(NaN) = NaN
2986 ans = self._check_nans(context=context)
2987 if ans:
2988 return ans
2989
2990 # log10(0.0) == -Infinity
2991 if not self:
2992 return negInf
2993
2994 # log10(Infinity) = Infinity
2995 if self._isinfinity() == 1:
2996 return Inf
2997
2998 # log10(negative or -Infinity) raises InvalidOperation
2999 if self._sign == 1:
3000 return context._raise_error(InvalidOperation,
3001 'log10 of a negative value')
3002
3003 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003004 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003005 # answer may need rounding
3006 ans = Decimal(self._exp + len(self._int) - 1)
3007 else:
3008 # result is irrational, so necessarily inexact
3009 op = _WorkRep(self)
3010 c, e = op.int, op.exp
3011 p = context.prec
3012
3013 # correctly rounded result: repeatedly increase precision
3014 # until result is unambiguously roundable
3015 places = p-self._log10_exp_bound()+2
3016 while True:
3017 coeff = _dlog10(c, e, places)
3018 # assert len(str(abs(coeff)))-p >= 1
3019 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3020 break
3021 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003022 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003023
3024 context = context._shallow_copy()
3025 rounding = context._set_rounding(ROUND_HALF_EVEN)
3026 ans = ans._fix(context)
3027 context.rounding = rounding
3028 return ans
3029
3030 def logb(self, context=None):
3031 """ Returns the exponent of the magnitude of self's MSD.
3032
3033 The result is the integer which is the exponent of the magnitude
3034 of the most significant digit of self (as though it were truncated
3035 to a single digit while maintaining the value of that digit and
3036 without limiting the resulting exponent).
3037 """
3038 # logb(NaN) = NaN
3039 ans = self._check_nans(context=context)
3040 if ans:
3041 return ans
3042
3043 if context is None:
3044 context = getcontext()
3045
3046 # logb(+/-Inf) = +Inf
3047 if self._isinfinity():
3048 return Inf
3049
3050 # logb(0) = -Inf, DivisionByZero
3051 if not self:
3052 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3053
3054 # otherwise, simply return the adjusted exponent of self, as a
3055 # Decimal. Note that no attempt is made to fit the result
3056 # into the current context.
3057 return Decimal(self.adjusted())
3058
3059 def _islogical(self):
3060 """Return True if self is a logical operand.
3061
Christian Heimes679db4a2008-01-18 09:56:22 +00003062 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003063 an exponent of 0, and a coefficient whose digits must all be
3064 either 0 or 1.
3065 """
3066 if self._sign != 0 or self._exp != 0:
3067 return False
3068 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003069 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003070 return False
3071 return True
3072
3073 def _fill_logical(self, context, opa, opb):
3074 dif = context.prec - len(opa)
3075 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003076 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003077 elif dif < 0:
3078 opa = opa[-context.prec:]
3079 dif = context.prec - len(opb)
3080 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003081 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003082 elif dif < 0:
3083 opb = opb[-context.prec:]
3084 return opa, opb
3085
3086 def logical_and(self, other, context=None):
3087 """Applies an 'and' operation between self and other's digits."""
3088 if context is None:
3089 context = getcontext()
3090 if not self._islogical() or not other._islogical():
3091 return context._raise_error(InvalidOperation)
3092
3093 # fill to context.prec
3094 (opa, opb) = self._fill_logical(context, self._int, other._int)
3095
3096 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003097 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3098 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003099
3100 def logical_invert(self, context=None):
3101 """Invert all its digits."""
3102 if context is None:
3103 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003104 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3105 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003106
3107 def logical_or(self, other, context=None):
3108 """Applies an 'or' operation between self and other's digits."""
3109 if context is None:
3110 context = getcontext()
3111 if not self._islogical() or not other._islogical():
3112 return context._raise_error(InvalidOperation)
3113
3114 # fill to context.prec
3115 (opa, opb) = self._fill_logical(context, self._int, other._int)
3116
3117 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003118 result = "".join(str(int(a)|int(b)) for a,b in zip(opa,opb))
3119 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003120
3121 def logical_xor(self, other, context=None):
3122 """Applies an 'xor' 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 max_mag(self, other, context=None):
3136 """Compares the values numerically with their sign ignored."""
3137 other = _convert_other(other, raiseit=True)
3138
3139 if context is None:
3140 context = getcontext()
3141
3142 if self._is_special or other._is_special:
3143 # If one operand is a quiet NaN and the other is number, then the
3144 # number is always returned
3145 sn = self._isnan()
3146 on = other._isnan()
3147 if sn or on:
3148 if on == 1 and sn != 2:
3149 return self._fix_nan(context)
3150 if sn == 1 and on != 2:
3151 return other._fix_nan(context)
3152 return self._check_nans(other, context)
3153
Christian Heimes77c02eb2008-02-09 02:18:51 +00003154 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003155 if c == 0:
3156 c = self.compare_total(other)
3157
3158 if c == -1:
3159 ans = other
3160 else:
3161 ans = self
3162
Christian Heimes2c181612007-12-17 20:04:13 +00003163 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003164
3165 def min_mag(self, other, context=None):
3166 """Compares the values numerically with their sign ignored."""
3167 other = _convert_other(other, raiseit=True)
3168
3169 if context is None:
3170 context = getcontext()
3171
3172 if self._is_special or other._is_special:
3173 # If one operand is a quiet NaN and the other is number, then the
3174 # number is always returned
3175 sn = self._isnan()
3176 on = other._isnan()
3177 if sn or on:
3178 if on == 1 and sn != 2:
3179 return self._fix_nan(context)
3180 if sn == 1 and on != 2:
3181 return other._fix_nan(context)
3182 return self._check_nans(other, context)
3183
Christian Heimes77c02eb2008-02-09 02:18:51 +00003184 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003185 if c == 0:
3186 c = self.compare_total(other)
3187
3188 if c == -1:
3189 ans = self
3190 else:
3191 ans = other
3192
Christian Heimes2c181612007-12-17 20:04:13 +00003193 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003194
3195 def next_minus(self, context=None):
3196 """Returns the largest representable number smaller than itself."""
3197 if context is None:
3198 context = getcontext()
3199
3200 ans = self._check_nans(context=context)
3201 if ans:
3202 return ans
3203
3204 if self._isinfinity() == -1:
3205 return negInf
3206 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003207 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003208
3209 context = context.copy()
3210 context._set_rounding(ROUND_FLOOR)
3211 context._ignore_all_flags()
3212 new_self = self._fix(context)
3213 if new_self != self:
3214 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003215 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3216 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003217
3218 def next_plus(self, context=None):
3219 """Returns the smallest representable number larger than itself."""
3220 if context is None:
3221 context = getcontext()
3222
3223 ans = self._check_nans(context=context)
3224 if ans:
3225 return ans
3226
3227 if self._isinfinity() == 1:
3228 return Inf
3229 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003230 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003231
3232 context = context.copy()
3233 context._set_rounding(ROUND_CEILING)
3234 context._ignore_all_flags()
3235 new_self = self._fix(context)
3236 if new_self != self:
3237 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003238 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3239 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003240
3241 def next_toward(self, other, context=None):
3242 """Returns the number closest to self, in the direction towards other.
3243
3244 The result is the closest representable number to self
3245 (excluding self) that is in the direction towards other,
3246 unless both have the same value. If the two operands are
3247 numerically equal, then the result is a copy of self with the
3248 sign set to be the same as the sign of other.
3249 """
3250 other = _convert_other(other, raiseit=True)
3251
3252 if context is None:
3253 context = getcontext()
3254
3255 ans = self._check_nans(other, context)
3256 if ans:
3257 return ans
3258
Christian Heimes77c02eb2008-02-09 02:18:51 +00003259 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003260 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003261 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003262
3263 if comparison == -1:
3264 ans = self.next_plus(context)
3265 else: # comparison == 1
3266 ans = self.next_minus(context)
3267
3268 # decide which flags to raise using value of ans
3269 if ans._isinfinity():
3270 context._raise_error(Overflow,
3271 'Infinite result from next_toward',
3272 ans._sign)
3273 context._raise_error(Rounded)
3274 context._raise_error(Inexact)
3275 elif ans.adjusted() < context.Emin:
3276 context._raise_error(Underflow)
3277 context._raise_error(Subnormal)
3278 context._raise_error(Rounded)
3279 context._raise_error(Inexact)
3280 # if precision == 1 then we don't raise Clamped for a
3281 # result 0E-Etiny.
3282 if not ans:
3283 context._raise_error(Clamped)
3284
3285 return ans
3286
3287 def number_class(self, context=None):
3288 """Returns an indication of the class of self.
3289
3290 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003291 sNaN
3292 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003293 -Infinity
3294 -Normal
3295 -Subnormal
3296 -Zero
3297 +Zero
3298 +Subnormal
3299 +Normal
3300 +Infinity
3301 """
3302 if self.is_snan():
3303 return "sNaN"
3304 if self.is_qnan():
3305 return "NaN"
3306 inf = self._isinfinity()
3307 if inf == 1:
3308 return "+Infinity"
3309 if inf == -1:
3310 return "-Infinity"
3311 if self.is_zero():
3312 if self._sign:
3313 return "-Zero"
3314 else:
3315 return "+Zero"
3316 if context is None:
3317 context = getcontext()
3318 if self.is_subnormal(context=context):
3319 if self._sign:
3320 return "-Subnormal"
3321 else:
3322 return "+Subnormal"
3323 # just a normal, regular, boring number, :)
3324 if self._sign:
3325 return "-Normal"
3326 else:
3327 return "+Normal"
3328
3329 def radix(self):
3330 """Just returns 10, as this is Decimal, :)"""
3331 return Decimal(10)
3332
3333 def rotate(self, other, context=None):
3334 """Returns a rotated copy of self, value-of-other times."""
3335 if context is None:
3336 context = getcontext()
3337
3338 ans = self._check_nans(other, context)
3339 if ans:
3340 return ans
3341
3342 if other._exp != 0:
3343 return context._raise_error(InvalidOperation)
3344 if not (-context.prec <= int(other) <= context.prec):
3345 return context._raise_error(InvalidOperation)
3346
3347 if self._isinfinity():
3348 return Decimal(self)
3349
3350 # get values, pad if necessary
3351 torot = int(other)
3352 rotdig = self._int
3353 topad = context.prec - len(rotdig)
3354 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003355 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003356
3357 # let's rotate!
3358 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003359 return _dec_from_triple(self._sign,
3360 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003361
3362 def scaleb (self, other, context=None):
3363 """Returns self operand after adding the second value to its exp."""
3364 if context is None:
3365 context = getcontext()
3366
3367 ans = self._check_nans(other, context)
3368 if ans:
3369 return ans
3370
3371 if other._exp != 0:
3372 return context._raise_error(InvalidOperation)
3373 liminf = -2 * (context.Emax + context.prec)
3374 limsup = 2 * (context.Emax + context.prec)
3375 if not (liminf <= int(other) <= limsup):
3376 return context._raise_error(InvalidOperation)
3377
3378 if self._isinfinity():
3379 return Decimal(self)
3380
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003381 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003382 d = d._fix(context)
3383 return d
3384
3385 def shift(self, other, context=None):
3386 """Returns a shifted copy of self, value-of-other times."""
3387 if context is None:
3388 context = getcontext()
3389
3390 ans = self._check_nans(other, context)
3391 if ans:
3392 return ans
3393
3394 if other._exp != 0:
3395 return context._raise_error(InvalidOperation)
3396 if not (-context.prec <= int(other) <= context.prec):
3397 return context._raise_error(InvalidOperation)
3398
3399 if self._isinfinity():
3400 return Decimal(self)
3401
3402 # get values, pad if necessary
3403 torot = int(other)
3404 if not torot:
3405 return Decimal(self)
3406 rotdig = self._int
3407 topad = context.prec - len(rotdig)
3408 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003409 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003410
3411 # let's shift!
3412 if torot < 0:
3413 rotated = rotdig[:torot]
3414 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003415 rotated = rotdig + '0'*torot
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003416 rotated = rotated[-context.prec:]
3417
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003418 return _dec_from_triple(self._sign,
3419 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003420
Guido van Rossumd8faa362007-04-27 19:54:29 +00003421 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003422 def __reduce__(self):
3423 return (self.__class__, (str(self),))
3424
3425 def __copy__(self):
3426 if type(self) == Decimal:
3427 return self # I'm immutable; therefore I am my own clone
3428 return self.__class__(str(self))
3429
3430 def __deepcopy__(self, memo):
3431 if type(self) == Decimal:
3432 return self # My components are also immutable
3433 return self.__class__(str(self))
3434
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003435def _dec_from_triple(sign, coefficient, exponent, special=False):
3436 """Create a decimal instance directly, without any validation,
3437 normalization (e.g. removal of leading zeros) or argument
3438 conversion.
3439
3440 This function is for *internal use only*.
3441 """
3442
3443 self = object.__new__(Decimal)
3444 self._sign = sign
3445 self._int = coefficient
3446 self._exp = exponent
3447 self._is_special = special
3448
3449 return self
3450
Guido van Rossumd8faa362007-04-27 19:54:29 +00003451##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003452
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003453
3454# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003455rounding_functions = [name for name in Decimal.__dict__.keys()
3456 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003457for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003458 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003459 globalname = name[1:].upper()
3460 val = globals()[globalname]
3461 Decimal._pick_rounding_function[val] = name
3462
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003463del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003464
Thomas Wouters89f507f2006-12-13 04:49:30 +00003465class _ContextManager(object):
3466 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003467
Thomas Wouters89f507f2006-12-13 04:49:30 +00003468 Sets a copy of the supplied context in __enter__() and restores
3469 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003470 """
3471 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003472 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003473 def __enter__(self):
3474 self.saved_context = getcontext()
3475 setcontext(self.new_context)
3476 return self.new_context
3477 def __exit__(self, t, v, tb):
3478 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003479
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003480class Context(object):
3481 """Contains the context for a Decimal instance.
3482
3483 Contains:
3484 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003485 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003486 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003487 raised when it is caused. Otherwise, a value is
3488 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003489 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003490 (Whether or not the trap_enabler is set)
3491 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003492 Emin - Minimum exponent
3493 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003494 capitals - If 1, 1*10^1 is printed as 1E+1.
3495 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003496 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003497 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003498
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003499 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003500 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003501 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003502 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003503 _ignored_flags=None):
3504 if flags is None:
3505 flags = []
3506 if _ignored_flags is None:
3507 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003508 if not isinstance(flags, dict):
Raymond Hettingerfed52962004-07-14 15:41:57 +00003509 flags = dict([(s,s in flags) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003510 if traps is not None and not isinstance(traps, dict):
Raymond Hettingerfed52962004-07-14 15:41:57 +00003511 traps = dict([(s,s in traps) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003512 for name, val in locals().items():
3513 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003514 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003515 else:
3516 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003517 del self.self
3518
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003519 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003520 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003521 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003522 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3523 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3524 % vars(self))
3525 names = [f.__name__ for f, v in self.flags.items() if v]
3526 s.append('flags=[' + ', '.join(names) + ']')
3527 names = [t.__name__ for t, v in self.traps.items() if v]
3528 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003529 return ', '.join(s) + ')'
3530
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003531 def clear_flags(self):
3532 """Reset all flags to zero"""
3533 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003534 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003535
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003536 def _shallow_copy(self):
3537 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003538 nc = Context(self.prec, self.rounding, self.traps,
3539 self.flags, self.Emin, self.Emax,
3540 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003541 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003542
3543 def copy(self):
3544 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003545 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003546 self.flags.copy(), self.Emin, self.Emax,
3547 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003548 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003549 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003550
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003551 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003552 """Handles an error
3553
3554 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003555 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003556 trap_enabler is set, it reaises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003557 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003558 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003559 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003560 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003561 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003562 return error().handle(self, *args)
3563
Raymond Hettinger86173da2008-02-01 20:38:12 +00003564 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003565 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003566 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003567 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003568
3569 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003570 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003571 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003572
3573 def _ignore_all_flags(self):
3574 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003575 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003576
3577 def _ignore_flags(self, *flags):
3578 """Ignore the flags, if they are raised"""
3579 # Do not mutate-- This way, copies of a context leave the original
3580 # alone.
3581 self._ignored_flags = (self._ignored_flags + list(flags))
3582 return list(flags)
3583
3584 def _regard_flags(self, *flags):
3585 """Stop ignoring the flags, if they are raised"""
3586 if flags and isinstance(flags[0], (tuple,list)):
3587 flags = flags[0]
3588 for flag in flags:
3589 self._ignored_flags.remove(flag)
3590
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003591 def __hash__(self):
3592 """A Context cannot be hashed."""
3593 # We inherit object.__hash__, so we must deny this explicitly
Guido van Rossumd8faa362007-04-27 19:54:29 +00003594 raise TypeError("Cannot hash a Context.")
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003595
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003596 def Etiny(self):
3597 """Returns Etiny (= Emin - prec + 1)"""
3598 return int(self.Emin - self.prec + 1)
3599
3600 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003601 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003602 return int(self.Emax - self.prec + 1)
3603
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003604 def _set_rounding(self, type):
3605 """Sets the rounding type.
3606
3607 Sets the rounding type, and returns the current (previous)
3608 rounding type. Often used like:
3609
3610 context = context.copy()
3611 # so you don't change the calling context
3612 # if an error occurs in the middle.
3613 rounding = context._set_rounding(ROUND_UP)
3614 val = self.__sub__(other, context=context)
3615 context._set_rounding(rounding)
3616
3617 This will make it round up for that operation.
3618 """
3619 rounding = self.rounding
3620 self.rounding= type
3621 return rounding
3622
Raymond Hettingerfed52962004-07-14 15:41:57 +00003623 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003624 """Creates a new Decimal instance but using self as context.
3625
3626 This method implements the to-number operation of the
3627 IBM Decimal specification."""
3628
3629 if isinstance(num, str) and num != num.strip():
3630 return self._raise_error(ConversionSyntax,
3631 "no trailing or leading whitespace is "
3632 "permitted.")
3633
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003634 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003635 if d._isnan() and len(d._int) > self.prec - self._clamp:
3636 return self._raise_error(ConversionSyntax,
3637 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003638 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003639
Guido van Rossumd8faa362007-04-27 19:54:29 +00003640 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003641 def abs(self, a):
3642 """Returns the absolute value of the operand.
3643
3644 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003645 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003646 the plus operation on the operand.
3647
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003648 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003649 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003650 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003651 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003652 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003653 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003654 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003655 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003656 """
3657 return a.__abs__(context=self)
3658
3659 def add(self, a, b):
3660 """Return the sum of the two operands.
3661
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003662 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003663 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003664 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003665 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003666 """
3667 return a.__add__(b, context=self)
3668
3669 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003670 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003671
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003672 def canonical(self, a):
3673 """Returns the same Decimal object.
3674
3675 As we do not have different encodings for the same number, the
3676 received object already is in its canonical form.
3677
3678 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003679 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003680 """
3681 return a.canonical(context=self)
3682
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003683 def compare(self, a, b):
3684 """Compares values numerically.
3685
3686 If the signs of the operands differ, a value representing each operand
3687 ('-1' if the operand is less than zero, '0' if the operand is zero or
3688 negative zero, or '1' if the operand is greater than zero) is used in
3689 place of that operand for the comparison instead of the actual
3690 operand.
3691
3692 The comparison is then effected by subtracting the second operand from
3693 the first and then returning a value according to the result of the
3694 subtraction: '-1' if the result is less than zero, '0' if the result is
3695 zero or negative zero, or '1' if the result is greater than zero.
3696
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003697 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003698 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003699 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003700 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003701 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003702 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003703 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003704 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003705 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003706 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003707 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003708 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003709 """
3710 return a.compare(b, context=self)
3711
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003712 def compare_signal(self, a, b):
3713 """Compares the values of the two operands numerically.
3714
3715 It's pretty much like compare(), but all NaNs signal, with signaling
3716 NaNs taking precedence over quiet NaNs.
3717
3718 >>> c = ExtendedContext
3719 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003720 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003721 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003722 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003723 >>> c.flags[InvalidOperation] = 0
3724 >>> print(c.flags[InvalidOperation])
3725 0
3726 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003727 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003728 >>> print(c.flags[InvalidOperation])
3729 1
3730 >>> c.flags[InvalidOperation] = 0
3731 >>> print(c.flags[InvalidOperation])
3732 0
3733 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003734 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003735 >>> print(c.flags[InvalidOperation])
3736 1
3737 """
3738 return a.compare_signal(b, context=self)
3739
3740 def compare_total(self, a, b):
3741 """Compares two operands using their abstract representation.
3742
3743 This is not like the standard compare, which use their numerical
3744 value. Note that a total ordering is defined for all possible abstract
3745 representations.
3746
3747 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003748 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003749 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003750 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003751 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003752 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003753 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003754 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003755 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003756 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003757 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003758 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003759 """
3760 return a.compare_total(b)
3761
3762 def compare_total_mag(self, a, b):
3763 """Compares two operands using their abstract representation ignoring sign.
3764
3765 Like compare_total, but with operand's sign ignored and assumed to be 0.
3766 """
3767 return a.compare_total_mag(b)
3768
3769 def copy_abs(self, a):
3770 """Returns a copy of the operand with the sign set to 0.
3771
3772 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003773 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003774 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003775 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003776 """
3777 return a.copy_abs()
3778
3779 def copy_decimal(self, a):
3780 """Returns a copy of the decimal objet.
3781
3782 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003783 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003784 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003785 Decimal('-1.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003786 """
3787 return Decimal(a)
3788
3789 def copy_negate(self, a):
3790 """Returns a copy of the operand with the sign inverted.
3791
3792 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003793 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003794 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003795 Decimal('101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003796 """
3797 return a.copy_negate()
3798
3799 def copy_sign(self, a, b):
3800 """Copies the second operand's sign to the first one.
3801
3802 In detail, it returns a copy of the first operand with the sign
3803 equal to the sign of the second operand.
3804
3805 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003806 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003807 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003808 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003809 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003810 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003811 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003812 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003813 """
3814 return a.copy_sign(b)
3815
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816 def divide(self, a, b):
3817 """Decimal division in a specified context.
3818
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003819 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003820 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003821 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003822 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003823 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003824 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003825 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003826 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003827 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003828 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003829 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003830 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003831 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003832 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003833 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003834 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003835 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003836 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003837 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003838 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003839 """
Neal Norwitzbcc0db82006-03-24 08:14:36 +00003840 return a.__truediv__(b, context=self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003841
3842 def divide_int(self, a, b):
3843 """Divides two numbers and returns the integer part of the result.
3844
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003845 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003846 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003847 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003848 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003849 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003850 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003851 """
3852 return a.__floordiv__(b, context=self)
3853
3854 def divmod(self, a, b):
3855 return a.__divmod__(b, context=self)
3856
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003857 def exp(self, a):
3858 """Returns e ** a.
3859
3860 >>> c = ExtendedContext.copy()
3861 >>> c.Emin = -999
3862 >>> c.Emax = 999
3863 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003864 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003865 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003866 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003867 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003868 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003869 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003870 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003871 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003872 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003873 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003874 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003875 """
3876 return a.exp(context=self)
3877
3878 def fma(self, a, b, c):
3879 """Returns a multiplied by b, plus c.
3880
3881 The first two operands are multiplied together, using multiply,
3882 the third operand is then added to the result of that
3883 multiplication, using add, all with only one final rounding.
3884
3885 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003886 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003887 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003888 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003889 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003890 Decimal('1.38435736E+12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003891 """
3892 return a.fma(b, c, context=self)
3893
3894 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003895 """Return True if the operand is canonical; otherwise return False.
3896
3897 Currently, the encoding of a Decimal instance is always
3898 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003899
3900 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003901 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003902 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003903 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003904
3905 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003906 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003907
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003908 A Decimal instance is considered finite if it is neither
3909 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003910
3911 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003912 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003913 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003914 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003915 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003916 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003917 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003918 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003919 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003920 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003921 """
3922 return a.is_finite()
3923
3924 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003925 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003926
3927 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003928 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003929 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003930 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003931 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003932 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003933 """
3934 return a.is_infinite()
3935
3936 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003937 """Return True if the operand is a qNaN or sNaN;
3938 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003939
3940 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003941 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003942 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003943 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003944 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003945 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003946 """
3947 return a.is_nan()
3948
3949 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003950 """Return True if the operand is a normal number;
3951 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003952
3953 >>> c = ExtendedContext.copy()
3954 >>> c.Emin = -999
3955 >>> c.Emax = 999
3956 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003957 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003958 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003959 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003960 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003961 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003962 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003963 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003964 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003965 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003966 """
3967 return a.is_normal(context=self)
3968
3969 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003970 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003971
3972 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003973 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003974 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003975 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003976 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003977 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003978 """
3979 return a.is_qnan()
3980
3981 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003982 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003983
3984 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003985 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003986 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003987 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003988 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003989 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003990 """
3991 return a.is_signed()
3992
3993 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003994 """Return True if the operand is a signaling NaN;
3995 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003996
3997 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003998 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003999 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004000 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004001 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004002 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004003 """
4004 return a.is_snan()
4005
4006 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004007 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004008
4009 >>> c = ExtendedContext.copy()
4010 >>> c.Emin = -999
4011 >>> c.Emax = 999
4012 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004013 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004014 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004015 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004016 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004017 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004018 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004019 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004020 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004021 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004022 """
4023 return a.is_subnormal(context=self)
4024
4025 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004026 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004027
4028 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004029 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004030 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004031 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004032 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004033 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004034 """
4035 return a.is_zero()
4036
4037 def ln(self, a):
4038 """Returns the natural (base e) logarithm of the operand.
4039
4040 >>> c = ExtendedContext.copy()
4041 >>> c.Emin = -999
4042 >>> c.Emax = 999
4043 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004044 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004045 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004046 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004047 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004048 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004049 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004050 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004051 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004052 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004053 """
4054 return a.ln(context=self)
4055
4056 def log10(self, a):
4057 """Returns the base 10 logarithm of the operand.
4058
4059 >>> c = ExtendedContext.copy()
4060 >>> c.Emin = -999
4061 >>> c.Emax = 999
4062 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004064 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004065 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004066 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004067 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004068 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004069 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004070 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004071 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004072 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004073 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004074 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004075 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004076 """
4077 return a.log10(context=self)
4078
4079 def logb(self, a):
4080 """ Returns the exponent of the magnitude of the operand's MSD.
4081
4082 The result is the integer which is the exponent of the magnitude
4083 of the most significant digit of the operand (as though the
4084 operand were truncated to a single digit while maintaining the
4085 value of that digit and without limiting the resulting exponent).
4086
4087 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004088 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004089 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004091 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004092 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004093 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004094 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004095 """
4096 return a.logb(context=self)
4097
4098 def logical_and(self, a, b):
4099 """Applies the logical operation 'and' between each operand's digits.
4100
4101 The operands must be both logical numbers.
4102
4103 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004104 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004105 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004106 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004107 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004108 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004109 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004110 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004111 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004112 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004113 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004114 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004115 """
4116 return a.logical_and(b, context=self)
4117
4118 def logical_invert(self, a):
4119 """Invert all the digits in the operand.
4120
4121 The operand must be a logical number.
4122
4123 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004124 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004125 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004126 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004127 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004128 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004129 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004130 Decimal('10101010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004131 """
4132 return a.logical_invert(context=self)
4133
4134 def logical_or(self, a, b):
4135 """Applies the logical operation 'or' between each operand's digits.
4136
4137 The operands must be both logical numbers.
4138
4139 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004140 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004141 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004142 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004143 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004144 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004145 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004146 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004147 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004148 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004149 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004150 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004151 """
4152 return a.logical_or(b, context=self)
4153
4154 def logical_xor(self, a, b):
4155 """Applies the logical operation 'xor' between each operand's digits.
4156
4157 The operands must be both logical numbers.
4158
4159 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004160 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004161 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004162 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004163 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004164 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004165 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004166 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004167 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004168 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004169 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004170 Decimal('1101')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004171 """
4172 return a.logical_xor(b, context=self)
4173
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004174 def max(self, a,b):
4175 """max compares two values numerically and returns the maximum.
4176
4177 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004178 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004179 operation. If they are numerically equal then the left-hand operand
4180 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004181 infinity) of the two operands is chosen as the result.
4182
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004183 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004184 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004185 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004186 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004187 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004188 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004189 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004190 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004191 """
4192 return a.max(b, context=self)
4193
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004194 def max_mag(self, a, b):
4195 """Compares the values numerically with their sign ignored."""
4196 return a.max_mag(b, context=self)
4197
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004198 def min(self, a,b):
4199 """min compares two values numerically and returns the minimum.
4200
4201 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004202 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004203 operation. If they are numerically equal then the left-hand operand
4204 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004205 infinity) of the two operands is chosen as the result.
4206
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004207 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004208 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004209 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004210 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004211 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004212 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004213 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004214 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004215 """
4216 return a.min(b, context=self)
4217
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004218 def min_mag(self, a, b):
4219 """Compares the values numerically with their sign ignored."""
4220 return a.min_mag(b, context=self)
4221
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004222 def minus(self, a):
4223 """Minus corresponds to unary prefix minus in Python.
4224
4225 The operation is evaluated using the same rules as subtract; the
4226 operation minus(a) is calculated as subtract('0', a) where the '0'
4227 has the same exponent as the operand.
4228
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004229 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004230 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004231 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004232 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004233 """
4234 return a.__neg__(context=self)
4235
4236 def multiply(self, a, b):
4237 """multiply multiplies two operands.
4238
4239 If either operand is a special value then the general rules apply.
4240 Otherwise, the operands are multiplied together ('long multiplication'),
4241 resulting in a number which may be as long as the sum of the lengths
4242 of the two operands.
4243
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004244 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004245 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004246 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004247 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004248 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004249 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004250 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004251 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004252 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004253 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004254 """
4255 return a.__mul__(b, context=self)
4256
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004257 def next_minus(self, a):
4258 """Returns the largest representable number smaller than a.
4259
4260 >>> c = ExtendedContext.copy()
4261 >>> c.Emin = -999
4262 >>> c.Emax = 999
4263 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004264 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004265 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004266 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004267 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004268 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004269 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004270 Decimal('9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004271 """
4272 return a.next_minus(context=self)
4273
4274 def next_plus(self, a):
4275 """Returns the smallest representable number larger than a.
4276
4277 >>> c = ExtendedContext.copy()
4278 >>> c.Emin = -999
4279 >>> c.Emax = 999
4280 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004281 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004282 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004283 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004284 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004285 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004286 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004287 Decimal('-9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004288 """
4289 return a.next_plus(context=self)
4290
4291 def next_toward(self, a, b):
4292 """Returns the number closest to a, in direction towards b.
4293
4294 The result is the closest representable number from the first
4295 operand (but not the first operand) that is in the direction
4296 towards the second operand, unless the operands have the same
4297 value.
4298
4299 >>> c = ExtendedContext.copy()
4300 >>> c.Emin = -999
4301 >>> c.Emax = 999
4302 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004303 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004304 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004305 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004306 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004307 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004308 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004309 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004310 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004311 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004312 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004313 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004314 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004315 Decimal('-0.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004316 """
4317 return a.next_toward(b, context=self)
4318
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004319 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004320 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004321
4322 Essentially a plus operation with all trailing zeros removed from the
4323 result.
4324
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004325 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004326 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004327 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004328 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004329 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004330 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004331 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004332 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004333 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004334 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004335 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004336 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004337 """
4338 return a.normalize(context=self)
4339
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004340 def number_class(self, a):
4341 """Returns an indication of the class of the operand.
4342
4343 The class is one of the following strings:
4344 -sNaN
4345 -NaN
4346 -Infinity
4347 -Normal
4348 -Subnormal
4349 -Zero
4350 +Zero
4351 +Subnormal
4352 +Normal
4353 +Infinity
4354
4355 >>> c = Context(ExtendedContext)
4356 >>> c.Emin = -999
4357 >>> c.Emax = 999
4358 >>> c.number_class(Decimal('Infinity'))
4359 '+Infinity'
4360 >>> c.number_class(Decimal('1E-10'))
4361 '+Normal'
4362 >>> c.number_class(Decimal('2.50'))
4363 '+Normal'
4364 >>> c.number_class(Decimal('0.1E-999'))
4365 '+Subnormal'
4366 >>> c.number_class(Decimal('0'))
4367 '+Zero'
4368 >>> c.number_class(Decimal('-0'))
4369 '-Zero'
4370 >>> c.number_class(Decimal('-0.1E-999'))
4371 '-Subnormal'
4372 >>> c.number_class(Decimal('-1E-10'))
4373 '-Normal'
4374 >>> c.number_class(Decimal('-2.50'))
4375 '-Normal'
4376 >>> c.number_class(Decimal('-Infinity'))
4377 '-Infinity'
4378 >>> c.number_class(Decimal('NaN'))
4379 'NaN'
4380 >>> c.number_class(Decimal('-NaN'))
4381 'NaN'
4382 >>> c.number_class(Decimal('sNaN'))
4383 'sNaN'
4384 """
4385 return a.number_class(context=self)
4386
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004387 def plus(self, a):
4388 """Plus corresponds to unary prefix plus in Python.
4389
4390 The operation is evaluated using the same rules as add; the
4391 operation plus(a) is calculated as add('0', a) where the '0'
4392 has the same exponent as the operand.
4393
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004394 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004395 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004396 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004397 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004398 """
4399 return a.__pos__(context=self)
4400
4401 def power(self, a, b, modulo=None):
4402 """Raises a to the power of b, to modulo if given.
4403
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404 With two arguments, compute a**b. If a is negative then b
4405 must be integral. The result will be inexact unless b is
4406 integral and the result is finite and can be expressed exactly
4407 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004408
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409 With three arguments, compute (a**b) % modulo. For the
4410 three argument form, the following restrictions on the
4411 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004412
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004413 - all three arguments must be integral
4414 - b must be nonnegative
4415 - at least one of a or b must be nonzero
4416 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004417
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 The result of pow(a, b, modulo) is identical to the result
4419 that would be obtained by computing (a**b) % modulo with
4420 unbounded precision, but is computed more efficiently. It is
4421 always exact.
4422
4423 >>> c = ExtendedContext.copy()
4424 >>> c.Emin = -999
4425 >>> c.Emax = 999
4426 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004427 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004428 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004429 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004430 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004431 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004432 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004433 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004434 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004435 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004436 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004437 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004438 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004439 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004440 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004441 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004442 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004443 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004444 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004445 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004446 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004447 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004448 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004449 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004450 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004451 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452
4453 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004454 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004455 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004456 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004457 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004458 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004459 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004460 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004461 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004462 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004463 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004464 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004465 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004466 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004467 """
4468 return a.__pow__(b, modulo, context=self)
4469
4470 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004471 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004472
4473 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00004474 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004475 exponent is being increased), multiplied by a positive power of ten (if
4476 the exponent is being decreased), or is unchanged (if the exponent is
4477 already equal to that of the right-hand operand).
4478
4479 Unlike other operations, if the length of the coefficient after the
4480 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00004481 operation condition is raised. This guarantees that, unless there is
4482 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004483 equal to that of the right-hand operand.
4484
4485 Also unlike other operations, quantize will never raise Underflow, even
4486 if the result is subnormal and inexact.
4487
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004488 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004489 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004490 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004491 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004492 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004493 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004494 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004495 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004496 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004497 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004498 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004499 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004500 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004501 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004502 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004503 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004504 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004505 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004506 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004507 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004508 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004509 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004510 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004511 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004512 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004513 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004514 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004515 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004516 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004517 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004518 """
4519 return a.quantize(b, context=self)
4520
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004521 def radix(self):
4522 """Just returns 10, as this is Decimal, :)
4523
4524 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004525 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004526 """
4527 return Decimal(10)
4528
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004529 def remainder(self, a, b):
4530 """Returns the remainder from integer division.
4531
4532 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00004533 calculating integer division as described for divide-integer, rounded
4534 to precision digits if necessary. The sign of the result, if
4535 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004536
4537 This operation will fail under the same conditions as integer division
4538 (that is, if integer division on the same two operands would fail, the
4539 remainder cannot be calculated).
4540
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004541 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004542 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004543 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004544 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004545 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004546 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004547 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004548 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004549 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004550 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004551 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004552 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004553 """
4554 return a.__mod__(b, context=self)
4555
4556 def remainder_near(self, a, b):
4557 """Returns to be "a - b * n", where n is the integer nearest the exact
4558 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00004559 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004560 sign of a.
4561
4562 This operation will fail under the same conditions as integer division
4563 (that is, if integer division on the same two operands would fail, the
4564 remainder cannot be calculated).
4565
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004566 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004567 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004568 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004569 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004570 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004571 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004572 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004573 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004574 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004575 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004576 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004577 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004578 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004579 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004580 """
4581 return a.remainder_near(b, context=self)
4582
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004583 def rotate(self, a, b):
4584 """Returns a rotated copy of a, b times.
4585
4586 The coefficient of the result is a rotated copy of the digits in
4587 the coefficient of the first operand. The number of places of
4588 rotation is taken from the absolute value of the second operand,
4589 with the rotation being to the left if the second operand is
4590 positive or to the right otherwise.
4591
4592 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004593 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004594 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004595 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004596 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004597 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004598 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004599 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004600 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('345678912')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004602 """
4603 return a.rotate(b, context=self)
4604
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004605 def same_quantum(self, a, b):
4606 """Returns True if the two operands have the same exponent.
4607
4608 The result is never affected by either the sign or the coefficient of
4609 either operand.
4610
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004611 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004612 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004613 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004614 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004615 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004616 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004617 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004618 True
4619 """
4620 return a.same_quantum(b)
4621
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004622 def scaleb (self, a, b):
4623 """Returns the first operand after adding the second value its exp.
4624
4625 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004626 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004627 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('7.50E+3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004631 """
4632 return a.scaleb (b, context=self)
4633
4634 def shift(self, a, b):
4635 """Returns a shifted copy of a, b times.
4636
4637 The coefficient of the result is a shifted copy of the digits
4638 in the coefficient of the first operand. The number of places
4639 to shift is taken from the absolute value of the second operand,
4640 with the shift being to the left if the second operand is
4641 positive or to the right otherwise. Digits shifted into the
4642 coefficient are zeros.
4643
4644 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004645 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004646 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004647 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004648 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004650 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('345678900')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 """
4655 return a.shift(b, context=self)
4656
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004657 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004658 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004659
4660 If the result must be inexact, it is rounded using the round-half-even
4661 algorithm.
4662
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004663 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004664 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004665 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004666 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004667 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004668 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004669 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004670 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004671 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004672 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004677 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004679 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004680 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004681 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004682 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004683 """
4684 return a.sqrt(context=self)
4685
4686 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004687 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004688
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004689 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004690 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004691 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004692 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004693 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004694 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004695 """
4696 return a.__sub__(b, context=self)
4697
4698 def to_eng_string(self, a):
4699 """Converts a number to a string, using scientific notation.
4700
4701 The operation is not affected by the context.
4702 """
4703 return a.to_eng_string(context=self)
4704
4705 def to_sci_string(self, a):
4706 """Converts a number to a string, using scientific notation.
4707
4708 The operation is not affected by the context.
4709 """
4710 return a.__str__(context=self)
4711
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004712 def to_integral_exact(self, a):
4713 """Rounds to an integer.
4714
4715 When the operand has a negative exponent, the result is the same
4716 as using the quantize() operation using the given operand as the
4717 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4718 of the operand as the precision setting; Inexact and Rounded flags
4719 are allowed in this operation. The rounding mode is taken from the
4720 context.
4721
4722 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004723 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004724 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004725 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004726 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004727 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004728 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004729 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004730 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004731 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004732 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004733 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004734 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004735 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004736 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004737 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004738 """
4739 return a.to_integral_exact(context=self)
4740
4741 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004742 """Rounds to an integer.
4743
4744 When the operand has a negative exponent, the result is the same
4745 as using the quantize() operation using the given operand as the
4746 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4747 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00004748 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004749
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004750 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004751 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004752 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004753 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004754 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004755 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004756 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004757 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004758 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004759 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004760 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004761 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004762 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004763 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004764 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004765 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004766 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004767 return a.to_integral_value(context=self)
4768
4769 # the method name changed, but we provide also the old one, for compatibility
4770 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004771
4772class _WorkRep(object):
4773 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004774 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004775 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004776 # exp: None, int, or string
4777
4778 def __init__(self, value=None):
4779 if value is None:
4780 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004781 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004782 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004783 elif isinstance(value, Decimal):
4784 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00004785 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004786 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004787 else:
4788 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004789 self.sign = value[0]
4790 self.int = value[1]
4791 self.exp = value[2]
4792
4793 def __repr__(self):
4794 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4795
4796 __str__ = __repr__
4797
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004798
4799
Christian Heimes2c181612007-12-17 20:04:13 +00004800def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004801 """Normalizes op1, op2 to have the same exp and length of coefficient.
4802
4803 Done during addition.
4804 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004805 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004806 tmp = op2
4807 other = op1
4808 else:
4809 tmp = op1
4810 other = op2
4811
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004812 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4813 # Then adding 10**exp to tmp has the same effect (after rounding)
4814 # as adding any positive quantity smaller than 10**exp; similarly
4815 # for subtraction. So if other is smaller than 10**exp we replace
4816 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00004817 tmp_len = len(str(tmp.int))
4818 other_len = len(str(other.int))
4819 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4820 if other_len + other.exp - 1 < exp:
4821 other.int = 1
4822 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004823
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004824 tmp.int *= 10 ** (tmp.exp - other.exp)
4825 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004826 return op1, op2
4827
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004828##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004829
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004830# This function from Tim Peters was taken from here:
4831# http://mail.python.org/pipermail/python-list/1999-July/007758.html
4832# The correction being in the function definition is for speed, and
4833# the whole function is not resolved with math.log because of avoiding
4834# the use of floats.
4835def _nbits(n, correction = {
4836 '0': 4, '1': 3, '2': 2, '3': 2,
4837 '4': 1, '5': 1, '6': 1, '7': 1,
4838 '8': 0, '9': 0, 'a': 0, 'b': 0,
4839 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
4840 """Number of bits in binary representation of the positive integer n,
4841 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004842 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004843 if n < 0:
4844 raise ValueError("The argument to _nbits should be nonnegative.")
4845 hex_n = "%x" % n
4846 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004847
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004848def _sqrt_nearest(n, a):
4849 """Closest integer to the square root of the positive integer n. a is
4850 an initial approximation to the square root. Any positive integer
4851 will do for a, but the closer a is to the square root of n the
4852 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004853
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004854 """
4855 if n <= 0 or a <= 0:
4856 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
4857
4858 b=0
4859 while a != b:
4860 b, a = a, a--n//a>>1
4861 return a
4862
4863def _rshift_nearest(x, shift):
4864 """Given an integer x and a nonnegative integer shift, return closest
4865 integer to x / 2**shift; use round-to-even in case of a tie.
4866
4867 """
4868 b, q = 1 << shift, x >> shift
4869 return q + (2*(x & (b-1)) + (q&1) > b)
4870
4871def _div_nearest(a, b):
4872 """Closest integer to a/b, a and b positive integers; rounds to even
4873 in the case of a tie.
4874
4875 """
4876 q, r = divmod(a, b)
4877 return q + (2*r + (q&1) > b)
4878
4879def _ilog(x, M, L = 8):
4880 """Integer approximation to M*log(x/M), with absolute error boundable
4881 in terms only of x/M.
4882
4883 Given positive integers x and M, return an integer approximation to
4884 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
4885 between the approximation and the exact result is at most 22. For
4886 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
4887 both cases these are upper bounds on the error; it will usually be
4888 much smaller."""
4889
4890 # The basic algorithm is the following: let log1p be the function
4891 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
4892 # the reduction
4893 #
4894 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
4895 #
4896 # repeatedly until the argument to log1p is small (< 2**-L in
4897 # absolute value). For small y we can use the Taylor series
4898 # expansion
4899 #
4900 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
4901 #
4902 # truncating at T such that y**T is small enough. The whole
4903 # computation is carried out in a form of fixed-point arithmetic,
4904 # with a real number z being represented by an integer
4905 # approximation to z*M. To avoid loss of precision, the y below
4906 # is actually an integer approximation to 2**R*y*M, where R is the
4907 # number of reductions performed so far.
4908
4909 y = x-M
4910 # argument reduction; R = number of reductions performed
4911 R = 0
4912 while (R <= L and abs(y) << L-R >= M or
4913 R > L and abs(y) >> R-L >= M):
4914 y = _div_nearest((M*y) << 1,
4915 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
4916 R += 1
4917
4918 # Taylor series with T terms
4919 T = -int(-10*len(str(M))//(3*L))
4920 yshift = _rshift_nearest(y, R)
4921 w = _div_nearest(M, T)
4922 for k in range(T-1, 0, -1):
4923 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
4924
4925 return _div_nearest(w*y, M)
4926
4927def _dlog10(c, e, p):
4928 """Given integers c, e and p with c > 0, p >= 0, compute an integer
4929 approximation to 10**p * log10(c*10**e), with an absolute error of
4930 at most 1. Assumes that c*10**e is not exactly 1."""
4931
4932 # increase precision by 2; compensate for this by dividing
4933 # final result by 100
4934 p += 2
4935
4936 # write c*10**e as d*10**f with either:
4937 # f >= 0 and 1 <= d <= 10, or
4938 # f <= 0 and 0.1 <= d <= 1.
4939 # Thus for c*10**e close to 1, f = 0
4940 l = len(str(c))
4941 f = e+l - (e+l >= 1)
4942
4943 if p > 0:
4944 M = 10**p
4945 k = e+p-f
4946 if k >= 0:
4947 c *= 10**k
4948 else:
4949 c = _div_nearest(c, 10**-k)
4950
4951 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004952 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004953 log_d = _div_nearest(log_d*M, log_10)
4954 log_tenpower = f*M # exact
4955 else:
4956 log_d = 0 # error < 2.31
4957 log_tenpower = div_nearest(f, 10**-p) # error < 0.5
4958
4959 return _div_nearest(log_tenpower+log_d, 100)
4960
4961def _dlog(c, e, p):
4962 """Given integers c, e and p with c > 0, compute an integer
4963 approximation to 10**p * log(c*10**e), with an absolute error of
4964 at most 1. Assumes that c*10**e is not exactly 1."""
4965
4966 # Increase precision by 2. The precision increase is compensated
4967 # for at the end with a division by 100.
4968 p += 2
4969
4970 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
4971 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
4972 # as 10**p * log(d) + 10**p*f * log(10).
4973 l = len(str(c))
4974 f = e+l - (e+l >= 1)
4975
4976 # compute approximation to 10**p*log(d), with error < 27
4977 if p > 0:
4978 k = e+p-f
4979 if k >= 0:
4980 c *= 10**k
4981 else:
4982 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
4983
4984 # _ilog magnifies existing error in c by a factor of at most 10
4985 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
4986 else:
4987 # p <= 0: just approximate the whole thing by 0; error < 2.31
4988 log_d = 0
4989
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004990 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004991 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004992 extra = len(str(abs(f)))-1
4993 if p + extra >= 0:
4994 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
4995 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
4996 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004997 else:
4998 f_log_ten = 0
4999 else:
5000 f_log_ten = 0
5001
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005002 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005003 return _div_nearest(f_log_ten + log_d, 100)
5004
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005005class _Log10Memoize(object):
5006 """Class to compute, store, and allow retrieval of, digits of the
5007 constant log(10) = 2.302585.... This constant is needed by
5008 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5009 def __init__(self):
5010 self.digits = "23025850929940456840179914546843642076011014886"
5011
5012 def getdigits(self, p):
5013 """Given an integer p >= 0, return floor(10**p)*log(10).
5014
5015 For example, self.getdigits(3) returns 2302.
5016 """
5017 # digits are stored as a string, for quick conversion to
5018 # integer in the case that we've already computed enough
5019 # digits; the stored digits should always be correct
5020 # (truncated, not rounded to nearest).
5021 if p < 0:
5022 raise ValueError("p should be nonnegative")
5023
5024 if p >= len(self.digits):
5025 # compute p+3, p+6, p+9, ... digits; continue until at
5026 # least one of the extra digits is nonzero
5027 extra = 3
5028 while True:
5029 # compute p+extra digits, correct to within 1ulp
5030 M = 10**(p+extra+2)
5031 digits = str(_div_nearest(_ilog(10*M, M), 100))
5032 if digits[-extra:] != '0'*extra:
5033 break
5034 extra += 3
5035 # keep all reliable digits so far; remove trailing zeros
5036 # and next nonzero digit
5037 self.digits = digits.rstrip('0')[:-1]
5038 return int(self.digits[:p+1])
5039
5040_log10_digits = _Log10Memoize().getdigits
5041
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005042def _iexp(x, M, L=8):
5043 """Given integers x and M, M > 0, such that x/M is small in absolute
5044 value, compute an integer approximation to M*exp(x/M). For 0 <=
5045 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5046 is usually much smaller)."""
5047
5048 # Algorithm: to compute exp(z) for a real number z, first divide z
5049 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5050 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5051 # series
5052 #
5053 # expm1(x) = x + x**2/2! + x**3/3! + ...
5054 #
5055 # Now use the identity
5056 #
5057 # expm1(2x) = expm1(x)*(expm1(x)+2)
5058 #
5059 # R times to compute the sequence expm1(z/2**R),
5060 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5061
5062 # Find R such that x/2**R/M <= 2**-L
5063 R = _nbits((x<<L)//M)
5064
5065 # Taylor series. (2**L)**T > M
5066 T = -int(-10*len(str(M))//(3*L))
5067 y = _div_nearest(x, T)
5068 Mshift = M<<R
5069 for i in range(T-1, 0, -1):
5070 y = _div_nearest(x*(Mshift + y), Mshift * i)
5071
5072 # Expansion
5073 for k in range(R-1, -1, -1):
5074 Mshift = M<<(k+2)
5075 y = _div_nearest(y*(y+Mshift), Mshift)
5076
5077 return M+y
5078
5079def _dexp(c, e, p):
5080 """Compute an approximation to exp(c*10**e), with p decimal places of
5081 precision.
5082
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005083 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005084
5085 10**(p-1) <= d <= 10**p, and
5086 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5087
5088 In other words, d*10**f is an approximation to exp(c*10**e) with p
5089 digits of precision, and with an error in d of at most 1. This is
5090 almost, but not quite, the same as the error being < 1ulp: when d
5091 = 10**(p-1) the error could be up to 10 ulp."""
5092
5093 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5094 p += 2
5095
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005096 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005097 extra = max(0, e + len(str(c)) - 1)
5098 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005099
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005100 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005101 # rounding down
5102 shift = e+q
5103 if shift >= 0:
5104 cshift = c*10**shift
5105 else:
5106 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005107 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005108
5109 # reduce remainder back to original precision
5110 rem = _div_nearest(rem, 10**extra)
5111
5112 # error in result of _iexp < 120; error after division < 0.62
5113 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5114
5115def _dpower(xc, xe, yc, ye, p):
5116 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5117 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5118
5119 10**(p-1) <= c <= 10**p, and
5120 (c-1)*10**e < x**y < (c+1)*10**e
5121
5122 in other words, c*10**e is an approximation to x**y with p digits
5123 of precision, and with an error in c of at most 1. (This is
5124 almost, but not quite, the same as the error being < 1ulp: when c
5125 == 10**(p-1) we can only guarantee error < 10ulp.)
5126
5127 We assume that: x is positive and not equal to 1, and y is nonzero.
5128 """
5129
5130 # Find b such that 10**(b-1) <= |y| <= 10**b
5131 b = len(str(abs(yc))) + ye
5132
5133 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5134 lxc = _dlog(xc, xe, p+b+1)
5135
5136 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5137 shift = ye-b
5138 if shift >= 0:
5139 pc = lxc*yc*10**shift
5140 else:
5141 pc = _div_nearest(lxc*yc, 10**-shift)
5142
5143 if pc == 0:
5144 # we prefer a result that isn't exactly 1; this makes it
5145 # easier to compute a correctly rounded result in __pow__
5146 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5147 coeff, exp = 10**(p-1)+1, 1-p
5148 else:
5149 coeff, exp = 10**p-1, -p
5150 else:
5151 coeff, exp = _dexp(pc, -(p+1), p+1)
5152 coeff = _div_nearest(coeff, 10)
5153 exp += 1
5154
5155 return coeff, exp
5156
5157def _log10_lb(c, correction = {
5158 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5159 '6': 23, '7': 16, '8': 10, '9': 5}):
5160 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5161 if c <= 0:
5162 raise ValueError("The argument to _log10_lb should be nonnegative.")
5163 str_c = str(c)
5164 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005165
Guido van Rossumd8faa362007-04-27 19:54:29 +00005166##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005167
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005168def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005169 """Convert other to Decimal.
5170
5171 Verifies that it's ok to use in an implicit construction.
5172 """
5173 if isinstance(other, Decimal):
5174 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005175 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005176 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005177 if raiseit:
5178 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005179 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005180
Guido van Rossumd8faa362007-04-27 19:54:29 +00005181##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005182
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005183# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005184# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005185
5186DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005187 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005188 traps=[DivisionByZero, Overflow, InvalidOperation],
5189 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005190 Emax=999999999,
5191 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005192 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005193)
5194
5195# Pre-made alternate contexts offered by the specification
5196# Don't change these; the user should be able to select these
5197# contexts and be able to reproduce results from other implementations
5198# of the spec.
5199
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005200BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005201 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005202 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5203 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005204)
5205
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005206ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005207 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005208 traps=[],
5209 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005210)
5211
5212
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005213##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005214#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005215# Regular expression used for parsing numeric strings. Additional
5216# comments:
5217#
5218# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5219# whitespace. But note that the specification disallows whitespace in
5220# a numeric string.
5221#
5222# 2. For finite numbers (not infinities and NaNs) the body of the
5223# number between the optional sign and the optional exponent must have
5224# at least one decimal digit, possibly after the decimal point. The
5225# lookahead expression '(?=\d|\.\d)' checks this.
5226#
5227# As the flag UNICODE is not enabled here, we're explicitly avoiding any
5228# other meaning for \d than the numbers [0-9].
5229
5230import re
5231_parser = re.compile(r""" # A numeric string consists of:
5232# \s*
5233 (?P<sign>[-+])? # an optional sign, followed by either...
5234 (
5235 (?=\d|\.\d) # ...a number (with at least one digit)
5236 (?P<int>\d*) # consisting of a (possibly empty) integer part
5237 (\.(?P<frac>\d*))? # followed by an optional fractional part
5238 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
5239 |
5240 Inf(inity)? # ...an infinity, or...
5241 |
5242 (?P<signal>s)? # ...an (optionally signaling)
5243 NaN # NaN
5244 (?P<diag>\d*) # with (possibly empty) diagnostic information.
5245 )
5246# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005247 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005248""", re.VERBOSE | re.IGNORECASE).match
5249
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005250_all_zeros = re.compile('0*$').match
5251_exact_half = re.compile('50*$').match
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005252del re
5253
5254
Guido van Rossumd8faa362007-04-27 19:54:29 +00005255##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005256
Guido van Rossumd8faa362007-04-27 19:54:29 +00005257# Reusable defaults
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005258Inf = Decimal('Inf')
5259negInf = Decimal('-Inf')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005260NaN = Decimal('NaN')
5261Dec_0 = Decimal(0)
5262Dec_p1 = Decimal(1)
5263Dec_n1 = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005264
Guido van Rossumd8faa362007-04-27 19:54:29 +00005265# Infsign[sign] is infinity w/ that sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005266Infsign = (Inf, negInf)
5267
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005268
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005269
5270if __name__ == '__main__':
5271 import doctest, sys
5272 doctest.testmod(sys.modules[__name__])