blob: c3dffa3ed7b353f4b36a29ad1bc71a3400bb07ac [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Facundo Batista6ab24792009-02-16 15:41:37 +000010# This module should be kept in sync with the latest updates of the
11# IBM specification as it evolves. Those updates will be treated
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000012# as bug fixes (deviation from the spec is a compatibility, usability
13# bug) and will be backported. At this point the spec is stabilizing
14# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000015
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000016"""
Facundo Batista6ab24792009-02-16 15:41:37 +000017This is an implementation of decimal floating point arithmetic based on
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000018the General Decimal Arithmetic Specification:
19
Raymond Hettinger960dc362009-04-21 03:43:15 +000020 http://speleotrove.com/decimal/decarith.html
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000021
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000022and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000023
24 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
25
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000026Decimal floating point has finite precision with arbitrarily large bounds.
27
Guido van Rossumd8faa362007-04-27 19:54:29 +000028The purpose of this module is to support arithmetic using familiar
29"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030issues associated with binary floating point. The package is especially
31useful for financial applications or for contexts where users have
32expectations that are at odds with binary floating point (for instance,
33in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Mark Dickinsonaa63c4d2010-06-12 16:37:53 +000034of 0.0; Decimal('1.00') % Decimal('0.1') returns the expected
35Decimal('0.00')).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000036
37Here are some examples of using the decimal module:
38
39>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000040>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000041>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000042Decimal('0')
43>>> Decimal('1')
44Decimal('1')
45>>> Decimal('-.0123')
46Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000047>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000048Decimal('123456')
49>>> Decimal('123.45e12345678901234567890')
50Decimal('1.2345E+12345678901234567892')
51>>> Decimal('1.33') + Decimal('1.27')
52Decimal('2.60')
53>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
54Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000055>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000056>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000570.333333333
58>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000059>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000600.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000061>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621
Guido van Rossum7131f842007-02-09 20:13:25 +000063>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000641.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000065>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000664.85192780976896427E+58
67>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000068>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000069Infinity
70>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000071>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000072-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000073>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000074NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000075>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000076-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000077>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000078Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000079>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000080>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000081Traceback (most recent call last):
82 ...
83 ...
84 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000085decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000086>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000087>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000088>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000890
90>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000091Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000092>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000093>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000095>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000096>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Guido van Rossum7131f842007-02-09 20:13:25 +000098>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000099Traceback (most recent call last):
100 ...
101 ...
102 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000103decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000104>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001051
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000107>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000108>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000109NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000110>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
112>>>
113"""
114
115__all__ = [
116 # Two major classes
117 'Decimal', 'Context',
118
119 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000120 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000121
122 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000123 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
124 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000125
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000126 # Constants for use in setting up contexts
127 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000128 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129
130 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000131 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132]
133
Raymond Hettinger960dc362009-04-21 03:43:15 +0000134__version__ = '1.70' # Highest version of the spec this complies with
135
Raymond Hettingereb260842005-06-07 18:52:34 +0000136import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000137import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000138import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000139
Christian Heimes25bb7832008-01-11 16:17:00 +0000140try:
141 from collections import namedtuple as _namedtuple
142 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
143except ImportError:
144 DecimalTuple = lambda *args: args
145
Guido van Rossumd8faa362007-04-27 19:54:29 +0000146# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000147ROUND_DOWN = 'ROUND_DOWN'
148ROUND_HALF_UP = 'ROUND_HALF_UP'
149ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
150ROUND_CEILING = 'ROUND_CEILING'
151ROUND_FLOOR = 'ROUND_FLOOR'
152ROUND_UP = 'ROUND_UP'
153ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000154ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000155
Guido van Rossumd8faa362007-04-27 19:54:29 +0000156# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000159 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161 Used exceptions derive from this.
162 If an exception derives from another exception besides this (such as
163 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
164 called if the others are present. This isn't actually used for
165 anything, though.
166
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000167 handle -- Called when context._raise_error is called and the
Stefan Krah2eb4a072010-05-19 15:52:31 +0000168 trap_enabler is not set. First argument is self, second is the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000169 context. More arguments can be given, those being after
170 the explanation in _raise_error (For example,
171 context._raise_error(NewError, '(-x)!', self._sign) would
172 call NewError().handle(context, self._sign).)
173
174 To define a new exception, it should be sufficient to have it derive
175 from DecimalException.
176 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 def handle(self, context, *args):
178 pass
179
180
181class Clamped(DecimalException):
182 """Exponent of a 0 changed to fit bounds.
183
184 This occurs and signals clamped if the exponent of a result has been
185 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000186 representation. This may occur when the exponent of a zero result would
187 be outside the bounds of a representation, or when a large normal
188 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000189 this latter case, the exponent is reduced to fit and the corresponding
190 number of zero digits are appended to the coefficient ("fold-down").
191 """
192
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000193class InvalidOperation(DecimalException):
194 """An invalid operation was performed.
195
196 Various bad things cause this:
197
198 Something creates a signaling NaN
199 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000200 0 * (+-)INF
201 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000202 x % 0
203 (+-)INF % x
204 x._rescale( non-integer )
205 sqrt(-x) , x > 0
206 0 ** 0
207 x ** (non-integer)
208 x ** (+-)INF
209 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000210
211 The result of the operation after these is a quiet positive NaN,
212 except when the cause is a signaling NaN, in which case the result is
213 also a quiet NaN, but with the original sign, and an optional
214 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000215 """
216 def handle(self, context, *args):
217 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000218 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
219 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000220 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000221
222class ConversionSyntax(InvalidOperation):
223 """Trying to convert badly formed string.
224
225 This occurs and signals invalid-operation if an string is being
226 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000227 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000229 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000230 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231
232class DivisionByZero(DecimalException, ZeroDivisionError):
233 """Division by 0.
234
235 This occurs and signals division-by-zero if division of a finite number
236 by zero was attempted (during a divide-integer or divide operation, or a
237 power operation with negative right-hand operand), and the dividend was
238 not zero.
239
240 The result of the operation is [sign,inf], where sign is the exclusive
241 or of the signs of the operands for divide, or is 1 for an odd power of
242 -0, for power.
243 """
244
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000245 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000246 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000247
248class DivisionImpossible(InvalidOperation):
249 """Cannot perform the division adequately.
250
251 This occurs and signals invalid-operation if the integer result of a
252 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000253 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000254 """
255
256 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000257 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000258
259class DivisionUndefined(InvalidOperation, ZeroDivisionError):
260 """Undefined result of division.
261
262 This occurs and signals invalid-operation if division by zero was
263 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000264 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000265 """
266
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000267 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000268 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000269
270class Inexact(DecimalException):
271 """Had to round, losing information.
272
273 This occurs and signals inexact whenever the result of an operation is
274 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000275 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000276 result in all cases is unchanged.
277
278 The inexact signal may be tested (or trapped) to determine if a given
279 operation (or sequence of operations) was inexact.
280 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000281
282class InvalidContext(InvalidOperation):
283 """Invalid context. Unknown rounding, for example.
284
285 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000286 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000287 on creation and either the precision exceeds the capability of the
288 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000289 was specified. These aspects of the context need only be checked when
290 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000291 """
292
293 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000294 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000295
296class Rounded(DecimalException):
297 """Number got rounded (not necessarily changed during rounding).
298
299 This occurs and signals rounded whenever the result of an operation is
300 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000301 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000302 result in all cases is unchanged.
303
304 The rounded signal may be tested (or trapped) to determine if a given
305 operation (or sequence of operations) caused a loss of precision.
306 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000307
308class Subnormal(DecimalException):
309 """Exponent < Emin before rounding.
310
311 This occurs and signals subnormal whenever the result of a conversion or
312 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000313 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000314
315 The subnormal signal may be tested (or trapped) to determine if a given
316 or operation (or sequence of operations) yielded a subnormal result.
317 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000318
319class Overflow(Inexact, Rounded):
320 """Numerical overflow.
321
322 This occurs and signals overflow if the adjusted exponent of a result
323 (from a conversion or from an operation that is not an attempt to divide
324 by zero), after rounding, would be greater than the largest value that
325 can be handled by the implementation (the value Emax).
326
327 The result depends on the rounding mode:
328
329 For round-half-up and round-half-even (and for round-half-down and
330 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000331 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000332 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000333 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000334 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000335 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000336 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000337 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000338 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000339 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000340
341 def handle(self, context, sign, *args):
342 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000343 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000347 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000348 return _dec_from_triple(sign, '9'*context.prec,
349 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000350 if sign == 1:
351 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000352 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000353 return _dec_from_triple(sign, '9'*context.prec,
354 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000355
356
357class Underflow(Inexact, Rounded, Subnormal):
358 """Numerical underflow with result rounded to 0.
359
360 This occurs and signals underflow if a result is inexact and the
361 adjusted exponent of the result would be smaller (more negative) than
362 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000363 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364
365 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000366 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367 in 0 with the sign of the intermediate result and an exponent of Etiny.
368
369 In all cases, Inexact, Rounded, and Subnormal will also be raised.
370 """
371
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000372# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000373_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000374 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000375
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000376# Map conditions (per the spec) to signals
377_condition_map = {ConversionSyntax:InvalidOperation,
378 DivisionImpossible:InvalidOperation,
379 DivisionUndefined:InvalidOperation,
380 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000381
Guido van Rossumd8faa362007-04-27 19:54:29 +0000382##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000383
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000384# The getcontext() and setcontext() function manage access to a thread-local
385# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000386# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000387# work for older Pythons. If threads are not part of the build, create a
388# mock threading object with threading.local() returning the module namespace.
389
390try:
391 import threading
392except ImportError:
393 # Python was compiled without threads; create a mock object instead
394 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000395 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000396 def local(self, sys=sys):
397 return sys.modules[__name__]
398 threading = MockThreading()
399 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401try:
402 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000405
Guido van Rossumd8faa362007-04-27 19:54:29 +0000406 # To fix reloading, force it to create a new context
407 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000408 if hasattr(threading.current_thread(), '__decimal_context__'):
409 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000410
411 def setcontext(context):
412 """Set this thread's context to context."""
413 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000414 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000415 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000416 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000417
418 def getcontext():
419 """Returns this thread's context.
420
421 If this thread does not yet have a context, returns
422 a new context and sets this thread's context.
423 New contexts are copies of DefaultContext.
424 """
425 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000426 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000427 except AttributeError:
428 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000429 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000430 return context
431
432else:
433
434 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000435 if hasattr(local, '__decimal_context__'):
436 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000437
438 def getcontext(_local=local):
439 """Returns this thread's context.
440
441 If this thread does not yet have a context, returns
442 a new context and sets this thread's context.
443 New contexts are copies of DefaultContext.
444 """
445 try:
446 return _local.__decimal_context__
447 except AttributeError:
448 context = Context()
449 _local.__decimal_context__ = context
450 return context
451
452 def setcontext(context, _local=local):
453 """Set this thread's context to context."""
454 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000455 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000456 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000457 _local.__decimal_context__ = context
458
459 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000460
Thomas Wouters89f507f2006-12-13 04:49:30 +0000461def localcontext(ctx=None):
462 """Return a context manager for a copy of the supplied context
463
464 Uses a copy of the current context if no context is specified
465 The returned context manager creates a local decimal context
466 in a with statement:
467 def sin(x):
468 with localcontext() as ctx:
469 ctx.prec += 2
470 # Rest of sin calculation algorithm
471 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000472 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000473
474 def sin(x):
475 with localcontext(ExtendedContext):
476 # Rest of sin calculation algorithm
477 # uses the Extended Context from the
478 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000479 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000480
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000481 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000482 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000483 28
484 >>> with localcontext():
485 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000486 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000487 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000488 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000489 30
490 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000491 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000492 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000493 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000494 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000495 28
496 """
497 if ctx is None: ctx = getcontext()
498 return _ContextManager(ctx)
499
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000500
Guido van Rossumd8faa362007-04-27 19:54:29 +0000501##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000502
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000503# Do not subclass Decimal from numbers.Real and do not register it as such
504# (because Decimals are not interoperable with floats). See the notes in
505# numbers.py for more detail.
506
507class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000508 """Floating point class for decimal arithmetic."""
509
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000510 __slots__ = ('_exp','_int','_sign', '_is_special')
511 # Generally, the value of the Decimal instance is given by
512 # (-1)**_sign * _int * 10**_exp
513 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000514
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000515 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000516 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000517 """Create a decimal point instance.
518
519 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000520 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000521 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000522 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000523 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000524 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000525 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000526 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000527 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000528 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000530
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000531 # Note that the coefficient, self._int, is actually stored as
532 # a string rather than as a tuple of digits. This speeds up
533 # the "digits to integer" and "integer to digits" conversions
534 # that are used in almost every arithmetic operation on
535 # Decimals. This is an internal detail: the as_tuple function
536 # and the Decimal constructor still deal with tuples of
537 # digits.
538
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000540
Christian Heimesd59c64c2007-11-30 19:27:20 +0000541 # From a string
542 # REs insist on real strings, so we can too.
543 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000544 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000545 if m is None:
546 if context is None:
547 context = getcontext()
548 return context._raise_error(ConversionSyntax,
549 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000550
Christian Heimesd59c64c2007-11-30 19:27:20 +0000551 if m.group('sign') == "-":
552 self._sign = 1
553 else:
554 self._sign = 0
555 intpart = m.group('int')
556 if intpart is not None:
557 # finite number
Mark Dickinson345adc42009-08-02 10:14:23 +0000558 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000559 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000560 self._int = str(int(intpart+fracpart))
561 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000562 self._is_special = False
563 else:
564 diag = m.group('diag')
565 if diag is not None:
566 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000567 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000568 if m.group('signal'):
569 self._exp = 'N'
570 else:
571 self._exp = 'n'
572 else:
573 # infinity
574 self._int = '0'
575 self._exp = 'F'
576 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 return self
578
579 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000580 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000581 if value >= 0:
582 self._sign = 0
583 else:
584 self._sign = 1
585 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000586 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000587 self._is_special = False
588 return self
589
590 # From another decimal
591 if isinstance(value, Decimal):
592 self._exp = value._exp
593 self._sign = value._sign
594 self._int = value._int
595 self._is_special = value._is_special
596 return self
597
598 # From an internal working value
599 if isinstance(value, _WorkRep):
600 self._sign = value.sign
601 self._int = str(value.int)
602 self._exp = int(value.exp)
603 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000604 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000605
606 # tuple/list conversion (possibly from as_tuple())
607 if isinstance(value, (list,tuple)):
608 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000609 raise ValueError('Invalid tuple size in creation of Decimal '
610 'from list or tuple. The list or tuple '
611 'should have exactly three elements.')
612 # process sign. The isinstance test rejects floats
613 if not (isinstance(value[0], int) and value[0] in (0,1)):
614 raise ValueError("Invalid sign. The first value in the tuple "
615 "should be an integer; either 0 for a "
616 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000618 if value[2] == 'F':
619 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000620 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000622 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000623 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000624 # process and validate the digits in value[1]
625 digits = []
626 for digit in value[1]:
627 if isinstance(digit, int) and 0 <= digit <= 9:
628 # skip leading zeros
629 if digits or digit != 0:
630 digits.append(digit)
631 else:
632 raise ValueError("The second value in the tuple must "
633 "be composed of integers in the range "
634 "0 through 9.")
635 if value[2] in ('n', 'N'):
636 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000637 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000638 self._exp = value[2]
639 self._is_special = True
640 elif isinstance(value[2], int):
641 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000642 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000643 self._exp = value[2]
644 self._is_special = False
645 else:
646 raise ValueError("The third value in the tuple must "
647 "be an integer, or one of the "
648 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000649 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000650
Raymond Hettingerbf440692004-07-10 14:14:37 +0000651 if isinstance(value, float):
Raymond Hettinger96798592010-04-02 16:58:27 +0000652 value = Decimal.from_float(value)
653 self._exp = value._exp
654 self._sign = value._sign
655 self._int = value._int
656 self._is_special = value._is_special
657 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000658
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000659 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000660
Mark Dickinsonba298e42009-01-04 21:17:43 +0000661 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
662 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000663 def from_float(cls, f):
664 """Converts a float to a decimal number, exactly.
665
666 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
667 Since 0.1 is not exactly representable in binary floating point, the
668 value is stored as the nearest representable value which is
669 0x1.999999999999ap-4. The exact equivalent of the value in decimal
670 is 0.1000000000000000055511151231257827021181583404541015625.
671
672 >>> Decimal.from_float(0.1)
673 Decimal('0.1000000000000000055511151231257827021181583404541015625')
674 >>> Decimal.from_float(float('nan'))
675 Decimal('NaN')
676 >>> Decimal.from_float(float('inf'))
677 Decimal('Infinity')
678 >>> Decimal.from_float(-float('inf'))
679 Decimal('-Infinity')
680 >>> Decimal.from_float(-0.0)
681 Decimal('-0')
682
683 """
684 if isinstance(f, int): # handle integer inputs
685 return cls(f)
686 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
687 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000688 if _math.copysign(1.0, f) == 1.0:
689 sign = 0
690 else:
691 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000692 n, d = abs(f).as_integer_ratio()
693 k = d.bit_length() - 1
694 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000695 if cls is Decimal:
696 return result
697 else:
698 return cls(result)
699 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000700
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 def _isnan(self):
702 """Returns whether the number is not actually one.
703
704 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000705 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000706 2 if sNaN
707 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000708 if self._is_special:
709 exp = self._exp
710 if exp == 'n':
711 return 1
712 elif exp == 'N':
713 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000714 return 0
715
716 def _isinfinity(self):
717 """Returns whether the number is infinite
718
719 0 if finite or not a number
720 1 if +INF
721 -1 if -INF
722 """
723 if self._exp == 'F':
724 if self._sign:
725 return -1
726 return 1
727 return 0
728
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000729 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000730 """Returns whether the number is not actually one.
731
732 if self, other are sNaN, signal
733 if self, other are NaN return nan
734 return 0
735
736 Done before operations.
737 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000738
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000739 self_is_nan = self._isnan()
740 if other is None:
741 other_is_nan = False
742 else:
743 other_is_nan = other._isnan()
744
745 if self_is_nan or other_is_nan:
746 if context is None:
747 context = getcontext()
748
749 if self_is_nan == 2:
750 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000751 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752 if other_is_nan == 2:
753 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000754 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000755 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000756 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000757
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000758 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000759 return 0
760
Christian Heimes77c02eb2008-02-09 02:18:51 +0000761 def _compare_check_nans(self, other, context):
762 """Version of _check_nans used for the signaling comparisons
763 compare_signal, __le__, __lt__, __ge__, __gt__.
764
765 Signal InvalidOperation if either self or other is a (quiet
766 or signaling) NaN. Signaling NaNs take precedence over quiet
767 NaNs.
768
769 Return 0 if neither operand is a NaN.
770
771 """
772 if context is None:
773 context = getcontext()
774
775 if self._is_special or other._is_special:
776 if self.is_snan():
777 return context._raise_error(InvalidOperation,
778 'comparison involving sNaN',
779 self)
780 elif other.is_snan():
781 return context._raise_error(InvalidOperation,
782 'comparison involving sNaN',
783 other)
784 elif self.is_qnan():
785 return context._raise_error(InvalidOperation,
786 'comparison involving NaN',
787 self)
788 elif other.is_qnan():
789 return context._raise_error(InvalidOperation,
790 'comparison involving NaN',
791 other)
792 return 0
793
Jack Diederich4dafcc42006-11-28 19:15:13 +0000794 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000795 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000797 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000798 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000799 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000800
Christian Heimes77c02eb2008-02-09 02:18:51 +0000801 def _cmp(self, other):
802 """Compare the two non-NaN decimal instances self and other.
803
804 Returns -1 if self < other, 0 if self == other and 1
805 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000806
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000807 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000808 self_inf = self._isinfinity()
809 other_inf = other._isinfinity()
810 if self_inf == other_inf:
811 return 0
812 elif self_inf < other_inf:
813 return -1
814 else:
815 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000816
Mark Dickinsone6aad752009-01-25 10:48:51 +0000817 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000818 if not self:
819 if not other:
820 return 0
821 else:
822 return -((-1)**other._sign)
823 if not other:
824 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000825
Guido van Rossumd8faa362007-04-27 19:54:29 +0000826 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000827 if other._sign < self._sign:
828 return -1
829 if self._sign < other._sign:
830 return 1
831
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000832 self_adjusted = self.adjusted()
833 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000834 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000835 self_padded = self._int + '0'*(self._exp - other._exp)
836 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000837 if self_padded == other_padded:
838 return 0
839 elif self_padded < other_padded:
840 return -(-1)**self._sign
841 else:
842 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000843 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000844 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000845 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000846 return -((-1)**self._sign)
847
Christian Heimes77c02eb2008-02-09 02:18:51 +0000848 # Note: The Decimal standard doesn't cover rich comparisons for
849 # Decimals. In particular, the specification is silent on the
850 # subject of what should happen for a comparison involving a NaN.
851 # We take the following approach:
852 #
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000853 # == comparisons involving a quiet NaN always return False
854 # != comparisons involving a quiet NaN always return True
855 # == or != comparisons involving a signaling NaN signal
856 # InvalidOperation, and return False or True as above if the
857 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000858 # <, >, <= and >= comparisons involving a (quiet or signaling)
859 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000860 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000861 #
862 # This behavior is designed to conform as closely as possible to
863 # that specified by IEEE 754.
864
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000865 def __eq__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000866 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000867 if other is NotImplemented:
868 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000869 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000870 return False
871 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000872
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000873 def __ne__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000874 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000875 if other is NotImplemented:
876 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000877 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000878 return True
879 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000880
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000881
Christian Heimes77c02eb2008-02-09 02:18:51 +0000882 def __lt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000883 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000884 if other is NotImplemented:
885 return other
886 ans = self._compare_check_nans(other, context)
887 if ans:
888 return False
889 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000890
Christian Heimes77c02eb2008-02-09 02:18:51 +0000891 def __le__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000892 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000893 if other is NotImplemented:
894 return other
895 ans = self._compare_check_nans(other, context)
896 if ans:
897 return False
898 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000899
Christian Heimes77c02eb2008-02-09 02:18:51 +0000900 def __gt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000901 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000902 if other is NotImplemented:
903 return other
904 ans = self._compare_check_nans(other, context)
905 if ans:
906 return False
907 return self._cmp(other) > 0
908
909 def __ge__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000910 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000911 if other is NotImplemented:
912 return other
913 ans = self._compare_check_nans(other, context)
914 if ans:
915 return False
916 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000917
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000918 def compare(self, other, context=None):
919 """Compares one to another.
920
921 -1 => a < b
922 0 => a = b
923 1 => a > b
924 NaN => one is NaN
925 Like __cmp__, but returns Decimal instances.
926 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000927 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
Guido van Rossumd8faa362007-04-27 19:54:29 +0000929 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000930 if (self._is_special or other and other._is_special):
931 ans = self._check_nans(other, context)
932 if ans:
933 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000934
Christian Heimes77c02eb2008-02-09 02:18:51 +0000935 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000936
937 def __hash__(self):
938 """x.__hash__() <==> hash(x)"""
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000939
Mark Dickinsondc787d22010-05-23 13:33:13 +0000940 # In order to make sure that the hash of a Decimal instance
941 # agrees with the hash of a numerically equal integer, float
942 # or Fraction, we follow the rules for numeric hashes outlined
943 # in the documentation. (See library docs, 'Built-in Types').
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000944 if self._is_special:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000945 if self.is_snan():
946 raise TypeError('Cannot hash a signaling NaN value.')
947 elif self.is_nan():
Mark Dickinsondc787d22010-05-23 13:33:13 +0000948 return _PyHASH_NAN
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000949 else:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000950 if self._sign:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000951 return -_PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000952 else:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000953 return _PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000954
Mark Dickinsondc787d22010-05-23 13:33:13 +0000955 if self._exp >= 0:
956 exp_hash = pow(10, self._exp, _PyHASH_MODULUS)
957 else:
958 exp_hash = pow(_PyHASH_10INV, -self._exp, _PyHASH_MODULUS)
959 hash_ = int(self._int) * exp_hash % _PyHASH_MODULUS
960 return hash_ if self >= 0 else -hash_
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000961
962 def as_tuple(self):
963 """Represents the number as a triple tuple.
964
965 To show the internals exactly as they are.
966 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000967 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000968
969 def __repr__(self):
970 """Represents the number as an instance of Decimal."""
971 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000972 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000973
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000974 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000975 """Return string representation of the number in scientific notation.
976
977 Captures all of the information in the underlying representation.
978 """
979
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000980 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000981 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000982 if self._exp == 'F':
983 return sign + 'Infinity'
984 elif self._exp == 'n':
985 return sign + 'NaN' + self._int
986 else: # self._exp == 'N'
987 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000989 # number of digits of self._int to left of decimal point
990 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000991
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000992 # dotplace is number of digits of self._int to the left of the
993 # decimal point in the mantissa of the output string (that is,
994 # after adjusting the exponent)
995 if self._exp <= 0 and leftdigits > -6:
996 # no exponent required
997 dotplace = leftdigits
998 elif not eng:
999 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001001 elif self._int == '0':
1002 # engineering notation, zero
1003 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001005 # engineering notation, nonzero
1006 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001007
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001008 if dotplace <= 0:
1009 intpart = '0'
1010 fracpart = '.' + '0'*(-dotplace) + self._int
1011 elif dotplace >= len(self._int):
1012 intpart = self._int+'0'*(dotplace-len(self._int))
1013 fracpart = ''
1014 else:
1015 intpart = self._int[:dotplace]
1016 fracpart = '.' + self._int[dotplace:]
1017 if leftdigits == dotplace:
1018 exp = ''
1019 else:
1020 if context is None:
1021 context = getcontext()
1022 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1023
1024 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025
1026 def to_eng_string(self, context=None):
1027 """Convert to engineering-type string.
1028
1029 Engineering notation has an exponent which is a multiple of 3, so there
1030 are up to 3 digits left of the decimal place.
1031
1032 Same rules for when in exponential and when as a value as in __str__.
1033 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001034 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001035
1036 def __neg__(self, context=None):
1037 """Returns a copy with the sign switched.
1038
1039 Rounds, if it has reason.
1040 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001041 if self._is_special:
1042 ans = self._check_nans(context=context)
1043 if ans:
1044 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001045
1046 if not self:
1047 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001048 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001049 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001050 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001051
1052 if context is None:
1053 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001054 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001055
1056 def __pos__(self, context=None):
1057 """Returns a copy, unless it is a sNaN.
1058
1059 Rounds the number (if more then precision digits)
1060 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001061 if self._is_special:
1062 ans = self._check_nans(context=context)
1063 if ans:
1064 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001065
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001066 if not self:
1067 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001068 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001069 else:
1070 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001071
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001072 if context is None:
1073 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001074 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075
Christian Heimes2c181612007-12-17 20:04:13 +00001076 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001077 """Returns the absolute value of self.
1078
Christian Heimes2c181612007-12-17 20:04:13 +00001079 If the keyword argument 'round' is false, do not round. The
1080 expression self.__abs__(round=False) is equivalent to
1081 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082 """
Christian Heimes2c181612007-12-17 20:04:13 +00001083 if not round:
1084 return self.copy_abs()
1085
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001086 if self._is_special:
1087 ans = self._check_nans(context=context)
1088 if ans:
1089 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001091 if self._sign:
1092 ans = self.__neg__(context=context)
1093 else:
1094 ans = self.__pos__(context=context)
1095
1096 return ans
1097
1098 def __add__(self, other, context=None):
1099 """Returns self + other.
1100
1101 -INF + INF (or the reverse) cause InvalidOperation errors.
1102 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001104 if other is NotImplemented:
1105 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001106
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001107 if context is None:
1108 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001109
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001110 if self._is_special or other._is_special:
1111 ans = self._check_nans(other, context)
1112 if ans:
1113 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001114
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001115 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001116 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001117 if self._sign != other._sign and other._isinfinity():
1118 return context._raise_error(InvalidOperation, '-INF + INF')
1119 return Decimal(self)
1120 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001122
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001123 exp = min(self._exp, other._exp)
1124 negativezero = 0
1125 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001126 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001127 negativezero = 1
1128
1129 if not self and not other:
1130 sign = min(self._sign, other._sign)
1131 if negativezero:
1132 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001133 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001134 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001135 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001136 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001137 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001138 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001139 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001140 return ans
1141 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001142 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001143 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001144 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001145 return ans
1146
1147 op1 = _WorkRep(self)
1148 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001149 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150
1151 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001153 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001154 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001155 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001156 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001157 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001159 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001160 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001161 if op1.sign == 1:
1162 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001163 op1.sign, op2.sign = op2.sign, op1.sign
1164 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001165 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001166 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001167 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001169 op1.sign, op2.sign = (0, 0)
1170 else:
1171 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001172 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173
Raymond Hettinger17931de2004-10-27 06:21:46 +00001174 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001175 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001176 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001177 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
1179 result.exp = op1.exp
1180 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001181 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001182 return ans
1183
1184 __radd__ = __add__
1185
1186 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001187 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001188 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001189 if other is NotImplemented:
1190 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001192 if self._is_special or other._is_special:
1193 ans = self._check_nans(other, context=context)
1194 if ans:
1195 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001197 # self - other is computed as self + other.copy_negate()
1198 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001199
1200 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001201 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001202 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001203 if other is NotImplemented:
1204 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001206 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001208 def __mul__(self, other, context=None):
1209 """Return self * other.
1210
1211 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1212 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001214 if other is NotImplemented:
1215 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001216
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001217 if context is None:
1218 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001220 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001222 if self._is_special or other._is_special:
1223 ans = self._check_nans(other, context)
1224 if ans:
1225 return ans
1226
1227 if self._isinfinity():
1228 if not other:
1229 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001230 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001231
1232 if other._isinfinity():
1233 if not self:
1234 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001235 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236
1237 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001238
1239 # Special case for multiplying by zero
1240 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001241 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001242 # Fixing in case the exponent is out of bounds
1243 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001244 return ans
1245
1246 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001247 if self._int == '1':
1248 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001249 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001250 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001251 if other._int == '1':
1252 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001253 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001254 return ans
1255
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001256 op1 = _WorkRep(self)
1257 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001259 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001260 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001261
1262 return ans
1263 __rmul__ = __mul__
1264
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001265 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001268 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001269 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001270
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001271 if context is None:
1272 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001274 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001275
1276 if self._is_special or other._is_special:
1277 ans = self._check_nans(other, context)
1278 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001279 return ans
1280
1281 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001284 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001285 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001286
1287 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001288 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001289 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001290
1291 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001293 if not self:
1294 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001296
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001297 if not self:
1298 exp = self._exp - other._exp
1299 coeff = 0
1300 else:
1301 # OK, so neither = 0, INF or NaN
1302 shift = len(other._int) - len(self._int) + context.prec + 1
1303 exp = self._exp - other._exp - shift
1304 op1 = _WorkRep(self)
1305 op2 = _WorkRep(other)
1306 if shift >= 0:
1307 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1308 else:
1309 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1310 if remainder:
1311 # result is not exact; adjust to ensure correct rounding
1312 if coeff % 5 == 0:
1313 coeff += 1
1314 else:
1315 # result is exact; get as close to ideal exponent as possible
1316 ideal_exp = self._exp - other._exp
1317 while exp < ideal_exp and coeff % 10 == 0:
1318 coeff //= 10
1319 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001321 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001322 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 def _divide(self, other, context):
1325 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001326
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001327 Assumes that neither self nor other is a NaN, that self is not
1328 infinite and that other is nonzero.
1329 """
1330 sign = self._sign ^ other._sign
1331 if other._isinfinity():
1332 ideal_exp = self._exp
1333 else:
1334 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001335
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336 expdiff = self.adjusted() - other.adjusted()
1337 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001338 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001339 self._rescale(ideal_exp, context.rounding))
1340 if expdiff <= context.prec:
1341 op1 = _WorkRep(self)
1342 op2 = _WorkRep(other)
1343 if op1.exp >= op2.exp:
1344 op1.int *= 10**(op1.exp - op2.exp)
1345 else:
1346 op2.int *= 10**(op2.exp - op1.exp)
1347 q, r = divmod(op1.int, op2.int)
1348 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001349 return (_dec_from_triple(sign, str(q), 0),
1350 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001352 # Here the quotient is too large to be representable
1353 ans = context._raise_error(DivisionImpossible,
1354 'quotient too large in //, % or divmod')
1355 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001356
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001357 def __rtruediv__(self, other, context=None):
1358 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001359 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001360 if other is NotImplemented:
1361 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001362 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
1364 def __divmod__(self, other, context=None):
1365 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001366 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001367 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001368 other = _convert_other(other)
1369 if other is NotImplemented:
1370 return other
1371
1372 if context is None:
1373 context = getcontext()
1374
1375 ans = self._check_nans(other, context)
1376 if ans:
1377 return (ans, ans)
1378
1379 sign = self._sign ^ other._sign
1380 if self._isinfinity():
1381 if other._isinfinity():
1382 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1383 return ans, ans
1384 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001385 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001386 context._raise_error(InvalidOperation, 'INF % x'))
1387
1388 if not other:
1389 if not self:
1390 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1391 return ans, ans
1392 else:
1393 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1394 context._raise_error(InvalidOperation, 'x % 0'))
1395
1396 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001397 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001398 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001399
1400 def __rdivmod__(self, other, context=None):
1401 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001402 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001403 if other is NotImplemented:
1404 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405 return other.__divmod__(self, context=context)
1406
1407 def __mod__(self, other, context=None):
1408 """
1409 self % other
1410 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001411 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001412 if other is NotImplemented:
1413 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001415 if context is None:
1416 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001417
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001418 ans = self._check_nans(other, context)
1419 if ans:
1420 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001421
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001422 if self._isinfinity():
1423 return context._raise_error(InvalidOperation, 'INF % x')
1424 elif not other:
1425 if self:
1426 return context._raise_error(InvalidOperation, 'x % 0')
1427 else:
1428 return context._raise_error(DivisionUndefined, '0 % 0')
1429
1430 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001431 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001432 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001433
1434 def __rmod__(self, other, context=None):
1435 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001436 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001437 if other is NotImplemented:
1438 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001439 return other.__mod__(self, context=context)
1440
1441 def remainder_near(self, other, context=None):
1442 """
1443 Remainder nearest to 0- abs(remainder-near) <= other/2
1444 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001445 if context is None:
1446 context = getcontext()
1447
1448 other = _convert_other(other, raiseit=True)
1449
1450 ans = self._check_nans(other, context)
1451 if ans:
1452 return ans
1453
1454 # self == +/-infinity -> InvalidOperation
1455 if self._isinfinity():
1456 return context._raise_error(InvalidOperation,
1457 'remainder_near(infinity, x)')
1458
1459 # other == 0 -> either InvalidOperation or DivisionUndefined
1460 if not other:
1461 if self:
1462 return context._raise_error(InvalidOperation,
1463 'remainder_near(x, 0)')
1464 else:
1465 return context._raise_error(DivisionUndefined,
1466 'remainder_near(0, 0)')
1467
1468 # other = +/-infinity -> remainder = self
1469 if other._isinfinity():
1470 ans = Decimal(self)
1471 return ans._fix(context)
1472
1473 # self = 0 -> remainder = self, with ideal exponent
1474 ideal_exponent = min(self._exp, other._exp)
1475 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001476 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001477 return ans._fix(context)
1478
1479 # catch most cases of large or small quotient
1480 expdiff = self.adjusted() - other.adjusted()
1481 if expdiff >= context.prec + 1:
1482 # expdiff >= prec+1 => abs(self/other) > 10**prec
1483 return context._raise_error(DivisionImpossible)
1484 if expdiff <= -2:
1485 # expdiff <= -2 => abs(self/other) < 0.1
1486 ans = self._rescale(ideal_exponent, context.rounding)
1487 return ans._fix(context)
1488
1489 # adjust both arguments to have the same exponent, then divide
1490 op1 = _WorkRep(self)
1491 op2 = _WorkRep(other)
1492 if op1.exp >= op2.exp:
1493 op1.int *= 10**(op1.exp - op2.exp)
1494 else:
1495 op2.int *= 10**(op2.exp - op1.exp)
1496 q, r = divmod(op1.int, op2.int)
1497 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1498 # 10**ideal_exponent. Apply correction to ensure that
1499 # abs(remainder) <= abs(other)/2
1500 if 2*r + (q&1) > op2.int:
1501 r -= op2.int
1502 q += 1
1503
1504 if q >= 10**context.prec:
1505 return context._raise_error(DivisionImpossible)
1506
1507 # result has same sign as self unless r is negative
1508 sign = self._sign
1509 if r < 0:
1510 sign = 1-sign
1511 r = -r
1512
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001513 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001514 return ans._fix(context)
1515
1516 def __floordiv__(self, other, context=None):
1517 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001518 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001519 if other is NotImplemented:
1520 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001521
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001522 if context is None:
1523 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001524
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001525 ans = self._check_nans(other, context)
1526 if ans:
1527 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001528
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001529 if self._isinfinity():
1530 if other._isinfinity():
1531 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001532 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001533 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001534
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001535 if not other:
1536 if self:
1537 return context._raise_error(DivisionByZero, 'x // 0',
1538 self._sign ^ other._sign)
1539 else:
1540 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001541
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001542 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
1544 def __rfloordiv__(self, other, context=None):
1545 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001546 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001547 if other is NotImplemented:
1548 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001549 return other.__floordiv__(self, context=context)
1550
1551 def __float__(self):
1552 """Float representation."""
1553 return float(str(self))
1554
1555 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001556 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 if self._is_special:
1558 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001559 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001560 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001561 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001562 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001563 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001564 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001565 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001566 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001567
Christian Heimes969fe572008-01-25 11:23:10 +00001568 __trunc__ = __int__
1569
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570 def real(self):
1571 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001572 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001573
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574 def imag(self):
1575 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001576 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001577
1578 def conjugate(self):
1579 return self
1580
1581 def __complex__(self):
1582 return complex(float(self))
1583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001584 def _fix_nan(self, context):
1585 """Decapitate the payload of a NaN to fit the context"""
1586 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001588 # maximum length of payload is precision if clamp=0,
1589 # precision-1 if clamp=1.
1590 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001592 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1593 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001594 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001595
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001596 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597 """Round if it is necessary to keep self within prec precision.
1598
1599 Rounds and fixes the exponent. Does not raise on a sNaN.
1600
1601 Arguments:
1602 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603 context - context used.
1604 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001605
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001606 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001607 if self._isnan():
1608 # decapitate payload if necessary
1609 return self._fix_nan(context)
1610 else:
1611 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001612 return Decimal(self)
1613
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001614 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001615 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 Etiny = context.Etiny()
1617 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001618 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001619 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001620 new_exp = min(max(self._exp, Etiny), exp_max)
1621 if new_exp != self._exp:
1622 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001623 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001624 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001625 return Decimal(self)
1626
1627 # exp_min is the smallest allowable exponent of the result,
1628 # equal to max(self.adjusted()-context.prec+1, Etiny)
1629 exp_min = len(self._int) + self._exp - context.prec
1630 if exp_min > Etop:
1631 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001632 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001633 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001634 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001635 return ans
1636
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001637 self_is_subnormal = exp_min < Etiny
1638 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001639 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001640
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001641 # round if self has too many digits
1642 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001643 digits = len(self._int) + self._exp - exp_min
1644 if digits < 0:
1645 self = _dec_from_triple(self._sign, '1', exp_min-1)
1646 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001647 rounding_method = self._pick_rounding_function[context.rounding]
1648 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001649 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001650 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001651 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001652 if len(coeff) > context.prec:
1653 coeff = coeff[:-1]
1654 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001655
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001656 # check whether the rounding pushed the exponent out of range
1657 if exp_min > Etop:
1658 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1659 else:
1660 ans = _dec_from_triple(self._sign, coeff, exp_min)
1661
1662 # raise the appropriate signals, taking care to respect
1663 # the precedence described in the specification
1664 if changed and self_is_subnormal:
1665 context._raise_error(Underflow)
1666 if self_is_subnormal:
1667 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001668 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001669 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001670 context._raise_error(Rounded)
1671 if not ans:
1672 # raise Clamped on underflow to 0
1673 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001674 return ans
1675
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001676 if self_is_subnormal:
1677 context._raise_error(Subnormal)
1678
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001679 # fold down if clamp == 1 and self has too few digits
1680 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001681 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001682 self_padded = self._int + '0'*(self._exp - Etop)
1683 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001685 # here self was representable to begin with; return unchanged
1686 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001687
1688 _pick_rounding_function = {}
1689
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690 # for each of the rounding functions below:
1691 # self is a finite, nonzero Decimal
1692 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001693 #
1694 # each function returns either -1, 0, or 1, as follows:
1695 # 1 indicates that self should be rounded up (away from zero)
1696 # 0 indicates that self should be truncated, and that all the
1697 # digits to be truncated are zeros (so the value is unchanged)
1698 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001699
1700 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001702 if _all_zeros(self._int, prec):
1703 return 0
1704 else:
1705 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001707 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001708 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001709 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001711 def _round_half_up(self, prec):
1712 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001713 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001714 return 1
1715 elif _all_zeros(self._int, prec):
1716 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001717 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001718 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001719
1720 def _round_half_down(self, prec):
1721 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001722 if _exact_half(self._int, prec):
1723 return -1
1724 else:
1725 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001726
1727 def _round_half_even(self, prec):
1728 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001729 if _exact_half(self._int, prec) and \
1730 (prec == 0 or self._int[prec-1] in '02468'):
1731 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001732 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001733 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001734
1735 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001736 """Rounds up (not away from 0 if negative.)"""
1737 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001738 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001740 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001742 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743 """Rounds down (not towards 0 if negative)"""
1744 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001745 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001747 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001749 def _round_05up(self, prec):
1750 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001751 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001752 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001753 else:
1754 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001755
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001756 def __round__(self, n=None):
1757 """Round self to the nearest integer, or to a given precision.
1758
1759 If only one argument is supplied, round a finite Decimal
1760 instance self to the nearest integer. If self is infinite or
1761 a NaN then a Python exception is raised. If self is finite
1762 and lies exactly halfway between two integers then it is
1763 rounded to the integer with even last digit.
1764
1765 >>> round(Decimal('123.456'))
1766 123
1767 >>> round(Decimal('-456.789'))
1768 -457
1769 >>> round(Decimal('-3.0'))
1770 -3
1771 >>> round(Decimal('2.5'))
1772 2
1773 >>> round(Decimal('3.5'))
1774 4
1775 >>> round(Decimal('Inf'))
1776 Traceback (most recent call last):
1777 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001778 OverflowError: cannot round an infinity
1779 >>> round(Decimal('NaN'))
1780 Traceback (most recent call last):
1781 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001782 ValueError: cannot round a NaN
1783
1784 If a second argument n is supplied, self is rounded to n
1785 decimal places using the rounding mode for the current
1786 context.
1787
1788 For an integer n, round(self, -n) is exactly equivalent to
1789 self.quantize(Decimal('1En')).
1790
1791 >>> round(Decimal('123.456'), 0)
1792 Decimal('123')
1793 >>> round(Decimal('123.456'), 2)
1794 Decimal('123.46')
1795 >>> round(Decimal('123.456'), -2)
1796 Decimal('1E+2')
1797 >>> round(Decimal('-Infinity'), 37)
1798 Decimal('NaN')
1799 >>> round(Decimal('sNaN123'), 0)
1800 Decimal('NaN123')
1801
1802 """
1803 if n is not None:
1804 # two-argument form: use the equivalent quantize call
1805 if not isinstance(n, int):
1806 raise TypeError('Second argument to round should be integral')
1807 exp = _dec_from_triple(0, '1', -n)
1808 return self.quantize(exp)
1809
1810 # one-argument form
1811 if self._is_special:
1812 if self.is_nan():
1813 raise ValueError("cannot round a NaN")
1814 else:
1815 raise OverflowError("cannot round an infinity")
1816 return int(self._rescale(0, ROUND_HALF_EVEN))
1817
1818 def __floor__(self):
1819 """Return the floor of self, as an integer.
1820
1821 For a finite Decimal instance self, return the greatest
1822 integer n such that n <= self. If self is infinite or a NaN
1823 then a Python exception is raised.
1824
1825 """
1826 if self._is_special:
1827 if self.is_nan():
1828 raise ValueError("cannot round a NaN")
1829 else:
1830 raise OverflowError("cannot round an infinity")
1831 return int(self._rescale(0, ROUND_FLOOR))
1832
1833 def __ceil__(self):
1834 """Return the ceiling of self, as an integer.
1835
1836 For a finite Decimal instance self, return the least integer n
1837 such that n >= self. If self is infinite or a NaN then a
1838 Python exception is raised.
1839
1840 """
1841 if self._is_special:
1842 if self.is_nan():
1843 raise ValueError("cannot round a NaN")
1844 else:
1845 raise OverflowError("cannot round an infinity")
1846 return int(self._rescale(0, ROUND_CEILING))
1847
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001848 def fma(self, other, third, context=None):
1849 """Fused multiply-add.
1850
1851 Returns self*other+third with no rounding of the intermediate
1852 product self*other.
1853
1854 self and other are multiplied together, with no rounding of
1855 the result. The third operand is then added to the result,
1856 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001857 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001858
1859 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001860
1861 # compute product; raise InvalidOperation if either operand is
1862 # a signaling NaN or if the product is zero times infinity.
1863 if self._is_special or other._is_special:
1864 if context is None:
1865 context = getcontext()
1866 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001867 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001868 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001869 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001870 if self._exp == 'n':
1871 product = self
1872 elif other._exp == 'n':
1873 product = other
1874 elif self._exp == 'F':
1875 if not other:
1876 return context._raise_error(InvalidOperation,
1877 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001878 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001879 elif other._exp == 'F':
1880 if not self:
1881 return context._raise_error(InvalidOperation,
1882 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001883 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001884 else:
1885 product = _dec_from_triple(self._sign ^ other._sign,
1886 str(int(self._int) * int(other._int)),
1887 self._exp + other._exp)
1888
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001889 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001890 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001891
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892 def _power_modulo(self, other, modulo, context=None):
1893 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001894
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895 # if can't convert other and modulo to Decimal, raise
1896 # TypeError; there's no point returning NotImplemented (no
1897 # equivalent of __rpow__ for three argument pow)
1898 other = _convert_other(other, raiseit=True)
1899 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001900
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001901 if context is None:
1902 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001903
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001904 # deal with NaNs: if there are any sNaNs then first one wins,
1905 # (i.e. behaviour for NaNs is identical to that of fma)
1906 self_is_nan = self._isnan()
1907 other_is_nan = other._isnan()
1908 modulo_is_nan = modulo._isnan()
1909 if self_is_nan or other_is_nan or modulo_is_nan:
1910 if self_is_nan == 2:
1911 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001912 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001913 if other_is_nan == 2:
1914 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001915 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001916 if modulo_is_nan == 2:
1917 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001918 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001919 if self_is_nan:
1920 return self._fix_nan(context)
1921 if other_is_nan:
1922 return other._fix_nan(context)
1923 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001924
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001925 # check inputs: we apply same restrictions as Python's pow()
1926 if not (self._isinteger() and
1927 other._isinteger() and
1928 modulo._isinteger()):
1929 return context._raise_error(InvalidOperation,
1930 'pow() 3rd argument not allowed '
1931 'unless all arguments are integers')
1932 if other < 0:
1933 return context._raise_error(InvalidOperation,
1934 'pow() 2nd argument cannot be '
1935 'negative when 3rd argument specified')
1936 if not modulo:
1937 return context._raise_error(InvalidOperation,
1938 'pow() 3rd argument cannot be 0')
1939
1940 # additional restriction for decimal: the modulus must be less
1941 # than 10**prec in absolute value
1942 if modulo.adjusted() >= context.prec:
1943 return context._raise_error(InvalidOperation,
1944 'insufficient precision: pow() 3rd '
1945 'argument must not have more than '
1946 'precision digits')
1947
1948 # define 0**0 == NaN, for consistency with two-argument pow
1949 # (even though it hurts!)
1950 if not other and not self:
1951 return context._raise_error(InvalidOperation,
1952 'at least one of pow() 1st argument '
1953 'and 2nd argument must be nonzero ;'
1954 '0**0 is not defined')
1955
1956 # compute sign of result
1957 if other._iseven():
1958 sign = 0
1959 else:
1960 sign = self._sign
1961
1962 # convert modulo to a Python integer, and self and other to
1963 # Decimal integers (i.e. force their exponents to be >= 0)
1964 modulo = abs(int(modulo))
1965 base = _WorkRep(self.to_integral_value())
1966 exponent = _WorkRep(other.to_integral_value())
1967
1968 # compute result using integer pow()
1969 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1970 for i in range(exponent.exp):
1971 base = pow(base, 10, modulo)
1972 base = pow(base, exponent.int, modulo)
1973
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001974 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001975
1976 def _power_exact(self, other, p):
1977 """Attempt to compute self**other exactly.
1978
1979 Given Decimals self and other and an integer p, attempt to
1980 compute an exact result for the power self**other, with p
1981 digits of precision. Return None if self**other is not
1982 exactly representable in p digits.
1983
1984 Assumes that elimination of special cases has already been
1985 performed: self and other must both be nonspecial; self must
1986 be positive and not numerically equal to 1; other must be
1987 nonzero. For efficiency, other._exp should not be too large,
1988 so that 10**abs(other._exp) is a feasible calculation."""
1989
1990 # In the comments below, we write x for the value of self and
1991 # y for the value of other. Write x = xc*10**xe and y =
1992 # yc*10**ye.
1993
1994 # The main purpose of this method is to identify the *failure*
1995 # of x**y to be exactly representable with as little effort as
1996 # possible. So we look for cheap and easy tests that
1997 # eliminate the possibility of x**y being exact. Only if all
1998 # these tests are passed do we go on to actually compute x**y.
1999
2000 # Here's the main idea. First normalize both x and y. We
2001 # express y as a rational m/n, with m and n relatively prime
2002 # and n>0. Then for x**y to be exactly representable (at
2003 # *any* precision), xc must be the nth power of a positive
2004 # integer and xe must be divisible by n. If m is negative
2005 # then additionally xc must be a power of either 2 or 5, hence
2006 # a power of 2**n or 5**n.
2007 #
2008 # There's a limit to how small |y| can be: if y=m/n as above
2009 # then:
2010 #
2011 # (1) if xc != 1 then for the result to be representable we
2012 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2013 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2014 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2015 # representable.
2016 #
2017 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2018 # |y| < 1/|xe| then the result is not representable.
2019 #
2020 # Note that since x is not equal to 1, at least one of (1) and
2021 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2022 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2023 #
2024 # There's also a limit to how large y can be, at least if it's
2025 # positive: the normalized result will have coefficient xc**y,
2026 # so if it's representable then xc**y < 10**p, and y <
2027 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2028 # not exactly representable.
2029
2030 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2031 # so |y| < 1/xe and the result is not representable.
2032 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2033 # < 1/nbits(xc).
2034
2035 x = _WorkRep(self)
2036 xc, xe = x.int, x.exp
2037 while xc % 10 == 0:
2038 xc //= 10
2039 xe += 1
2040
2041 y = _WorkRep(other)
2042 yc, ye = y.int, y.exp
2043 while yc % 10 == 0:
2044 yc //= 10
2045 ye += 1
2046
2047 # case where xc == 1: result is 10**(xe*y), with xe*y
2048 # required to be an integer
2049 if xc == 1:
Mark Dickinsona1236312010-07-08 19:03:34 +00002050 xe *= yc
2051 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2052 while xe % 10 == 0:
2053 xe //= 10
2054 ye += 1
2055 if ye < 0:
2056 return None
2057 exponent = xe * 10**ye
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002058 if y.sign == 1:
2059 exponent = -exponent
2060 # if other is a nonnegative integer, use ideal exponent
2061 if other._isinteger() and other._sign == 0:
2062 ideal_exponent = self._exp*int(other)
2063 zeros = min(exponent-ideal_exponent, p-1)
2064 else:
2065 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002066 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002067
2068 # case where y is negative: xc must be either a power
2069 # of 2 or a power of 5.
2070 if y.sign == 1:
2071 last_digit = xc % 10
2072 if last_digit in (2,4,6,8):
2073 # quick test for power of 2
2074 if xc & -xc != xc:
2075 return None
2076 # now xc is a power of 2; e is its exponent
2077 e = _nbits(xc)-1
2078 # find e*y and xe*y; both must be integers
2079 if ye >= 0:
2080 y_as_int = yc*10**ye
2081 e = e*y_as_int
2082 xe = xe*y_as_int
2083 else:
2084 ten_pow = 10**-ye
2085 e, remainder = divmod(e*yc, ten_pow)
2086 if remainder:
2087 return None
2088 xe, remainder = divmod(xe*yc, ten_pow)
2089 if remainder:
2090 return None
2091
2092 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2093 return None
2094 xc = 5**e
2095
2096 elif last_digit == 5:
2097 # e >= log_5(xc) if xc is a power of 5; we have
2098 # equality all the way up to xc=5**2658
2099 e = _nbits(xc)*28//65
2100 xc, remainder = divmod(5**e, xc)
2101 if remainder:
2102 return None
2103 while xc % 5 == 0:
2104 xc //= 5
2105 e -= 1
2106 if ye >= 0:
2107 y_as_integer = yc*10**ye
2108 e = e*y_as_integer
2109 xe = xe*y_as_integer
2110 else:
2111 ten_pow = 10**-ye
2112 e, remainder = divmod(e*yc, ten_pow)
2113 if remainder:
2114 return None
2115 xe, remainder = divmod(xe*yc, ten_pow)
2116 if remainder:
2117 return None
2118 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2119 return None
2120 xc = 2**e
2121 else:
2122 return None
2123
2124 if xc >= 10**p:
2125 return None
2126 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002127 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002128
2129 # now y is positive; find m and n such that y = m/n
2130 if ye >= 0:
2131 m, n = yc*10**ye, 1
2132 else:
2133 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2134 return None
2135 xc_bits = _nbits(xc)
2136 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2137 return None
2138 m, n = yc, 10**(-ye)
2139 while m % 2 == n % 2 == 0:
2140 m //= 2
2141 n //= 2
2142 while m % 5 == n % 5 == 0:
2143 m //= 5
2144 n //= 5
2145
2146 # compute nth root of xc*10**xe
2147 if n > 1:
2148 # if 1 < xc < 2**n then xc isn't an nth power
2149 if xc != 1 and xc_bits <= n:
2150 return None
2151
2152 xe, rem = divmod(xe, n)
2153 if rem != 0:
2154 return None
2155
2156 # compute nth root of xc using Newton's method
2157 a = 1 << -(-_nbits(xc)//n) # initial estimate
2158 while True:
2159 q, r = divmod(xc, a**(n-1))
2160 if a <= q:
2161 break
2162 else:
2163 a = (a*(n-1) + q)//n
2164 if not (a == q and r == 0):
2165 return None
2166 xc = a
2167
2168 # now xc*10**xe is the nth root of the original xc*10**xe
2169 # compute mth power of xc*10**xe
2170
2171 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2172 # 10**p and the result is not representable.
2173 if xc > 1 and m > p*100//_log10_lb(xc):
2174 return None
2175 xc = xc**m
2176 xe *= m
2177 if xc > 10**p:
2178 return None
2179
2180 # by this point the result *is* exactly representable
2181 # adjust the exponent to get as close as possible to the ideal
2182 # exponent, if necessary
2183 str_xc = str(xc)
2184 if other._isinteger() and other._sign == 0:
2185 ideal_exponent = self._exp*int(other)
2186 zeros = min(xe-ideal_exponent, p-len(str_xc))
2187 else:
2188 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002189 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002190
2191 def __pow__(self, other, modulo=None, context=None):
2192 """Return self ** other [ % modulo].
2193
2194 With two arguments, compute self**other.
2195
2196 With three arguments, compute (self**other) % modulo. For the
2197 three argument form, the following restrictions on the
2198 arguments hold:
2199
2200 - all three arguments must be integral
2201 - other must be nonnegative
2202 - either self or other (or both) must be nonzero
2203 - modulo must be nonzero and must have at most p digits,
2204 where p is the context precision.
2205
2206 If any of these restrictions is violated the InvalidOperation
2207 flag is raised.
2208
2209 The result of pow(self, other, modulo) is identical to the
2210 result that would be obtained by computing (self**other) %
2211 modulo with unbounded precision, but is computed more
2212 efficiently. It is always exact.
2213 """
2214
2215 if modulo is not None:
2216 return self._power_modulo(other, modulo, context)
2217
2218 other = _convert_other(other)
2219 if other is NotImplemented:
2220 return other
2221
2222 if context is None:
2223 context = getcontext()
2224
2225 # either argument is a NaN => result is NaN
2226 ans = self._check_nans(other, context)
2227 if ans:
2228 return ans
2229
2230 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2231 if not other:
2232 if not self:
2233 return context._raise_error(InvalidOperation, '0 ** 0')
2234 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002235 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002236
2237 # result has sign 1 iff self._sign is 1 and other is an odd integer
2238 result_sign = 0
2239 if self._sign == 1:
2240 if other._isinteger():
2241 if not other._iseven():
2242 result_sign = 1
2243 else:
2244 # -ve**noninteger = NaN
2245 # (-0)**noninteger = 0**noninteger
2246 if self:
2247 return context._raise_error(InvalidOperation,
2248 'x ** y with x negative and y not an integer')
2249 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002250 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002251
2252 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2253 if not self:
2254 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002255 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002256 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002257 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258
2259 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002260 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002261 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002262 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002263 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002264 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002265
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002266 # 1**other = 1, but the choice of exponent and the flags
2267 # depend on the exponent of self, and on whether other is a
2268 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002269 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002270 if other._isinteger():
2271 # exp = max(self._exp*max(int(other), 0),
2272 # 1-context.prec) but evaluating int(other) directly
2273 # is dangerous until we know other is small (other
2274 # could be 1e999999999)
2275 if other._sign == 1:
2276 multiplier = 0
2277 elif other > context.prec:
2278 multiplier = context.prec
2279 else:
2280 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002281
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002282 exp = self._exp * multiplier
2283 if exp < 1-context.prec:
2284 exp = 1-context.prec
2285 context._raise_error(Rounded)
2286 else:
2287 context._raise_error(Inexact)
2288 context._raise_error(Rounded)
2289 exp = 1-context.prec
2290
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002291 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002292
2293 # compute adjusted exponent of self
2294 self_adj = self.adjusted()
2295
2296 # self ** infinity is infinity if self > 1, 0 if self < 1
2297 # self ** -infinity is infinity if self < 1, 0 if self > 1
2298 if other._isinfinity():
2299 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002300 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002301 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002302 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002303
2304 # from here on, the result always goes through the call
2305 # to _fix at the end of this function.
2306 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002307 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002308
2309 # crude test to catch cases of extreme overflow/underflow. If
2310 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2311 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2312 # self**other >= 10**(Emax+1), so overflow occurs. The test
2313 # for underflow is similar.
2314 bound = self._log10_exp_bound() + other.adjusted()
2315 if (self_adj >= 0) == (other._sign == 0):
2316 # self > 1 and other +ve, or self < 1 and other -ve
2317 # possibility of overflow
2318 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002319 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002320 else:
2321 # self > 1 and other -ve, or self < 1 and other +ve
2322 # possibility of underflow to 0
2323 Etiny = context.Etiny()
2324 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002325 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002326
2327 # try for an exact result with precision +1
2328 if ans is None:
2329 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone42f1bb2010-07-08 19:09:16 +00002330 if ans is not None:
2331 if result_sign == 1:
2332 ans = _dec_from_triple(1, ans._int, ans._exp)
2333 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002334
2335 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2336 if ans is None:
2337 p = context.prec
2338 x = _WorkRep(self)
2339 xc, xe = x.int, x.exp
2340 y = _WorkRep(other)
2341 yc, ye = y.int, y.exp
2342 if y.sign == 1:
2343 yc = -yc
2344
2345 # compute correctly rounded result: start with precision +3,
2346 # then increase precision until result is unambiguously roundable
2347 extra = 3
2348 while True:
2349 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2350 if coeff % (5*10**(len(str(coeff))-p-1)):
2351 break
2352 extra += 3
2353
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002354 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002355
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002356 # unlike exp, ln and log10, the power function respects the
2357 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2358
2359 # There's a difficulty here when 'other' is not an integer and
2360 # the result is exact. In this case, the specification
2361 # requires that the Inexact flag be raised (in spite of
2362 # exactness), but since the result is exact _fix won't do this
2363 # for us. (Correspondingly, the Underflow signal should also
2364 # be raised for subnormal results.) We can't directly raise
2365 # these signals either before or after calling _fix, since
2366 # that would violate the precedence for signals. So we wrap
2367 # the ._fix call in a temporary context, and reraise
2368 # afterwards.
2369 if exact and not other._isinteger():
2370 # pad with zeros up to length context.prec+1 if necessary; this
2371 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002372 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002373 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002374 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2375 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002376
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002377 # create a copy of the current context, with cleared flags/traps
2378 newcontext = context.copy()
2379 newcontext.clear_flags()
2380 for exception in _signals:
2381 newcontext.traps[exception] = 0
2382
2383 # round in the new context
2384 ans = ans._fix(newcontext)
2385
2386 # raise Inexact, and if necessary, Underflow
2387 newcontext._raise_error(Inexact)
2388 if newcontext.flags[Subnormal]:
2389 newcontext._raise_error(Underflow)
2390
2391 # propagate signals to the original context; _fix could
2392 # have raised any of Overflow, Underflow, Subnormal,
2393 # Inexact, Rounded, Clamped. Overflow needs the correct
2394 # arguments. Note that the order of the exceptions is
2395 # important here.
2396 if newcontext.flags[Overflow]:
2397 context._raise_error(Overflow, 'above Emax', ans._sign)
2398 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2399 if newcontext.flags[exception]:
2400 context._raise_error(exception)
2401
2402 else:
2403 ans = ans._fix(context)
2404
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002405 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002406
2407 def __rpow__(self, other, context=None):
2408 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002409 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002410 if other is NotImplemented:
2411 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412 return other.__pow__(self, context=context)
2413
2414 def normalize(self, context=None):
2415 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002416
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002417 if context is None:
2418 context = getcontext()
2419
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002420 if self._is_special:
2421 ans = self._check_nans(context=context)
2422 if ans:
2423 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002424
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002425 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002426 if dup._isinfinity():
2427 return dup
2428
2429 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002430 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002431 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432 end = len(dup._int)
2433 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002434 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002435 exp += 1
2436 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002437 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002438
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002439 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002440 """Quantize self so its exponent is the same as that of exp.
2441
2442 Similar to self._rescale(exp._exp) but with error checking.
2443 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002444 exp = _convert_other(exp, raiseit=True)
2445
2446 if context is None:
2447 context = getcontext()
2448 if rounding is None:
2449 rounding = context.rounding
2450
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002451 if self._is_special or exp._is_special:
2452 ans = self._check_nans(exp, context)
2453 if ans:
2454 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002456 if exp._isinfinity() or self._isinfinity():
2457 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002458 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002459 return context._raise_error(InvalidOperation,
2460 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002461
2462 # if we're not watching exponents, do a simple rescale
2463 if not watchexp:
2464 ans = self._rescale(exp._exp, rounding)
2465 # raise Inexact and Rounded where appropriate
2466 if ans._exp > self._exp:
2467 context._raise_error(Rounded)
2468 if ans != self:
2469 context._raise_error(Inexact)
2470 return ans
2471
2472 # exp._exp should be between Etiny and Emax
2473 if not (context.Etiny() <= exp._exp <= context.Emax):
2474 return context._raise_error(InvalidOperation,
2475 'target exponent out of bounds in quantize')
2476
2477 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002478 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002479 return ans._fix(context)
2480
2481 self_adjusted = self.adjusted()
2482 if self_adjusted > context.Emax:
2483 return context._raise_error(InvalidOperation,
2484 'exponent of quantize result too large for current context')
2485 if self_adjusted - exp._exp + 1 > context.prec:
2486 return context._raise_error(InvalidOperation,
2487 'quantize result has too many digits for current context')
2488
2489 ans = self._rescale(exp._exp, rounding)
2490 if ans.adjusted() > context.Emax:
2491 return context._raise_error(InvalidOperation,
2492 'exponent of quantize result too large for current context')
2493 if len(ans._int) > context.prec:
2494 return context._raise_error(InvalidOperation,
2495 'quantize result has too many digits for current context')
2496
2497 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002498 if ans and ans.adjusted() < context.Emin:
2499 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002500 if ans._exp > self._exp:
2501 if ans != self:
2502 context._raise_error(Inexact)
2503 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002504
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002505 # call to fix takes care of any necessary folddown, and
2506 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002507 ans = ans._fix(context)
2508 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002509
2510 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002511 """Return True if self and other have the same exponent; otherwise
2512 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002513
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002514 If either operand is a special value, the following rules are used:
2515 * return True if both operands are infinities
2516 * return True if both operands are NaNs
2517 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002518 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002519 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002520 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002521 return (self.is_nan() and other.is_nan() or
2522 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002523 return self._exp == other._exp
2524
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002525 def _rescale(self, exp, rounding):
2526 """Rescale self so that the exponent is exp, either by padding with zeros
2527 or by truncating digits, using the given rounding mode.
2528
2529 Specials are returned without change. This operation is
2530 quiet: it raises no flags, and uses no information from the
2531 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532
2533 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002534 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002535 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002536 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002537 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002538 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002539 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002540
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002541 if self._exp >= exp:
2542 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002543 return _dec_from_triple(self._sign,
2544 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002545
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002546 # too many digits; round and lose data. If self.adjusted() <
2547 # exp-1, replace self by 10**(exp-1) before rounding
2548 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002549 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002550 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002551 digits = 0
2552 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002553 changed = this_function(digits)
2554 coeff = self._int[:digits] or '0'
2555 if changed == 1:
2556 coeff = str(int(coeff)+1)
2557 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002558
Christian Heimesf16baeb2008-02-29 14:57:44 +00002559 def _round(self, places, rounding):
2560 """Round a nonzero, nonspecial Decimal to a fixed number of
2561 significant figures, using the given rounding mode.
2562
2563 Infinities, NaNs and zeros are returned unaltered.
2564
2565 This operation is quiet: it raises no flags, and uses no
2566 information from the context.
2567
2568 """
2569 if places <= 0:
2570 raise ValueError("argument should be at least 1 in _round")
2571 if self._is_special or not self:
2572 return Decimal(self)
2573 ans = self._rescale(self.adjusted()+1-places, rounding)
2574 # it can happen that the rescale alters the adjusted exponent;
2575 # for example when rounding 99.97 to 3 significant figures.
2576 # When this happens we end up with an extra 0 at the end of
2577 # the number; a second rescale fixes this.
2578 if ans.adjusted() != self.adjusted():
2579 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2580 return ans
2581
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002582 def to_integral_exact(self, rounding=None, context=None):
2583 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002585 If no rounding mode is specified, take the rounding mode from
2586 the context. This method raises the Rounded and Inexact flags
2587 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002588
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002589 See also: to_integral_value, which does exactly the same as
2590 this method except that it doesn't raise Inexact or Rounded.
2591 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002592 if self._is_special:
2593 ans = self._check_nans(context=context)
2594 if ans:
2595 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002596 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002597 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002598 return Decimal(self)
2599 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002600 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002601 if context is None:
2602 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002603 if rounding is None:
2604 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 ans = self._rescale(0, rounding)
2606 if ans != self:
2607 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002608 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002609 return ans
2610
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002611 def to_integral_value(self, rounding=None, context=None):
2612 """Rounds to the nearest integer, without raising inexact, rounded."""
2613 if context is None:
2614 context = getcontext()
2615 if rounding is None:
2616 rounding = context.rounding
2617 if self._is_special:
2618 ans = self._check_nans(context=context)
2619 if ans:
2620 return ans
2621 return Decimal(self)
2622 if self._exp >= 0:
2623 return Decimal(self)
2624 else:
2625 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002626
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002627 # the method name changed, but we provide also the old one, for compatibility
2628 to_integral = to_integral_value
2629
2630 def sqrt(self, context=None):
2631 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002632 if context is None:
2633 context = getcontext()
2634
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002635 if self._is_special:
2636 ans = self._check_nans(context=context)
2637 if ans:
2638 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002640 if self._isinfinity() and self._sign == 0:
2641 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002642
2643 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002644 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002645 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002646 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002647
2648 if self._sign == 1:
2649 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2650
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002651 # At this point self represents a positive number. Let p be
2652 # the desired precision and express self in the form c*100**e
2653 # with c a positive real number and e an integer, c and e
2654 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2655 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2656 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2657 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2658 # the closest integer to sqrt(c) with the even integer chosen
2659 # in the case of a tie.
2660 #
2661 # To ensure correct rounding in all cases, we use the
2662 # following trick: we compute the square root to an extra
2663 # place (precision p+1 instead of precision p), rounding down.
2664 # Then, if the result is inexact and its last digit is 0 or 5,
2665 # we increase the last digit to 1 or 6 respectively; if it's
2666 # exact we leave the last digit alone. Now the final round to
2667 # p places (or fewer in the case of underflow) will round
2668 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002669
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002670 # use an extra digit of precision
2671 prec = context.prec+1
2672
2673 # write argument in the form c*100**e where e = self._exp//2
2674 # is the 'ideal' exponent, to be used if the square root is
2675 # exactly representable. l is the number of 'digits' of c in
2676 # base 100, so that 100**(l-1) <= c < 100**l.
2677 op = _WorkRep(self)
2678 e = op.exp >> 1
2679 if op.exp & 1:
2680 c = op.int * 10
2681 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002683 c = op.int
2684 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002685
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002686 # rescale so that c has exactly prec base 100 'digits'
2687 shift = prec-l
2688 if shift >= 0:
2689 c *= 100**shift
2690 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002691 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002692 c, remainder = divmod(c, 100**-shift)
2693 exact = not remainder
2694 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002695
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002696 # find n = floor(sqrt(c)) using Newton's method
2697 n = 10**prec
2698 while True:
2699 q = c//n
2700 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002701 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002702 else:
2703 n = n + q >> 1
2704 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002706 if exact:
2707 # result is exact; rescale to use ideal exponent e
2708 if shift >= 0:
2709 # assert n % 10**shift == 0
2710 n //= 10**shift
2711 else:
2712 n *= 10**-shift
2713 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002714 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002715 # result is not exact; fix last digit as described above
2716 if n % 5 == 0:
2717 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002718
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002719 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002720
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002721 # round, and fit to current context
2722 context = context._shallow_copy()
2723 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002724 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002725 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002726
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002727 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002728
2729 def max(self, other, context=None):
2730 """Returns the larger value.
2731
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002732 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002733 NaN (and signals if one is sNaN). Also rounds.
2734 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002735 other = _convert_other(other, raiseit=True)
2736
2737 if context is None:
2738 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002739
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002740 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002741 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002742 # number is always returned
2743 sn = self._isnan()
2744 on = other._isnan()
2745 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002746 if on == 1 and sn == 0:
2747 return self._fix(context)
2748 if sn == 1 and on == 0:
2749 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002750 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002751
Christian Heimes77c02eb2008-02-09 02:18:51 +00002752 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002753 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002754 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002755 # then an ordering is applied:
2756 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002757 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002758 # positive sign and min returns the operand with the negative sign
2759 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002760 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 # the result. This is exactly the ordering used in compare_total.
2762 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002763
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002764 if c == -1:
2765 ans = other
2766 else:
2767 ans = self
2768
Christian Heimes2c181612007-12-17 20:04:13 +00002769 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002770
2771 def min(self, other, context=None):
2772 """Returns the smaller value.
2773
Guido van Rossumd8faa362007-04-27 19:54:29 +00002774 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002775 NaN (and signals if one is sNaN). Also rounds.
2776 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002777 other = _convert_other(other, raiseit=True)
2778
2779 if context is None:
2780 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002781
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002782 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002783 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002784 # number is always returned
2785 sn = self._isnan()
2786 on = other._isnan()
2787 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002788 if on == 1 and sn == 0:
2789 return self._fix(context)
2790 if sn == 1 and on == 0:
2791 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002792 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002793
Christian Heimes77c02eb2008-02-09 02:18:51 +00002794 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002795 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002796 c = self.compare_total(other)
2797
2798 if c == -1:
2799 ans = self
2800 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002801 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002802
Christian Heimes2c181612007-12-17 20:04:13 +00002803 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002804
2805 def _isinteger(self):
2806 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002807 if self._is_special:
2808 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002809 if self._exp >= 0:
2810 return True
2811 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002812 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002813
2814 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002815 """Returns True if self is even. Assumes self is an integer."""
2816 if not self or self._exp > 0:
2817 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002818 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002819
2820 def adjusted(self):
2821 """Return the adjusted exponent of self"""
2822 try:
2823 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002824 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002825 except TypeError:
2826 return 0
2827
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002828 def canonical(self, context=None):
2829 """Returns the same Decimal object.
2830
2831 As we do not have different encodings for the same number, the
2832 received object already is in its canonical form.
2833 """
2834 return self
2835
2836 def compare_signal(self, other, context=None):
2837 """Compares self to the other operand numerically.
2838
2839 It's pretty much like compare(), but all NaNs signal, with signaling
2840 NaNs taking precedence over quiet NaNs.
2841 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002842 other = _convert_other(other, raiseit = True)
2843 ans = self._compare_check_nans(other, context)
2844 if ans:
2845 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002846 return self.compare(other, context=context)
2847
2848 def compare_total(self, other):
2849 """Compares self to other using the abstract representations.
2850
2851 This is not like the standard compare, which use their numerical
2852 value. Note that a total ordering is defined for all possible abstract
2853 representations.
2854 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002855 other = _convert_other(other, raiseit=True)
2856
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002857 # if one is negative and the other is positive, it's easy
2858 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002859 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002860 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002861 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002862 sign = self._sign
2863
2864 # let's handle both NaN types
2865 self_nan = self._isnan()
2866 other_nan = other._isnan()
2867 if self_nan or other_nan:
2868 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002869 # compare payloads as though they're integers
2870 self_key = len(self._int), self._int
2871 other_key = len(other._int), other._int
2872 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002873 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002874 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002875 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002876 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002877 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002878 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002879 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002881 return _One
2882 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002883
2884 if sign:
2885 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002886 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002887 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002888 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002889 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002890 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002891 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002892 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002893 else:
2894 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002895 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002897 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002898 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002899 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002900 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002901 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002902
2903 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002904 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002905 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002906 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002907
2908 if self._exp < other._exp:
2909 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002910 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002911 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002912 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002913 if self._exp > other._exp:
2914 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002915 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002917 return _One
2918 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002919
2920
2921 def compare_total_mag(self, other):
2922 """Compares self to other using abstract repr., ignoring sign.
2923
2924 Like compare_total, but with operand's sign ignored and assumed to be 0.
2925 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002926 other = _convert_other(other, raiseit=True)
2927
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002928 s = self.copy_abs()
2929 o = other.copy_abs()
2930 return s.compare_total(o)
2931
2932 def copy_abs(self):
2933 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002934 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002935
2936 def copy_negate(self):
2937 """Returns a copy with the sign inverted."""
2938 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002939 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002940 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002941 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002942
2943 def copy_sign(self, other):
2944 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002945 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002946 return _dec_from_triple(other._sign, self._int,
2947 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002948
2949 def exp(self, context=None):
2950 """Returns e ** self."""
2951
2952 if context is None:
2953 context = getcontext()
2954
2955 # exp(NaN) = NaN
2956 ans = self._check_nans(context=context)
2957 if ans:
2958 return ans
2959
2960 # exp(-Infinity) = 0
2961 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002962 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002963
2964 # exp(0) = 1
2965 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002966 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002967
2968 # exp(Infinity) = Infinity
2969 if self._isinfinity() == 1:
2970 return Decimal(self)
2971
2972 # the result is now guaranteed to be inexact (the true
2973 # mathematical result is transcendental). There's no need to
2974 # raise Rounded and Inexact here---they'll always be raised as
2975 # a result of the call to _fix.
2976 p = context.prec
2977 adj = self.adjusted()
2978
2979 # we only need to do any computation for quite a small range
2980 # of adjusted exponents---for example, -29 <= adj <= 10 for
2981 # the default context. For smaller exponent the result is
2982 # indistinguishable from 1 at the given precision, while for
2983 # larger exponent the result either overflows or underflows.
2984 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2985 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002986 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002987 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2988 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002989 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002990 elif self._sign == 0 and adj < -p:
2991 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002992 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002993 elif self._sign == 1 and adj < -p-1:
2994 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002995 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002996 # general case
2997 else:
2998 op = _WorkRep(self)
2999 c, e = op.int, op.exp
3000 if op.sign == 1:
3001 c = -c
3002
3003 # compute correctly rounded result: increase precision by
3004 # 3 digits at a time until we get an unambiguously
3005 # roundable result
3006 extra = 3
3007 while True:
3008 coeff, exp = _dexp(c, e, p+extra)
3009 if coeff % (5*10**(len(str(coeff))-p-1)):
3010 break
3011 extra += 3
3012
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003013 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003014
3015 # at this stage, ans should round correctly with *any*
3016 # rounding mode, not just with ROUND_HALF_EVEN
3017 context = context._shallow_copy()
3018 rounding = context._set_rounding(ROUND_HALF_EVEN)
3019 ans = ans._fix(context)
3020 context.rounding = rounding
3021
3022 return ans
3023
3024 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003025 """Return True if self is canonical; otherwise return False.
3026
3027 Currently, the encoding of a Decimal instance is always
3028 canonical, so this method returns True for any Decimal.
3029 """
3030 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003031
3032 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003033 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003034
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003035 A Decimal instance is considered finite if it is neither
3036 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003037 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003038 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003039
3040 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003041 """Return True if self is infinite; otherwise return False."""
3042 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003043
3044 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003045 """Return True if self is a qNaN or sNaN; otherwise return False."""
3046 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003047
3048 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003049 """Return True if self is a normal number; otherwise return False."""
3050 if self._is_special or not self:
3051 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003052 if context is None:
3053 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003054 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003055
3056 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003057 """Return True if self is a quiet NaN; otherwise return False."""
3058 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003059
3060 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003061 """Return True if self is negative; otherwise return False."""
3062 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003063
3064 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003065 """Return True if self is a signaling NaN; otherwise return False."""
3066 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003067
3068 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003069 """Return True if self is subnormal; otherwise return False."""
3070 if self._is_special or not self:
3071 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003072 if context is None:
3073 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003074 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003075
3076 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003077 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003078 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003079
3080 def _ln_exp_bound(self):
3081 """Compute a lower bound for the adjusted exponent of self.ln().
3082 In other words, compute r such that self.ln() >= 10**r. Assumes
3083 that self is finite and positive and that self != 1.
3084 """
3085
3086 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3087 adj = self._exp + len(self._int) - 1
3088 if adj >= 1:
3089 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3090 return len(str(adj*23//10)) - 1
3091 if adj <= -2:
3092 # argument <= 0.1
3093 return len(str((-1-adj)*23//10)) - 1
3094 op = _WorkRep(self)
3095 c, e = op.int, op.exp
3096 if adj == 0:
3097 # 1 < self < 10
3098 num = str(c-10**-e)
3099 den = str(c)
3100 return len(num) - len(den) - (num < den)
3101 # adj == -1, 0.1 <= self < 1
3102 return e + len(str(10**-e - c)) - 1
3103
3104
3105 def ln(self, context=None):
3106 """Returns the natural (base e) logarithm of self."""
3107
3108 if context is None:
3109 context = getcontext()
3110
3111 # ln(NaN) = NaN
3112 ans = self._check_nans(context=context)
3113 if ans:
3114 return ans
3115
3116 # ln(0.0) == -Infinity
3117 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003118 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003119
3120 # ln(Infinity) = Infinity
3121 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003122 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003123
3124 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003125 if self == _One:
3126 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003127
3128 # ln(negative) raises InvalidOperation
3129 if self._sign == 1:
3130 return context._raise_error(InvalidOperation,
3131 'ln of a negative value')
3132
3133 # result is irrational, so necessarily inexact
3134 op = _WorkRep(self)
3135 c, e = op.int, op.exp
3136 p = context.prec
3137
3138 # correctly rounded result: repeatedly increase precision by 3
3139 # until we get an unambiguously roundable result
3140 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3141 while True:
3142 coeff = _dlog(c, e, places)
3143 # assert len(str(abs(coeff)))-p >= 1
3144 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3145 break
3146 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003147 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003148
3149 context = context._shallow_copy()
3150 rounding = context._set_rounding(ROUND_HALF_EVEN)
3151 ans = ans._fix(context)
3152 context.rounding = rounding
3153 return ans
3154
3155 def _log10_exp_bound(self):
3156 """Compute a lower bound for the adjusted exponent of self.log10().
3157 In other words, find r such that self.log10() >= 10**r.
3158 Assumes that self is finite and positive and that self != 1.
3159 """
3160
3161 # For x >= 10 or x < 0.1 we only need a bound on the integer
3162 # part of log10(self), and this comes directly from the
3163 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3164 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3165 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3166
3167 adj = self._exp + len(self._int) - 1
3168 if adj >= 1:
3169 # self >= 10
3170 return len(str(adj))-1
3171 if adj <= -2:
3172 # self < 0.1
3173 return len(str(-1-adj))-1
3174 op = _WorkRep(self)
3175 c, e = op.int, op.exp
3176 if adj == 0:
3177 # 1 < self < 10
3178 num = str(c-10**-e)
3179 den = str(231*c)
3180 return len(num) - len(den) - (num < den) + 2
3181 # adj == -1, 0.1 <= self < 1
3182 num = str(10**-e-c)
3183 return len(num) + e - (num < "231") - 1
3184
3185 def log10(self, context=None):
3186 """Returns the base 10 logarithm of self."""
3187
3188 if context is None:
3189 context = getcontext()
3190
3191 # log10(NaN) = NaN
3192 ans = self._check_nans(context=context)
3193 if ans:
3194 return ans
3195
3196 # log10(0.0) == -Infinity
3197 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003198 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003199
3200 # log10(Infinity) = Infinity
3201 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003202 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003203
3204 # log10(negative or -Infinity) raises InvalidOperation
3205 if self._sign == 1:
3206 return context._raise_error(InvalidOperation,
3207 'log10 of a negative value')
3208
3209 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003210 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003211 # answer may need rounding
3212 ans = Decimal(self._exp + len(self._int) - 1)
3213 else:
3214 # result is irrational, so necessarily inexact
3215 op = _WorkRep(self)
3216 c, e = op.int, op.exp
3217 p = context.prec
3218
3219 # correctly rounded result: repeatedly increase precision
3220 # until result is unambiguously roundable
3221 places = p-self._log10_exp_bound()+2
3222 while True:
3223 coeff = _dlog10(c, e, places)
3224 # assert len(str(abs(coeff)))-p >= 1
3225 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3226 break
3227 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003228 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003229
3230 context = context._shallow_copy()
3231 rounding = context._set_rounding(ROUND_HALF_EVEN)
3232 ans = ans._fix(context)
3233 context.rounding = rounding
3234 return ans
3235
3236 def logb(self, context=None):
3237 """ Returns the exponent of the magnitude of self's MSD.
3238
3239 The result is the integer which is the exponent of the magnitude
3240 of the most significant digit of self (as though it were truncated
3241 to a single digit while maintaining the value of that digit and
3242 without limiting the resulting exponent).
3243 """
3244 # logb(NaN) = NaN
3245 ans = self._check_nans(context=context)
3246 if ans:
3247 return ans
3248
3249 if context is None:
3250 context = getcontext()
3251
3252 # logb(+/-Inf) = +Inf
3253 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003254 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003255
3256 # logb(0) = -Inf, DivisionByZero
3257 if not self:
3258 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3259
3260 # otherwise, simply return the adjusted exponent of self, as a
3261 # Decimal. Note that no attempt is made to fit the result
3262 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003263 ans = Decimal(self.adjusted())
3264 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003265
3266 def _islogical(self):
3267 """Return True if self is a logical operand.
3268
Christian Heimes679db4a2008-01-18 09:56:22 +00003269 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003270 an exponent of 0, and a coefficient whose digits must all be
3271 either 0 or 1.
3272 """
3273 if self._sign != 0 or self._exp != 0:
3274 return False
3275 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003276 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003277 return False
3278 return True
3279
3280 def _fill_logical(self, context, opa, opb):
3281 dif = context.prec - len(opa)
3282 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003283 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003284 elif dif < 0:
3285 opa = opa[-context.prec:]
3286 dif = context.prec - len(opb)
3287 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003288 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003289 elif dif < 0:
3290 opb = opb[-context.prec:]
3291 return opa, opb
3292
3293 def logical_and(self, other, context=None):
3294 """Applies an 'and' operation between self and other's digits."""
3295 if context is None:
3296 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003297
3298 other = _convert_other(other, raiseit=True)
3299
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003300 if not self._islogical() or not other._islogical():
3301 return context._raise_error(InvalidOperation)
3302
3303 # fill to context.prec
3304 (opa, opb) = self._fill_logical(context, self._int, other._int)
3305
3306 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003307 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3308 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003309
3310 def logical_invert(self, context=None):
3311 """Invert all its digits."""
3312 if context is None:
3313 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003314 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3315 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003316
3317 def logical_or(self, other, context=None):
3318 """Applies an 'or' operation between self and other's digits."""
3319 if context is None:
3320 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003321
3322 other = _convert_other(other, raiseit=True)
3323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003324 if not self._islogical() or not other._islogical():
3325 return context._raise_error(InvalidOperation)
3326
3327 # fill to context.prec
3328 (opa, opb) = self._fill_logical(context, self._int, other._int)
3329
3330 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003331 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003332 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003333
3334 def logical_xor(self, other, context=None):
3335 """Applies an 'xor' operation between self and other's digits."""
3336 if context is None:
3337 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003338
3339 other = _convert_other(other, raiseit=True)
3340
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003341 if not self._islogical() or not other._islogical():
3342 return context._raise_error(InvalidOperation)
3343
3344 # fill to context.prec
3345 (opa, opb) = self._fill_logical(context, self._int, other._int)
3346
3347 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003348 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003349 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003350
3351 def max_mag(self, other, context=None):
3352 """Compares the values numerically with their sign ignored."""
3353 other = _convert_other(other, raiseit=True)
3354
3355 if context is None:
3356 context = getcontext()
3357
3358 if self._is_special or other._is_special:
3359 # If one operand is a quiet NaN and the other is number, then the
3360 # number is always returned
3361 sn = self._isnan()
3362 on = other._isnan()
3363 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003364 if on == 1 and sn == 0:
3365 return self._fix(context)
3366 if sn == 1 and on == 0:
3367 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003368 return self._check_nans(other, context)
3369
Christian Heimes77c02eb2008-02-09 02:18:51 +00003370 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003371 if c == 0:
3372 c = self.compare_total(other)
3373
3374 if c == -1:
3375 ans = other
3376 else:
3377 ans = self
3378
Christian Heimes2c181612007-12-17 20:04:13 +00003379 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003380
3381 def min_mag(self, other, context=None):
3382 """Compares the values numerically with their sign ignored."""
3383 other = _convert_other(other, raiseit=True)
3384
3385 if context is None:
3386 context = getcontext()
3387
3388 if self._is_special or other._is_special:
3389 # If one operand is a quiet NaN and the other is number, then the
3390 # number is always returned
3391 sn = self._isnan()
3392 on = other._isnan()
3393 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003394 if on == 1 and sn == 0:
3395 return self._fix(context)
3396 if sn == 1 and on == 0:
3397 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003398 return self._check_nans(other, context)
3399
Christian Heimes77c02eb2008-02-09 02:18:51 +00003400 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003401 if c == 0:
3402 c = self.compare_total(other)
3403
3404 if c == -1:
3405 ans = self
3406 else:
3407 ans = other
3408
Christian Heimes2c181612007-12-17 20:04:13 +00003409 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003410
3411 def next_minus(self, context=None):
3412 """Returns the largest representable number smaller than itself."""
3413 if context is None:
3414 context = getcontext()
3415
3416 ans = self._check_nans(context=context)
3417 if ans:
3418 return ans
3419
3420 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003421 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003422 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003423 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003424
3425 context = context.copy()
3426 context._set_rounding(ROUND_FLOOR)
3427 context._ignore_all_flags()
3428 new_self = self._fix(context)
3429 if new_self != self:
3430 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003431 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3432 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003433
3434 def next_plus(self, context=None):
3435 """Returns the smallest representable number larger than itself."""
3436 if context is None:
3437 context = getcontext()
3438
3439 ans = self._check_nans(context=context)
3440 if ans:
3441 return ans
3442
3443 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003444 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003445 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003446 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003447
3448 context = context.copy()
3449 context._set_rounding(ROUND_CEILING)
3450 context._ignore_all_flags()
3451 new_self = self._fix(context)
3452 if new_self != self:
3453 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003454 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3455 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003456
3457 def next_toward(self, other, context=None):
3458 """Returns the number closest to self, in the direction towards other.
3459
3460 The result is the closest representable number to self
3461 (excluding self) that is in the direction towards other,
3462 unless both have the same value. If the two operands are
3463 numerically equal, then the result is a copy of self with the
3464 sign set to be the same as the sign of other.
3465 """
3466 other = _convert_other(other, raiseit=True)
3467
3468 if context is None:
3469 context = getcontext()
3470
3471 ans = self._check_nans(other, context)
3472 if ans:
3473 return ans
3474
Christian Heimes77c02eb2008-02-09 02:18:51 +00003475 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003476 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003477 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003478
3479 if comparison == -1:
3480 ans = self.next_plus(context)
3481 else: # comparison == 1
3482 ans = self.next_minus(context)
3483
3484 # decide which flags to raise using value of ans
3485 if ans._isinfinity():
3486 context._raise_error(Overflow,
3487 'Infinite result from next_toward',
3488 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003489 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003490 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003491 elif ans.adjusted() < context.Emin:
3492 context._raise_error(Underflow)
3493 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003494 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003495 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003496 # if precision == 1 then we don't raise Clamped for a
3497 # result 0E-Etiny.
3498 if not ans:
3499 context._raise_error(Clamped)
3500
3501 return ans
3502
3503 def number_class(self, context=None):
3504 """Returns an indication of the class of self.
3505
3506 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003507 sNaN
3508 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003509 -Infinity
3510 -Normal
3511 -Subnormal
3512 -Zero
3513 +Zero
3514 +Subnormal
3515 +Normal
3516 +Infinity
3517 """
3518 if self.is_snan():
3519 return "sNaN"
3520 if self.is_qnan():
3521 return "NaN"
3522 inf = self._isinfinity()
3523 if inf == 1:
3524 return "+Infinity"
3525 if inf == -1:
3526 return "-Infinity"
3527 if self.is_zero():
3528 if self._sign:
3529 return "-Zero"
3530 else:
3531 return "+Zero"
3532 if context is None:
3533 context = getcontext()
3534 if self.is_subnormal(context=context):
3535 if self._sign:
3536 return "-Subnormal"
3537 else:
3538 return "+Subnormal"
3539 # just a normal, regular, boring number, :)
3540 if self._sign:
3541 return "-Normal"
3542 else:
3543 return "+Normal"
3544
3545 def radix(self):
3546 """Just returns 10, as this is Decimal, :)"""
3547 return Decimal(10)
3548
3549 def rotate(self, other, context=None):
3550 """Returns a rotated copy of self, value-of-other times."""
3551 if context is None:
3552 context = getcontext()
3553
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003554 other = _convert_other(other, raiseit=True)
3555
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003556 ans = self._check_nans(other, context)
3557 if ans:
3558 return ans
3559
3560 if other._exp != 0:
3561 return context._raise_error(InvalidOperation)
3562 if not (-context.prec <= int(other) <= context.prec):
3563 return context._raise_error(InvalidOperation)
3564
3565 if self._isinfinity():
3566 return Decimal(self)
3567
3568 # get values, pad if necessary
3569 torot = int(other)
3570 rotdig = self._int
3571 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003572 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003573 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003574 elif topad < 0:
3575 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003576
3577 # let's rotate!
3578 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003579 return _dec_from_triple(self._sign,
3580 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003581
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003582 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003583 """Returns self operand after adding the second value to its exp."""
3584 if context is None:
3585 context = getcontext()
3586
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003587 other = _convert_other(other, raiseit=True)
3588
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003589 ans = self._check_nans(other, context)
3590 if ans:
3591 return ans
3592
3593 if other._exp != 0:
3594 return context._raise_error(InvalidOperation)
3595 liminf = -2 * (context.Emax + context.prec)
3596 limsup = 2 * (context.Emax + context.prec)
3597 if not (liminf <= int(other) <= limsup):
3598 return context._raise_error(InvalidOperation)
3599
3600 if self._isinfinity():
3601 return Decimal(self)
3602
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003603 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003604 d = d._fix(context)
3605 return d
3606
3607 def shift(self, other, context=None):
3608 """Returns a shifted copy of self, value-of-other times."""
3609 if context is None:
3610 context = getcontext()
3611
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003612 other = _convert_other(other, raiseit=True)
3613
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003614 ans = self._check_nans(other, context)
3615 if ans:
3616 return ans
3617
3618 if other._exp != 0:
3619 return context._raise_error(InvalidOperation)
3620 if not (-context.prec <= int(other) <= context.prec):
3621 return context._raise_error(InvalidOperation)
3622
3623 if self._isinfinity():
3624 return Decimal(self)
3625
3626 # get values, pad if necessary
3627 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003628 rotdig = self._int
3629 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003630 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003631 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003632 elif topad < 0:
3633 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003634
3635 # let's shift!
3636 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003637 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003638 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003639 shifted = rotdig + '0'*torot
3640 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003641
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003642 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003643 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003644
Guido van Rossumd8faa362007-04-27 19:54:29 +00003645 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003646 def __reduce__(self):
3647 return (self.__class__, (str(self),))
3648
3649 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003650 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003651 return self # I'm immutable; therefore I am my own clone
3652 return self.__class__(str(self))
3653
3654 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003655 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003656 return self # My components are also immutable
3657 return self.__class__(str(self))
3658
Mark Dickinson79f52032009-03-17 23:12:51 +00003659 # PEP 3101 support. the _localeconv keyword argument should be
3660 # considered private: it's provided for ease of testing only.
3661 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003662 """Format a Decimal instance according to the given specifier.
3663
3664 The specifier should be a standard format specifier, with the
3665 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003666 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3667 type is omitted it defaults to 'g' or 'G', depending on the
3668 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003669 """
3670
3671 # Note: PEP 3101 says that if the type is not present then
3672 # there should be at least one digit after the decimal point.
3673 # We take the liberty of ignoring this requirement for
3674 # Decimal---it's presumably there to make sure that
3675 # format(float, '') behaves similarly to str(float).
3676 if context is None:
3677 context = getcontext()
3678
Mark Dickinson79f52032009-03-17 23:12:51 +00003679 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003680
Mark Dickinson79f52032009-03-17 23:12:51 +00003681 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003682 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003683 sign = _format_sign(self._sign, spec)
3684 body = str(self.copy_abs())
3685 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003686
3687 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003688 if spec['type'] is None:
3689 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003690
3691 # if type is '%', adjust exponent of self accordingly
3692 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003693 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3694
3695 # round if necessary, taking rounding mode from the context
3696 rounding = context.rounding
3697 precision = spec['precision']
3698 if precision is not None:
3699 if spec['type'] in 'eE':
3700 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003701 elif spec['type'] in 'fF%':
3702 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003703 elif spec['type'] in 'gG' and len(self._int) > precision:
3704 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003705 # special case: zeros with a positive exponent can't be
3706 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003707 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003708 self = self._rescale(0, rounding)
3709
3710 # figure out placement of the decimal point
3711 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003712 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003713 if not self and precision is not None:
3714 dotplace = 1 - precision
3715 else:
3716 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003717 elif spec['type'] in 'fF%':
3718 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003719 elif spec['type'] in 'gG':
3720 if self._exp <= 0 and leftdigits > -6:
3721 dotplace = leftdigits
3722 else:
3723 dotplace = 1
3724
Mark Dickinson79f52032009-03-17 23:12:51 +00003725 # find digits before and after decimal point, and get exponent
3726 if dotplace < 0:
3727 intpart = '0'
3728 fracpart = '0'*(-dotplace) + self._int
3729 elif dotplace > len(self._int):
3730 intpart = self._int + '0'*(dotplace-len(self._int))
3731 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003732 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003733 intpart = self._int[:dotplace] or '0'
3734 fracpart = self._int[dotplace:]
3735 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003736
Mark Dickinson79f52032009-03-17 23:12:51 +00003737 # done with the decimal-specific stuff; hand over the rest
3738 # of the formatting to the _format_number function
3739 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003740
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003741def _dec_from_triple(sign, coefficient, exponent, special=False):
3742 """Create a decimal instance directly, without any validation,
3743 normalization (e.g. removal of leading zeros) or argument
3744 conversion.
3745
3746 This function is for *internal use only*.
3747 """
3748
3749 self = object.__new__(Decimal)
3750 self._sign = sign
3751 self._int = coefficient
3752 self._exp = exponent
3753 self._is_special = special
3754
3755 return self
3756
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003757# Register Decimal as a kind of Number (an abstract base class).
3758# However, do not register it as Real (because Decimals are not
3759# interoperable with floats).
3760_numbers.Number.register(Decimal)
3761
3762
Guido van Rossumd8faa362007-04-27 19:54:29 +00003763##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003764
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765
3766# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003767rounding_functions = [name for name in Decimal.__dict__.keys()
3768 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003769for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003770 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003771 globalname = name[1:].upper()
3772 val = globals()[globalname]
3773 Decimal._pick_rounding_function[val] = name
3774
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003775del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003776
Thomas Wouters89f507f2006-12-13 04:49:30 +00003777class _ContextManager(object):
3778 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003779
Thomas Wouters89f507f2006-12-13 04:49:30 +00003780 Sets a copy of the supplied context in __enter__() and restores
3781 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003782 """
3783 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003784 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003785 def __enter__(self):
3786 self.saved_context = getcontext()
3787 setcontext(self.new_context)
3788 return self.new_context
3789 def __exit__(self, t, v, tb):
3790 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003791
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003792class Context(object):
3793 """Contains the context for a Decimal instance.
3794
3795 Contains:
3796 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003797 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003798 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799 raised when it is caused. Otherwise, a value is
3800 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003801 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003802 (Whether or not the trap_enabler is set)
3803 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003804 Emin - Minimum exponent
3805 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003806 capitals - If 1, 1*10^1 is printed as 1E+1.
3807 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003808 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003809 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003810
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003811 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003812 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003813 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003814 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003815 _ignored_flags=None):
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003816 # Set defaults; for everything except flags and _ignored_flags,
3817 # inherit from DefaultContext.
3818 try:
3819 dc = DefaultContext
3820 except NameError:
3821 pass
3822
3823 self.prec = prec if prec is not None else dc.prec
3824 self.rounding = rounding if rounding is not None else dc.rounding
3825 self.Emin = Emin if Emin is not None else dc.Emin
3826 self.Emax = Emax if Emax is not None else dc.Emax
3827 self.capitals = capitals if capitals is not None else dc.capitals
3828 self.clamp = clamp if clamp is not None else dc.clamp
3829
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003830 if _ignored_flags is None:
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003831 self._ignored_flags = []
3832 else:
3833 self._ignored_flags = _ignored_flags
3834
3835 if traps is None:
3836 self.traps = dc.traps.copy()
3837 elif not isinstance(traps, dict):
3838 self.traps = dict((s, int(s in traps)) for s in _signals)
3839 else:
3840 self.traps = traps
3841
3842 if flags is None:
3843 self.flags = dict.fromkeys(_signals, 0)
3844 elif not isinstance(flags, dict):
3845 self.flags = dict((s, int(s in flags)) for s in _signals)
3846 else:
3847 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003848
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003849 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003850 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003851 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003852 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003853 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3854 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003855 % vars(self))
3856 names = [f.__name__ for f, v in self.flags.items() if v]
3857 s.append('flags=[' + ', '.join(names) + ']')
3858 names = [t.__name__ for t, v in self.traps.items() if v]
3859 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003860 return ', '.join(s) + ')'
3861
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003862 def clear_flags(self):
3863 """Reset all flags to zero"""
3864 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003865 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003866
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003867 def _shallow_copy(self):
3868 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003869 nc = Context(self.prec, self.rounding, self.traps,
3870 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003871 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003872 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003873
3874 def copy(self):
3875 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003876 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003877 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003878 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003879 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003880 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003881
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003882 # _clamp is provided for backwards compatibility with third-party
3883 # code. May be removed in Python >= 3.3.
3884 def _get_clamp(self):
3885 "_clamp mirrors the clamp attribute. Its use is deprecated."
3886 import warnings
3887 warnings.warn('Use of the _clamp attribute is deprecated. '
3888 'Please use clamp instead.',
3889 DeprecationWarning)
3890 return self.clamp
3891
3892 def _set_clamp(self, clamp):
3893 "_clamp mirrors the clamp attribute. Its use is deprecated."
3894 import warnings
3895 warnings.warn('Use of the _clamp attribute is deprecated. '
3896 'Please use clamp instead.',
3897 DeprecationWarning)
3898 self.clamp = clamp
3899
3900 # don't bother with _del_clamp; no sane 3rd party code should
3901 # be deleting the _clamp attribute
3902 _clamp = property(_get_clamp, _set_clamp)
3903
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003904 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003905 """Handles an error
3906
3907 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003908 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003909 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003910 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003911 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003912 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003913 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003914 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003915 return error().handle(self, *args)
3916
Raymond Hettinger86173da2008-02-01 20:38:12 +00003917 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003918 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003919 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003920 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003921
3922 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003923 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003924 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003925
3926 def _ignore_all_flags(self):
3927 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003928 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003929
3930 def _ignore_flags(self, *flags):
3931 """Ignore the flags, if they are raised"""
3932 # Do not mutate-- This way, copies of a context leave the original
3933 # alone.
3934 self._ignored_flags = (self._ignored_flags + list(flags))
3935 return list(flags)
3936
3937 def _regard_flags(self, *flags):
3938 """Stop ignoring the flags, if they are raised"""
3939 if flags and isinstance(flags[0], (tuple,list)):
3940 flags = flags[0]
3941 for flag in flags:
3942 self._ignored_flags.remove(flag)
3943
Nick Coghland1abd252008-07-15 15:46:38 +00003944 # We inherit object.__hash__, so we must deny this explicitly
3945 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003946
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003947 def Etiny(self):
3948 """Returns Etiny (= Emin - prec + 1)"""
3949 return int(self.Emin - self.prec + 1)
3950
3951 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003952 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003953 return int(self.Emax - self.prec + 1)
3954
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003955 def _set_rounding(self, type):
3956 """Sets the rounding type.
3957
3958 Sets the rounding type, and returns the current (previous)
3959 rounding type. Often used like:
3960
3961 context = context.copy()
3962 # so you don't change the calling context
3963 # if an error occurs in the middle.
3964 rounding = context._set_rounding(ROUND_UP)
3965 val = self.__sub__(other, context=context)
3966 context._set_rounding(rounding)
3967
3968 This will make it round up for that operation.
3969 """
3970 rounding = self.rounding
3971 self.rounding= type
3972 return rounding
3973
Raymond Hettingerfed52962004-07-14 15:41:57 +00003974 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003975 """Creates a new Decimal instance but using self as context.
3976
3977 This method implements the to-number operation of the
3978 IBM Decimal specification."""
3979
3980 if isinstance(num, str) and num != num.strip():
3981 return self._raise_error(ConversionSyntax,
3982 "no trailing or leading whitespace is "
3983 "permitted.")
3984
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003985 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003986 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003987 return self._raise_error(ConversionSyntax,
3988 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003989 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003990
Raymond Hettinger771ed762009-01-03 19:20:32 +00003991 def create_decimal_from_float(self, f):
3992 """Creates a new Decimal instance from a float but rounding using self
3993 as the context.
3994
3995 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3996 >>> context.create_decimal_from_float(3.1415926535897932)
3997 Decimal('3.1415')
3998 >>> context = Context(prec=5, traps=[Inexact])
3999 >>> context.create_decimal_from_float(3.1415926535897932)
4000 Traceback (most recent call last):
4001 ...
4002 decimal.Inexact: None
4003
4004 """
4005 d = Decimal.from_float(f) # An exact conversion
4006 return d._fix(self) # Apply the context rounding
4007
Guido van Rossumd8faa362007-04-27 19:54:29 +00004008 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004009 def abs(self, a):
4010 """Returns the absolute value of the operand.
4011
4012 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00004013 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004014 the plus operation on the operand.
4015
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004016 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004017 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004018 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004019 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004020 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004021 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004022 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004023 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004024 >>> ExtendedContext.abs(-1)
4025 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004026 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004027 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004028 return a.__abs__(context=self)
4029
4030 def add(self, a, b):
4031 """Return the sum of the two operands.
4032
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004033 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004034 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004035 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004036 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004037 >>> ExtendedContext.add(1, Decimal(2))
4038 Decimal('3')
4039 >>> ExtendedContext.add(Decimal(8), 5)
4040 Decimal('13')
4041 >>> ExtendedContext.add(5, 5)
4042 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004043 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004044 a = _convert_other(a, raiseit=True)
4045 r = a.__add__(b, context=self)
4046 if r is NotImplemented:
4047 raise TypeError("Unable to convert %s to Decimal" % b)
4048 else:
4049 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004050
4051 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004052 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004053
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004054 def canonical(self, a):
4055 """Returns the same Decimal object.
4056
4057 As we do not have different encodings for the same number, the
4058 received object already is in its canonical form.
4059
4060 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004061 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004062 """
4063 return a.canonical(context=self)
4064
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004065 def compare(self, a, b):
4066 """Compares values numerically.
4067
4068 If the signs of the operands differ, a value representing each operand
4069 ('-1' if the operand is less than zero, '0' if the operand is zero or
4070 negative zero, or '1' if the operand is greater than zero) is used in
4071 place of that operand for the comparison instead of the actual
4072 operand.
4073
4074 The comparison is then effected by subtracting the second operand from
4075 the first and then returning a value according to the result of the
4076 subtraction: '-1' if the result is less than zero, '0' if the result is
4077 zero or negative zero, or '1' if the result is greater than zero.
4078
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004079 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004080 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004081 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004082 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004083 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004084 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004085 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004086 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004087 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004088 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004089 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004091 >>> ExtendedContext.compare(1, 2)
4092 Decimal('-1')
4093 >>> ExtendedContext.compare(Decimal(1), 2)
4094 Decimal('-1')
4095 >>> ExtendedContext.compare(1, Decimal(2))
4096 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004097 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004098 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004099 return a.compare(b, context=self)
4100
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004101 def compare_signal(self, a, b):
4102 """Compares the values of the two operands numerically.
4103
4104 It's pretty much like compare(), but all NaNs signal, with signaling
4105 NaNs taking precedence over quiet NaNs.
4106
4107 >>> c = ExtendedContext
4108 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004109 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004110 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004111 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004112 >>> c.flags[InvalidOperation] = 0
4113 >>> print(c.flags[InvalidOperation])
4114 0
4115 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004116 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004117 >>> print(c.flags[InvalidOperation])
4118 1
4119 >>> c.flags[InvalidOperation] = 0
4120 >>> print(c.flags[InvalidOperation])
4121 0
4122 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004123 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004124 >>> print(c.flags[InvalidOperation])
4125 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004126 >>> c.compare_signal(-1, 2)
4127 Decimal('-1')
4128 >>> c.compare_signal(Decimal(-1), 2)
4129 Decimal('-1')
4130 >>> c.compare_signal(-1, Decimal(2))
4131 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004132 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004133 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004134 return a.compare_signal(b, context=self)
4135
4136 def compare_total(self, a, b):
4137 """Compares two operands using their abstract representation.
4138
4139 This is not like the standard compare, which use their numerical
4140 value. Note that a total ordering is defined for all possible abstract
4141 representations.
4142
4143 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004144 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004145 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004146 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004147 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004148 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004149 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004150 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004151 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004152 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004153 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004154 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004155 >>> ExtendedContext.compare_total(1, 2)
4156 Decimal('-1')
4157 >>> ExtendedContext.compare_total(Decimal(1), 2)
4158 Decimal('-1')
4159 >>> ExtendedContext.compare_total(1, Decimal(2))
4160 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004161 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004162 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004163 return a.compare_total(b)
4164
4165 def compare_total_mag(self, a, b):
4166 """Compares two operands using their abstract representation ignoring sign.
4167
4168 Like compare_total, but with operand's sign ignored and assumed to be 0.
4169 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004170 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004171 return a.compare_total_mag(b)
4172
4173 def copy_abs(self, a):
4174 """Returns a copy of the operand with the sign set to 0.
4175
4176 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004177 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004178 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004179 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004180 >>> ExtendedContext.copy_abs(-1)
4181 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004182 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004183 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004184 return a.copy_abs()
4185
4186 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004187 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004188
4189 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004190 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004191 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004192 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004193 >>> ExtendedContext.copy_decimal(1)
4194 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004195 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004196 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004197 return Decimal(a)
4198
4199 def copy_negate(self, a):
4200 """Returns a copy of the operand with the sign inverted.
4201
4202 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004203 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004204 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004205 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004206 >>> ExtendedContext.copy_negate(1)
4207 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004208 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004209 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004210 return a.copy_negate()
4211
4212 def copy_sign(self, a, b):
4213 """Copies the second operand's sign to the first one.
4214
4215 In detail, it returns a copy of the first operand with the sign
4216 equal to the sign of the second operand.
4217
4218 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004219 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004220 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004221 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004222 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004223 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004224 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004225 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004226 >>> ExtendedContext.copy_sign(1, -2)
4227 Decimal('-1')
4228 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4229 Decimal('-1')
4230 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4231 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004232 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004233 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004234 return a.copy_sign(b)
4235
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004236 def divide(self, a, b):
4237 """Decimal division in a specified context.
4238
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004239 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004240 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004241 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004242 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004243 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004244 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004245 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004246 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004247 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004248 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004249 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004250 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004251 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004252 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004253 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004254 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004255 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004256 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004257 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004258 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004259 >>> ExtendedContext.divide(5, 5)
4260 Decimal('1')
4261 >>> ExtendedContext.divide(Decimal(5), 5)
4262 Decimal('1')
4263 >>> ExtendedContext.divide(5, Decimal(5))
4264 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004265 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004266 a = _convert_other(a, raiseit=True)
4267 r = a.__truediv__(b, context=self)
4268 if r is NotImplemented:
4269 raise TypeError("Unable to convert %s to Decimal" % b)
4270 else:
4271 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004272
4273 def divide_int(self, a, b):
4274 """Divides two numbers and returns the integer part of the result.
4275
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004276 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004277 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004278 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004279 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004280 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004281 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004282 >>> ExtendedContext.divide_int(10, 3)
4283 Decimal('3')
4284 >>> ExtendedContext.divide_int(Decimal(10), 3)
4285 Decimal('3')
4286 >>> ExtendedContext.divide_int(10, Decimal(3))
4287 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004288 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004289 a = _convert_other(a, raiseit=True)
4290 r = a.__floordiv__(b, context=self)
4291 if r is NotImplemented:
4292 raise TypeError("Unable to convert %s to Decimal" % b)
4293 else:
4294 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004295
4296 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004297 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004298
4299 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4300 (Decimal('2'), Decimal('2'))
4301 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4302 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004303 >>> ExtendedContext.divmod(8, 4)
4304 (Decimal('2'), Decimal('0'))
4305 >>> ExtendedContext.divmod(Decimal(8), 4)
4306 (Decimal('2'), Decimal('0'))
4307 >>> ExtendedContext.divmod(8, Decimal(4))
4308 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004309 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004310 a = _convert_other(a, raiseit=True)
4311 r = a.__divmod__(b, context=self)
4312 if r is NotImplemented:
4313 raise TypeError("Unable to convert %s to Decimal" % b)
4314 else:
4315 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004316
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004317 def exp(self, a):
4318 """Returns e ** a.
4319
4320 >>> c = ExtendedContext.copy()
4321 >>> c.Emin = -999
4322 >>> c.Emax = 999
4323 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004324 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004325 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004326 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004327 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004328 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004329 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004330 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004332 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004333 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004334 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004335 >>> c.exp(10)
4336 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004337 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004338 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004339 return a.exp(context=self)
4340
4341 def fma(self, a, b, c):
4342 """Returns a multiplied by b, plus c.
4343
4344 The first two operands are multiplied together, using multiply,
4345 the third operand is then added to the result of that
4346 multiplication, using add, all with only one final rounding.
4347
4348 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004349 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004350 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004351 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004352 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004353 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004354 >>> ExtendedContext.fma(1, 3, 4)
4355 Decimal('7')
4356 >>> ExtendedContext.fma(1, Decimal(3), 4)
4357 Decimal('7')
4358 >>> ExtendedContext.fma(1, 3, Decimal(4))
4359 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004360 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004361 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004362 return a.fma(b, c, context=self)
4363
4364 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004365 """Return True if the operand is canonical; otherwise return False.
4366
4367 Currently, the encoding of a Decimal instance is always
4368 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004369
4370 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004371 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004372 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004373 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374
4375 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004376 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004377
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004378 A Decimal instance is considered finite if it is neither
4379 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004380
4381 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004382 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004383 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004384 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004386 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004387 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004388 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004390 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004391 >>> ExtendedContext.is_finite(1)
4392 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004393 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004394 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004395 return a.is_finite()
4396
4397 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004398 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399
4400 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004401 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004402 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004403 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004405 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004406 >>> ExtendedContext.is_infinite(1)
4407 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004408 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004409 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004410 return a.is_infinite()
4411
4412 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004413 """Return True if the operand is a qNaN or sNaN;
4414 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004415
4416 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004417 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004419 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004421 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004422 >>> ExtendedContext.is_nan(1)
4423 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004424 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004425 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004426 return a.is_nan()
4427
4428 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004429 """Return True if the operand is a normal number;
4430 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004431
4432 >>> c = ExtendedContext.copy()
4433 >>> c.Emin = -999
4434 >>> c.Emax = 999
4435 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004436 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004437 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004438 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004439 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004440 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004442 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004444 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004445 >>> c.is_normal(1)
4446 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004447 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004448 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004449 return a.is_normal(context=self)
4450
4451 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004452 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004453
4454 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004455 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004456 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004457 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004458 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004459 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004460 >>> ExtendedContext.is_qnan(1)
4461 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004462 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004463 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004464 return a.is_qnan()
4465
4466 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004467 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004468
4469 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004470 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004471 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004472 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004473 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004474 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004475 >>> ExtendedContext.is_signed(8)
4476 False
4477 >>> ExtendedContext.is_signed(-8)
4478 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004479 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004480 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004481 return a.is_signed()
4482
4483 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004484 """Return True if the operand is a signaling NaN;
4485 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004486
4487 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004488 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004489 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004490 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004492 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004493 >>> ExtendedContext.is_snan(1)
4494 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004495 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004496 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004497 return a.is_snan()
4498
4499 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004500 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004501
4502 >>> c = ExtendedContext.copy()
4503 >>> c.Emin = -999
4504 >>> c.Emax = 999
4505 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004506 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004507 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004508 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004509 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004510 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004511 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004512 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004514 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004515 >>> c.is_subnormal(1)
4516 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004517 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004518 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004519 return a.is_subnormal(context=self)
4520
4521 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004522 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004523
4524 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004525 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004526 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004527 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004528 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004529 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004530 >>> ExtendedContext.is_zero(1)
4531 False
4532 >>> ExtendedContext.is_zero(0)
4533 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004534 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004535 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004536 return a.is_zero()
4537
4538 def ln(self, a):
4539 """Returns the natural (base e) logarithm of the operand.
4540
4541 >>> c = ExtendedContext.copy()
4542 >>> c.Emin = -999
4543 >>> c.Emax = 999
4544 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004545 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004546 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004547 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004548 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004549 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004550 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004551 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004552 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004553 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004554 >>> c.ln(1)
4555 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004556 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004557 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004558 return a.ln(context=self)
4559
4560 def log10(self, a):
4561 """Returns the base 10 logarithm of the operand.
4562
4563 >>> c = ExtendedContext.copy()
4564 >>> c.Emin = -999
4565 >>> c.Emax = 999
4566 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004567 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004568 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004569 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004570 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004571 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004572 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004573 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004574 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004575 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004576 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004577 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004578 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004579 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004580 >>> c.log10(0)
4581 Decimal('-Infinity')
4582 >>> c.log10(1)
4583 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004584 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004585 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004586 return a.log10(context=self)
4587
4588 def logb(self, a):
4589 """ Returns the exponent of the magnitude of the operand's MSD.
4590
4591 The result is the integer which is the exponent of the magnitude
4592 of the most significant digit of the operand (as though the
4593 operand were truncated to a single digit while maintaining the
4594 value of that digit and without limiting the resulting exponent).
4595
4596 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004597 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004598 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004599 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004600 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004602 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004603 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004604 >>> ExtendedContext.logb(1)
4605 Decimal('0')
4606 >>> ExtendedContext.logb(10)
4607 Decimal('1')
4608 >>> ExtendedContext.logb(100)
4609 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004610 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004611 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004612 return a.logb(context=self)
4613
4614 def logical_and(self, a, b):
4615 """Applies the logical operation 'and' between each operand's digits.
4616
4617 The operands must be both logical numbers.
4618
4619 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004620 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004621 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004622 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004623 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004624 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004625 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004626 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004627 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004631 >>> ExtendedContext.logical_and(110, 1101)
4632 Decimal('100')
4633 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4634 Decimal('100')
4635 >>> ExtendedContext.logical_and(110, Decimal(1101))
4636 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004637 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004638 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004639 return a.logical_and(b, context=self)
4640
4641 def logical_invert(self, a):
4642 """Invert all the digits in the operand.
4643
4644 The operand must be a logical number.
4645
4646 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004647 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004648 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004650 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004654 >>> ExtendedContext.logical_invert(1101)
4655 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004656 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004657 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004658 return a.logical_invert(context=self)
4659
4660 def logical_or(self, a, b):
4661 """Applies the logical operation 'or' between each operand's digits.
4662
4663 The operands must be both logical numbers.
4664
4665 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004666 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004667 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004668 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004669 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004670 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004671 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004672 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004673 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004675 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004677 >>> ExtendedContext.logical_or(110, 1101)
4678 Decimal('1111')
4679 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4680 Decimal('1111')
4681 >>> ExtendedContext.logical_or(110, Decimal(1101))
4682 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004683 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004684 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004685 return a.logical_or(b, context=self)
4686
4687 def logical_xor(self, a, b):
4688 """Applies the logical operation 'xor' between each operand's digits.
4689
4690 The operands must be both logical numbers.
4691
4692 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004693 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004694 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004695 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004696 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004697 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004698 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004699 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004700 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004701 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004702 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004703 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004704 >>> ExtendedContext.logical_xor(110, 1101)
4705 Decimal('1011')
4706 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4707 Decimal('1011')
4708 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4709 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004710 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004711 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004712 return a.logical_xor(b, context=self)
4713
Mark Dickinson84230a12010-02-18 14:49:50 +00004714 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004715 """max compares two values numerically and returns the maximum.
4716
4717 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004718 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004719 operation. If they are numerically equal then the left-hand operand
4720 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004721 infinity) of the two operands is chosen as the result.
4722
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004723 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004724 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004725 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004726 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004727 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004728 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004729 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004730 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004731 >>> ExtendedContext.max(1, 2)
4732 Decimal('2')
4733 >>> ExtendedContext.max(Decimal(1), 2)
4734 Decimal('2')
4735 >>> ExtendedContext.max(1, Decimal(2))
4736 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004737 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004738 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004739 return a.max(b, context=self)
4740
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004741 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004742 """Compares the values numerically with their sign ignored.
4743
4744 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4745 Decimal('7')
4746 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4747 Decimal('-10')
4748 >>> ExtendedContext.max_mag(1, -2)
4749 Decimal('-2')
4750 >>> ExtendedContext.max_mag(Decimal(1), -2)
4751 Decimal('-2')
4752 >>> ExtendedContext.max_mag(1, Decimal(-2))
4753 Decimal('-2')
4754 """
4755 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004756 return a.max_mag(b, context=self)
4757
Mark Dickinson84230a12010-02-18 14:49:50 +00004758 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004759 """min compares two values numerically and returns the minimum.
4760
4761 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004762 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004763 operation. If they are numerically equal then the left-hand operand
4764 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004765 infinity) of the two operands is chosen as the result.
4766
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004767 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004768 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004769 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004770 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004771 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004772 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004773 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004774 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004775 >>> ExtendedContext.min(1, 2)
4776 Decimal('1')
4777 >>> ExtendedContext.min(Decimal(1), 2)
4778 Decimal('1')
4779 >>> ExtendedContext.min(1, Decimal(29))
4780 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004781 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004782 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004783 return a.min(b, context=self)
4784
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004785 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004786 """Compares the values numerically with their sign ignored.
4787
4788 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4789 Decimal('-2')
4790 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4791 Decimal('-3')
4792 >>> ExtendedContext.min_mag(1, -2)
4793 Decimal('1')
4794 >>> ExtendedContext.min_mag(Decimal(1), -2)
4795 Decimal('1')
4796 >>> ExtendedContext.min_mag(1, Decimal(-2))
4797 Decimal('1')
4798 """
4799 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004800 return a.min_mag(b, context=self)
4801
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004802 def minus(self, a):
4803 """Minus corresponds to unary prefix minus in Python.
4804
4805 The operation is evaluated using the same rules as subtract; the
4806 operation minus(a) is calculated as subtract('0', a) where the '0'
4807 has the same exponent as the operand.
4808
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004809 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004810 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004811 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004812 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004813 >>> ExtendedContext.minus(1)
4814 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004815 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004816 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004817 return a.__neg__(context=self)
4818
4819 def multiply(self, a, b):
4820 """multiply multiplies two operands.
4821
4822 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004823 Otherwise, the operands are multiplied together
4824 ('long multiplication'), resulting in a number which may be as long as
4825 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004826
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004827 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004828 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004829 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004830 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004831 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004832 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004833 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004834 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004835 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004836 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004837 >>> ExtendedContext.multiply(7, 7)
4838 Decimal('49')
4839 >>> ExtendedContext.multiply(Decimal(7), 7)
4840 Decimal('49')
4841 >>> ExtendedContext.multiply(7, Decimal(7))
4842 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004843 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004844 a = _convert_other(a, raiseit=True)
4845 r = a.__mul__(b, context=self)
4846 if r is NotImplemented:
4847 raise TypeError("Unable to convert %s to Decimal" % b)
4848 else:
4849 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004850
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004851 def next_minus(self, a):
4852 """Returns the largest representable number smaller than a.
4853
4854 >>> c = ExtendedContext.copy()
4855 >>> c.Emin = -999
4856 >>> c.Emax = 999
4857 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004858 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004859 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004860 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004861 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004862 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004863 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004864 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004865 >>> c.next_minus(1)
4866 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004867 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004868 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004869 return a.next_minus(context=self)
4870
4871 def next_plus(self, a):
4872 """Returns the smallest representable number larger than a.
4873
4874 >>> c = ExtendedContext.copy()
4875 >>> c.Emin = -999
4876 >>> c.Emax = 999
4877 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004878 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004879 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004880 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004881 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004882 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004883 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004884 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004885 >>> c.next_plus(1)
4886 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004887 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004888 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004889 return a.next_plus(context=self)
4890
4891 def next_toward(self, a, b):
4892 """Returns the number closest to a, in direction towards b.
4893
4894 The result is the closest representable number from the first
4895 operand (but not the first operand) that is in the direction
4896 towards the second operand, unless the operands have the same
4897 value.
4898
4899 >>> c = ExtendedContext.copy()
4900 >>> c.Emin = -999
4901 >>> c.Emax = 999
4902 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004903 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004904 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004905 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004906 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004907 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004908 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004909 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004910 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004911 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004912 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004913 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004914 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004915 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004916 >>> c.next_toward(0, 1)
4917 Decimal('1E-1007')
4918 >>> c.next_toward(Decimal(0), 1)
4919 Decimal('1E-1007')
4920 >>> c.next_toward(0, Decimal(1))
4921 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004922 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004923 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004924 return a.next_toward(b, context=self)
4925
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004926 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004927 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928
4929 Essentially a plus operation with all trailing zeros removed from the
4930 result.
4931
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004932 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004933 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004934 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004935 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004936 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004937 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004938 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004939 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004940 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004941 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004942 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004943 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004944 >>> ExtendedContext.normalize(6)
4945 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004946 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004947 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004948 return a.normalize(context=self)
4949
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004950 def number_class(self, a):
4951 """Returns an indication of the class of the operand.
4952
4953 The class is one of the following strings:
4954 -sNaN
4955 -NaN
4956 -Infinity
4957 -Normal
4958 -Subnormal
4959 -Zero
4960 +Zero
4961 +Subnormal
4962 +Normal
4963 +Infinity
4964
4965 >>> c = Context(ExtendedContext)
4966 >>> c.Emin = -999
4967 >>> c.Emax = 999
4968 >>> c.number_class(Decimal('Infinity'))
4969 '+Infinity'
4970 >>> c.number_class(Decimal('1E-10'))
4971 '+Normal'
4972 >>> c.number_class(Decimal('2.50'))
4973 '+Normal'
4974 >>> c.number_class(Decimal('0.1E-999'))
4975 '+Subnormal'
4976 >>> c.number_class(Decimal('0'))
4977 '+Zero'
4978 >>> c.number_class(Decimal('-0'))
4979 '-Zero'
4980 >>> c.number_class(Decimal('-0.1E-999'))
4981 '-Subnormal'
4982 >>> c.number_class(Decimal('-1E-10'))
4983 '-Normal'
4984 >>> c.number_class(Decimal('-2.50'))
4985 '-Normal'
4986 >>> c.number_class(Decimal('-Infinity'))
4987 '-Infinity'
4988 >>> c.number_class(Decimal('NaN'))
4989 'NaN'
4990 >>> c.number_class(Decimal('-NaN'))
4991 'NaN'
4992 >>> c.number_class(Decimal('sNaN'))
4993 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004994 >>> c.number_class(123)
4995 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004996 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004997 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004998 return a.number_class(context=self)
4999
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005000 def plus(self, a):
5001 """Plus corresponds to unary prefix plus in Python.
5002
5003 The operation is evaluated using the same rules as add; the
5004 operation plus(a) is calculated as add('0', a) where the '0'
5005 has the same exponent as the operand.
5006
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005007 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005008 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005009 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005010 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005011 >>> ExtendedContext.plus(-1)
5012 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005013 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005014 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005015 return a.__pos__(context=self)
5016
5017 def power(self, a, b, modulo=None):
5018 """Raises a to the power of b, to modulo if given.
5019
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005020 With two arguments, compute a**b. If a is negative then b
5021 must be integral. The result will be inexact unless b is
5022 integral and the result is finite and can be expressed exactly
5023 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005024
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005025 With three arguments, compute (a**b) % modulo. For the
5026 three argument form, the following restrictions on the
5027 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005028
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005029 - all three arguments must be integral
5030 - b must be nonnegative
5031 - at least one of a or b must be nonzero
5032 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005033
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005034 The result of pow(a, b, modulo) is identical to the result
5035 that would be obtained by computing (a**b) % modulo with
5036 unbounded precision, but is computed more efficiently. It is
5037 always exact.
5038
5039 >>> c = ExtendedContext.copy()
5040 >>> c.Emin = -999
5041 >>> c.Emax = 999
5042 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005043 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005044 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005045 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005046 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005047 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005048 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005049 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005050 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005051 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005052 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005053 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005054 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005055 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005056 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005057 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005058 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005059 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005060 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005061 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005062 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005063 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005064 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005065 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005066 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005067 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005068
5069 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005070 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005071 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005072 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005073 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005074 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005075 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005076 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005077 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005078 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005079 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005080 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005081 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005082 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005083 >>> ExtendedContext.power(7, 7)
5084 Decimal('823543')
5085 >>> ExtendedContext.power(Decimal(7), 7)
5086 Decimal('823543')
5087 >>> ExtendedContext.power(7, Decimal(7), 2)
5088 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005089 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005090 a = _convert_other(a, raiseit=True)
5091 r = a.__pow__(b, modulo, context=self)
5092 if r is NotImplemented:
5093 raise TypeError("Unable to convert %s to Decimal" % b)
5094 else:
5095 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005096
5097 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005098 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005099
5100 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005101 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005102 exponent is being increased), multiplied by a positive power of ten (if
5103 the exponent is being decreased), or is unchanged (if the exponent is
5104 already equal to that of the right-hand operand).
5105
5106 Unlike other operations, if the length of the coefficient after the
5107 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005108 operation condition is raised. This guarantees that, unless there is
5109 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005110 equal to that of the right-hand operand.
5111
5112 Also unlike other operations, quantize will never raise Underflow, even
5113 if the result is subnormal and inexact.
5114
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005115 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005116 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005117 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005118 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005119 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005120 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005121 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005122 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005123 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005124 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005125 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005126 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005127 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005128 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005129 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005130 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005131 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005132 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005133 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005134 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005135 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005136 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005137 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005138 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005139 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005140 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005141 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005142 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005143 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005144 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005145 >>> ExtendedContext.quantize(1, 2)
5146 Decimal('1')
5147 >>> ExtendedContext.quantize(Decimal(1), 2)
5148 Decimal('1')
5149 >>> ExtendedContext.quantize(1, Decimal(2))
5150 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005151 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005152 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005153 return a.quantize(b, context=self)
5154
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005155 def radix(self):
5156 """Just returns 10, as this is Decimal, :)
5157
5158 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005159 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005160 """
5161 return Decimal(10)
5162
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005163 def remainder(self, a, b):
5164 """Returns the remainder from integer division.
5165
5166 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005167 calculating integer division as described for divide-integer, rounded
5168 to precision digits if necessary. The sign of the result, if
5169 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005170
5171 This operation will fail under the same conditions as integer division
5172 (that is, if integer division on the same two operands would fail, the
5173 remainder cannot be calculated).
5174
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005175 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005176 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005177 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005178 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005179 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005180 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005181 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005182 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005183 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005184 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005185 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005186 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005187 >>> ExtendedContext.remainder(22, 6)
5188 Decimal('4')
5189 >>> ExtendedContext.remainder(Decimal(22), 6)
5190 Decimal('4')
5191 >>> ExtendedContext.remainder(22, Decimal(6))
5192 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005193 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005194 a = _convert_other(a, raiseit=True)
5195 r = a.__mod__(b, context=self)
5196 if r is NotImplemented:
5197 raise TypeError("Unable to convert %s to Decimal" % b)
5198 else:
5199 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005200
5201 def remainder_near(self, a, b):
5202 """Returns to be "a - b * n", where n is the integer nearest the exact
5203 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005204 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005205 sign of a.
5206
5207 This operation will fail under the same conditions as integer division
5208 (that is, if integer division on the same two operands would fail, the
5209 remainder cannot be calculated).
5210
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005211 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005212 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005213 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005214 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005215 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005216 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005217 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005218 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005219 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005220 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005221 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005222 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005223 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005224 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005225 >>> ExtendedContext.remainder_near(3, 11)
5226 Decimal('3')
5227 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5228 Decimal('3')
5229 >>> ExtendedContext.remainder_near(3, Decimal(11))
5230 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005231 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005232 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005233 return a.remainder_near(b, context=self)
5234
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005235 def rotate(self, a, b):
5236 """Returns a rotated copy of a, b times.
5237
5238 The coefficient of the result is a rotated copy of the digits in
5239 the coefficient of the first operand. The number of places of
5240 rotation is taken from the absolute value of the second operand,
5241 with the rotation being to the left if the second operand is
5242 positive or to the right otherwise.
5243
5244 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005245 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005246 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005247 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005248 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005249 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005250 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005251 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005252 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005253 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005254 >>> ExtendedContext.rotate(1333333, 1)
5255 Decimal('13333330')
5256 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5257 Decimal('13333330')
5258 >>> ExtendedContext.rotate(1333333, Decimal(1))
5259 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005260 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005261 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005262 return a.rotate(b, context=self)
5263
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005264 def same_quantum(self, a, b):
5265 """Returns True if the two operands have the same exponent.
5266
5267 The result is never affected by either the sign or the coefficient of
5268 either operand.
5269
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005270 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005271 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005272 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005273 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005274 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005275 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005276 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005277 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005278 >>> ExtendedContext.same_quantum(10000, -1)
5279 True
5280 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5281 True
5282 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5283 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005284 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005285 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005286 return a.same_quantum(b)
5287
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005288 def scaleb (self, a, b):
5289 """Returns the first operand after adding the second value its exp.
5290
5291 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005292 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005293 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005294 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005295 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005296 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005297 >>> ExtendedContext.scaleb(1, 4)
5298 Decimal('1E+4')
5299 >>> ExtendedContext.scaleb(Decimal(1), 4)
5300 Decimal('1E+4')
5301 >>> ExtendedContext.scaleb(1, Decimal(4))
5302 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005303 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005304 a = _convert_other(a, raiseit=True)
5305 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005306
5307 def shift(self, a, b):
5308 """Returns a shifted copy of a, b times.
5309
5310 The coefficient of the result is a shifted copy of the digits
5311 in the coefficient of the first operand. The number of places
5312 to shift is taken from the absolute value of the second operand,
5313 with the shift being to the left if the second operand is
5314 positive or to the right otherwise. Digits shifted into the
5315 coefficient are zeros.
5316
5317 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005318 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005319 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005320 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005321 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005322 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005323 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005324 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005325 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005326 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005327 >>> ExtendedContext.shift(88888888, 2)
5328 Decimal('888888800')
5329 >>> ExtendedContext.shift(Decimal(88888888), 2)
5330 Decimal('888888800')
5331 >>> ExtendedContext.shift(88888888, Decimal(2))
5332 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005333 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005334 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005335 return a.shift(b, context=self)
5336
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005337 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005338 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005339
5340 If the result must be inexact, it is rounded using the round-half-even
5341 algorithm.
5342
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005343 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005344 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005345 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005346 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005347 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005348 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005349 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005350 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005351 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005352 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005353 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005354 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005355 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005356 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005357 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005358 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005359 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005360 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005361 >>> ExtendedContext.sqrt(2)
5362 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005363 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005364 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005365 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005366 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005367 return a.sqrt(context=self)
5368
5369 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005370 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005371
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005372 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005373 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005374 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005375 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005376 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005377 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005378 >>> ExtendedContext.subtract(8, 5)
5379 Decimal('3')
5380 >>> ExtendedContext.subtract(Decimal(8), 5)
5381 Decimal('3')
5382 >>> ExtendedContext.subtract(8, Decimal(5))
5383 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005384 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005385 a = _convert_other(a, raiseit=True)
5386 r = a.__sub__(b, context=self)
5387 if r is NotImplemented:
5388 raise TypeError("Unable to convert %s to Decimal" % b)
5389 else:
5390 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005391
5392 def to_eng_string(self, a):
5393 """Converts a number to a string, using scientific notation.
5394
5395 The operation is not affected by the context.
5396 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005397 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005398 return a.to_eng_string(context=self)
5399
5400 def to_sci_string(self, a):
5401 """Converts a number to a string, using scientific notation.
5402
5403 The operation is not affected by the context.
5404 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005405 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005406 return a.__str__(context=self)
5407
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005408 def to_integral_exact(self, a):
5409 """Rounds to an integer.
5410
5411 When the operand has a negative exponent, the result is the same
5412 as using the quantize() operation using the given operand as the
5413 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5414 of the operand as the precision setting; Inexact and Rounded flags
5415 are allowed in this operation. The rounding mode is taken from the
5416 context.
5417
5418 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005419 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005420 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005421 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005422 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005423 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005424 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005425 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005426 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005427 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005428 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005429 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005430 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005431 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005432 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005433 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005434 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005435 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005436 return a.to_integral_exact(context=self)
5437
5438 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005439 """Rounds to an integer.
5440
5441 When the operand has a negative exponent, the result is the same
5442 as using the quantize() operation using the given operand as the
5443 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5444 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005445 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005446
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005447 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005448 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005449 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005450 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005451 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005452 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005453 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005454 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005455 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005456 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005457 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005458 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005459 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005460 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005461 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005462 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005463 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005464 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005465 return a.to_integral_value(context=self)
5466
5467 # the method name changed, but we provide also the old one, for compatibility
5468 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005469
5470class _WorkRep(object):
5471 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005472 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005473 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005474 # exp: None, int, or string
5475
5476 def __init__(self, value=None):
5477 if value is None:
5478 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005479 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005480 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005481 elif isinstance(value, Decimal):
5482 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005483 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005484 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005485 else:
5486 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005487 self.sign = value[0]
5488 self.int = value[1]
5489 self.exp = value[2]
5490
5491 def __repr__(self):
5492 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5493
5494 __str__ = __repr__
5495
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005496
5497
Christian Heimes2c181612007-12-17 20:04:13 +00005498def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005499 """Normalizes op1, op2 to have the same exp and length of coefficient.
5500
5501 Done during addition.
5502 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005503 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005504 tmp = op2
5505 other = op1
5506 else:
5507 tmp = op1
5508 other = op2
5509
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005510 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5511 # Then adding 10**exp to tmp has the same effect (after rounding)
5512 # as adding any positive quantity smaller than 10**exp; similarly
5513 # for subtraction. So if other is smaller than 10**exp we replace
5514 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005515 tmp_len = len(str(tmp.int))
5516 other_len = len(str(other.int))
5517 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5518 if other_len + other.exp - 1 < exp:
5519 other.int = 1
5520 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005522 tmp.int *= 10 ** (tmp.exp - other.exp)
5523 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005524 return op1, op2
5525
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005526##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005527
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005528# This function from Tim Peters was taken from here:
5529# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5530# The correction being in the function definition is for speed, and
5531# the whole function is not resolved with math.log because of avoiding
5532# the use of floats.
5533def _nbits(n, correction = {
5534 '0': 4, '1': 3, '2': 2, '3': 2,
5535 '4': 1, '5': 1, '6': 1, '7': 1,
5536 '8': 0, '9': 0, 'a': 0, 'b': 0,
5537 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5538 """Number of bits in binary representation of the positive integer n,
5539 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005540 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005541 if n < 0:
5542 raise ValueError("The argument to _nbits should be nonnegative.")
5543 hex_n = "%x" % n
5544 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005545
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005546def _sqrt_nearest(n, a):
5547 """Closest integer to the square root of the positive integer n. a is
5548 an initial approximation to the square root. Any positive integer
5549 will do for a, but the closer a is to the square root of n the
5550 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005551
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005552 """
5553 if n <= 0 or a <= 0:
5554 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5555
5556 b=0
5557 while a != b:
5558 b, a = a, a--n//a>>1
5559 return a
5560
5561def _rshift_nearest(x, shift):
5562 """Given an integer x and a nonnegative integer shift, return closest
5563 integer to x / 2**shift; use round-to-even in case of a tie.
5564
5565 """
5566 b, q = 1 << shift, x >> shift
5567 return q + (2*(x & (b-1)) + (q&1) > b)
5568
5569def _div_nearest(a, b):
5570 """Closest integer to a/b, a and b positive integers; rounds to even
5571 in the case of a tie.
5572
5573 """
5574 q, r = divmod(a, b)
5575 return q + (2*r + (q&1) > b)
5576
5577def _ilog(x, M, L = 8):
5578 """Integer approximation to M*log(x/M), with absolute error boundable
5579 in terms only of x/M.
5580
5581 Given positive integers x and M, return an integer approximation to
5582 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5583 between the approximation and the exact result is at most 22. For
5584 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5585 both cases these are upper bounds on the error; it will usually be
5586 much smaller."""
5587
5588 # The basic algorithm is the following: let log1p be the function
5589 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5590 # the reduction
5591 #
5592 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5593 #
5594 # repeatedly until the argument to log1p is small (< 2**-L in
5595 # absolute value). For small y we can use the Taylor series
5596 # expansion
5597 #
5598 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5599 #
5600 # truncating at T such that y**T is small enough. The whole
5601 # computation is carried out in a form of fixed-point arithmetic,
5602 # with a real number z being represented by an integer
5603 # approximation to z*M. To avoid loss of precision, the y below
5604 # is actually an integer approximation to 2**R*y*M, where R is the
5605 # number of reductions performed so far.
5606
5607 y = x-M
5608 # argument reduction; R = number of reductions performed
5609 R = 0
5610 while (R <= L and abs(y) << L-R >= M or
5611 R > L and abs(y) >> R-L >= M):
5612 y = _div_nearest((M*y) << 1,
5613 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5614 R += 1
5615
5616 # Taylor series with T terms
5617 T = -int(-10*len(str(M))//(3*L))
5618 yshift = _rshift_nearest(y, R)
5619 w = _div_nearest(M, T)
5620 for k in range(T-1, 0, -1):
5621 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5622
5623 return _div_nearest(w*y, M)
5624
5625def _dlog10(c, e, p):
5626 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5627 approximation to 10**p * log10(c*10**e), with an absolute error of
5628 at most 1. Assumes that c*10**e is not exactly 1."""
5629
5630 # increase precision by 2; compensate for this by dividing
5631 # final result by 100
5632 p += 2
5633
5634 # write c*10**e as d*10**f with either:
5635 # f >= 0 and 1 <= d <= 10, or
5636 # f <= 0 and 0.1 <= d <= 1.
5637 # Thus for c*10**e close to 1, f = 0
5638 l = len(str(c))
5639 f = e+l - (e+l >= 1)
5640
5641 if p > 0:
5642 M = 10**p
5643 k = e+p-f
5644 if k >= 0:
5645 c *= 10**k
5646 else:
5647 c = _div_nearest(c, 10**-k)
5648
5649 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005650 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005651 log_d = _div_nearest(log_d*M, log_10)
5652 log_tenpower = f*M # exact
5653 else:
5654 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005655 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005656
5657 return _div_nearest(log_tenpower+log_d, 100)
5658
5659def _dlog(c, e, p):
5660 """Given integers c, e and p with c > 0, compute an integer
5661 approximation to 10**p * log(c*10**e), with an absolute error of
5662 at most 1. Assumes that c*10**e is not exactly 1."""
5663
5664 # Increase precision by 2. The precision increase is compensated
5665 # for at the end with a division by 100.
5666 p += 2
5667
5668 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5669 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5670 # as 10**p * log(d) + 10**p*f * log(10).
5671 l = len(str(c))
5672 f = e+l - (e+l >= 1)
5673
5674 # compute approximation to 10**p*log(d), with error < 27
5675 if p > 0:
5676 k = e+p-f
5677 if k >= 0:
5678 c *= 10**k
5679 else:
5680 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5681
5682 # _ilog magnifies existing error in c by a factor of at most 10
5683 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5684 else:
5685 # p <= 0: just approximate the whole thing by 0; error < 2.31
5686 log_d = 0
5687
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005688 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005689 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005690 extra = len(str(abs(f)))-1
5691 if p + extra >= 0:
5692 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5693 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5694 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005695 else:
5696 f_log_ten = 0
5697 else:
5698 f_log_ten = 0
5699
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005700 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005701 return _div_nearest(f_log_ten + log_d, 100)
5702
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005703class _Log10Memoize(object):
5704 """Class to compute, store, and allow retrieval of, digits of the
5705 constant log(10) = 2.302585.... This constant is needed by
5706 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5707 def __init__(self):
5708 self.digits = "23025850929940456840179914546843642076011014886"
5709
5710 def getdigits(self, p):
5711 """Given an integer p >= 0, return floor(10**p)*log(10).
5712
5713 For example, self.getdigits(3) returns 2302.
5714 """
5715 # digits are stored as a string, for quick conversion to
5716 # integer in the case that we've already computed enough
5717 # digits; the stored digits should always be correct
5718 # (truncated, not rounded to nearest).
5719 if p < 0:
5720 raise ValueError("p should be nonnegative")
5721
5722 if p >= len(self.digits):
5723 # compute p+3, p+6, p+9, ... digits; continue until at
5724 # least one of the extra digits is nonzero
5725 extra = 3
5726 while True:
5727 # compute p+extra digits, correct to within 1ulp
5728 M = 10**(p+extra+2)
5729 digits = str(_div_nearest(_ilog(10*M, M), 100))
5730 if digits[-extra:] != '0'*extra:
5731 break
5732 extra += 3
5733 # keep all reliable digits so far; remove trailing zeros
5734 # and next nonzero digit
5735 self.digits = digits.rstrip('0')[:-1]
5736 return int(self.digits[:p+1])
5737
5738_log10_digits = _Log10Memoize().getdigits
5739
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005740def _iexp(x, M, L=8):
5741 """Given integers x and M, M > 0, such that x/M is small in absolute
5742 value, compute an integer approximation to M*exp(x/M). For 0 <=
5743 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5744 is usually much smaller)."""
5745
5746 # Algorithm: to compute exp(z) for a real number z, first divide z
5747 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5748 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5749 # series
5750 #
5751 # expm1(x) = x + x**2/2! + x**3/3! + ...
5752 #
5753 # Now use the identity
5754 #
5755 # expm1(2x) = expm1(x)*(expm1(x)+2)
5756 #
5757 # R times to compute the sequence expm1(z/2**R),
5758 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5759
5760 # Find R such that x/2**R/M <= 2**-L
5761 R = _nbits((x<<L)//M)
5762
5763 # Taylor series. (2**L)**T > M
5764 T = -int(-10*len(str(M))//(3*L))
5765 y = _div_nearest(x, T)
5766 Mshift = M<<R
5767 for i in range(T-1, 0, -1):
5768 y = _div_nearest(x*(Mshift + y), Mshift * i)
5769
5770 # Expansion
5771 for k in range(R-1, -1, -1):
5772 Mshift = M<<(k+2)
5773 y = _div_nearest(y*(y+Mshift), Mshift)
5774
5775 return M+y
5776
5777def _dexp(c, e, p):
5778 """Compute an approximation to exp(c*10**e), with p decimal places of
5779 precision.
5780
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005781 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005782
5783 10**(p-1) <= d <= 10**p, and
5784 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5785
5786 In other words, d*10**f is an approximation to exp(c*10**e) with p
5787 digits of precision, and with an error in d of at most 1. This is
5788 almost, but not quite, the same as the error being < 1ulp: when d
5789 = 10**(p-1) the error could be up to 10 ulp."""
5790
5791 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5792 p += 2
5793
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005794 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005795 extra = max(0, e + len(str(c)) - 1)
5796 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005797
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005798 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005799 # rounding down
5800 shift = e+q
5801 if shift >= 0:
5802 cshift = c*10**shift
5803 else:
5804 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005805 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005806
5807 # reduce remainder back to original precision
5808 rem = _div_nearest(rem, 10**extra)
5809
5810 # error in result of _iexp < 120; error after division < 0.62
5811 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5812
5813def _dpower(xc, xe, yc, ye, p):
5814 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5815 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5816
5817 10**(p-1) <= c <= 10**p, and
5818 (c-1)*10**e < x**y < (c+1)*10**e
5819
5820 in other words, c*10**e is an approximation to x**y with p digits
5821 of precision, and with an error in c of at most 1. (This is
5822 almost, but not quite, the same as the error being < 1ulp: when c
5823 == 10**(p-1) we can only guarantee error < 10ulp.)
5824
5825 We assume that: x is positive and not equal to 1, and y is nonzero.
5826 """
5827
5828 # Find b such that 10**(b-1) <= |y| <= 10**b
5829 b = len(str(abs(yc))) + ye
5830
5831 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5832 lxc = _dlog(xc, xe, p+b+1)
5833
5834 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5835 shift = ye-b
5836 if shift >= 0:
5837 pc = lxc*yc*10**shift
5838 else:
5839 pc = _div_nearest(lxc*yc, 10**-shift)
5840
5841 if pc == 0:
5842 # we prefer a result that isn't exactly 1; this makes it
5843 # easier to compute a correctly rounded result in __pow__
5844 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5845 coeff, exp = 10**(p-1)+1, 1-p
5846 else:
5847 coeff, exp = 10**p-1, -p
5848 else:
5849 coeff, exp = _dexp(pc, -(p+1), p+1)
5850 coeff = _div_nearest(coeff, 10)
5851 exp += 1
5852
5853 return coeff, exp
5854
5855def _log10_lb(c, correction = {
5856 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5857 '6': 23, '7': 16, '8': 10, '9': 5}):
5858 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5859 if c <= 0:
5860 raise ValueError("The argument to _log10_lb should be nonnegative.")
5861 str_c = str(c)
5862 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005863
Guido van Rossumd8faa362007-04-27 19:54:29 +00005864##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005865
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005866def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005867 """Convert other to Decimal.
5868
5869 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005870 If allow_float is true, allow conversion from float; this
5871 is used in the comparison methods (__eq__ and friends).
5872
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005873 """
5874 if isinstance(other, Decimal):
5875 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005876 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005877 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005878 if allow_float and isinstance(other, float):
5879 return Decimal.from_float(other)
5880
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005881 if raiseit:
5882 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005883 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005884
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005885def _convert_for_comparison(self, other, equality_op=False):
5886 """Given a Decimal instance self and a Python object other, return
Mark Dickinson1c164a62010-06-11 16:49:20 +00005887 a pair (s, o) of Decimal instances such that "s op o" is
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005888 equivalent to "self op other" for any of the 6 comparison
5889 operators "op".
5890
5891 """
5892 if isinstance(other, Decimal):
5893 return self, other
5894
5895 # Comparison with a Rational instance (also includes integers):
5896 # self op n/d <=> self*d op n (for n and d integers, d positive).
5897 # A NaN or infinity can be left unchanged without affecting the
5898 # comparison result.
5899 if isinstance(other, _numbers.Rational):
5900 if not self._is_special:
5901 self = _dec_from_triple(self._sign,
5902 str(int(self._int) * other.denominator),
5903 self._exp)
5904 return self, Decimal(other.numerator)
5905
5906 # Comparisons with float and complex types. == and != comparisons
5907 # with complex numbers should succeed, returning either True or False
5908 # as appropriate. Other comparisons return NotImplemented.
5909 if equality_op and isinstance(other, _numbers.Complex) and other.imag == 0:
5910 other = other.real
5911 if isinstance(other, float):
5912 return self, Decimal.from_float(other)
5913 return NotImplemented, NotImplemented
5914
5915
Guido van Rossumd8faa362007-04-27 19:54:29 +00005916##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005917
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005918# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005919# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005920
5921DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005922 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005923 traps=[DivisionByZero, Overflow, InvalidOperation],
5924 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005925 Emax=999999999,
5926 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005927 capitals=1,
5928 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005929)
5930
5931# Pre-made alternate contexts offered by the specification
5932# Don't change these; the user should be able to select these
5933# contexts and be able to reproduce results from other implementations
5934# of the spec.
5935
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005936BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005937 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005938 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5939 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005940)
5941
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005942ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005943 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005944 traps=[],
5945 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005946)
5947
5948
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005949##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005950#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005951# Regular expression used for parsing numeric strings. Additional
5952# comments:
5953#
5954# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5955# whitespace. But note that the specification disallows whitespace in
5956# a numeric string.
5957#
5958# 2. For finite numbers (not infinities and NaNs) the body of the
5959# number between the optional sign and the optional exponent must have
5960# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005961# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005962
5963import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005964_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005965# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005966 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005967 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005968 (?=\d|\.\d) # ...a number (with at least one digit)
5969 (?P<int>\d*) # having a (possibly empty) integer part
5970 (\.(?P<frac>\d*))? # followed by an optional fractional part
5971 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005972 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005973 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005974 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005975 (?P<signal>s)? # ...an (optionally signaling)
5976 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005977 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005978 )
5979# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005980 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005981""", re.VERBOSE | re.IGNORECASE).match
5982
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005983_all_zeros = re.compile('0*$').match
5984_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005985
5986##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005987# The functions in this section have little to do with the Decimal
5988# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005989# Python numeric classes that want to implement __format__
5990#
5991# A format specifier for Decimal looks like:
5992#
Mark Dickinson79f52032009-03-17 23:12:51 +00005993# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005994
5995_parse_format_specifier_regex = re.compile(r"""\A
5996(?:
5997 (?P<fill>.)?
5998 (?P<align>[<>=^])
5999)?
6000(?P<sign>[-+ ])?
6001(?P<zeropad>0)?
6002(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00006003(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00006004(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00006005(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00006006\Z
6007""", re.VERBOSE)
6008
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006009del re
6010
Mark Dickinson79f52032009-03-17 23:12:51 +00006011# The locale module is only needed for the 'n' format specifier. The
6012# rest of the PEP 3101 code functions quite happily without it, so we
6013# don't care too much if locale isn't present.
6014try:
6015 import locale as _locale
6016except ImportError:
6017 pass
6018
6019def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00006020 """Parse and validate a format specifier.
6021
6022 Turns a standard numeric format specifier into a dict, with the
6023 following entries:
6024
6025 fill: fill character to pad field to minimum width
6026 align: alignment type, either '<', '>', '=' or '^'
6027 sign: either '+', '-' or ' '
6028 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006029 zeropad: boolean, indicating whether to pad with zeros
6030 thousands_sep: string to use as thousands separator, or ''
6031 grouping: grouping for thousands separators, in format
6032 used by localeconv
6033 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006034 precision: nonnegative integer giving precision, or None
6035 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006036
6037 """
6038 m = _parse_format_specifier_regex.match(format_spec)
6039 if m is None:
6040 raise ValueError("Invalid format specifier: " + format_spec)
6041
6042 # get the dictionary
6043 format_dict = m.groupdict()
6044
Mark Dickinson79f52032009-03-17 23:12:51 +00006045 # zeropad; defaults for fill and alignment. If zero padding
6046 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006047 fill = format_dict['fill']
6048 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006049 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6050 if format_dict['zeropad']:
6051 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006052 raise ValueError("Fill character conflicts with '0'"
6053 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006054 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006055 raise ValueError("Alignment conflicts with '0' in "
6056 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006057 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006058 # PEP 3101 originally specified that the default alignment should
6059 # be left; it was later agreed that right-aligned makes more sense
6060 # for numeric types. See http://bugs.python.org/issue6857.
6061 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006062
Mark Dickinson79f52032009-03-17 23:12:51 +00006063 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006064 if format_dict['sign'] is None:
6065 format_dict['sign'] = '-'
6066
Christian Heimesf16baeb2008-02-29 14:57:44 +00006067 # minimumwidth defaults to 0; precision remains None if not given
6068 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6069 if format_dict['precision'] is not None:
6070 format_dict['precision'] = int(format_dict['precision'])
6071
6072 # if format type is 'g' or 'G' then a precision of 0 makes little
6073 # sense; convert it to 1. Same if format type is unspecified.
6074 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006075 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006076 format_dict['precision'] = 1
6077
Mark Dickinson79f52032009-03-17 23:12:51 +00006078 # determine thousands separator, grouping, and decimal separator, and
6079 # add appropriate entries to format_dict
6080 if format_dict['type'] == 'n':
6081 # apart from separators, 'n' behaves just like 'g'
6082 format_dict['type'] = 'g'
6083 if _localeconv is None:
6084 _localeconv = _locale.localeconv()
6085 if format_dict['thousands_sep'] is not None:
6086 raise ValueError("Explicit thousands separator conflicts with "
6087 "'n' type in format specifier: " + format_spec)
6088 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6089 format_dict['grouping'] = _localeconv['grouping']
6090 format_dict['decimal_point'] = _localeconv['decimal_point']
6091 else:
6092 if format_dict['thousands_sep'] is None:
6093 format_dict['thousands_sep'] = ''
6094 format_dict['grouping'] = [3, 0]
6095 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006096
6097 return format_dict
6098
Mark Dickinson79f52032009-03-17 23:12:51 +00006099def _format_align(sign, body, spec):
6100 """Given an unpadded, non-aligned numeric string 'body' and sign
6101 string 'sign', add padding and aligment conforming to the given
6102 format specifier dictionary 'spec' (as produced by
6103 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006104
6105 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006106 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006107 minimumwidth = spec['minimumwidth']
6108 fill = spec['fill']
6109 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006110
Mark Dickinson79f52032009-03-17 23:12:51 +00006111 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006112 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006113 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006114 elif align == '>':
6115 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006116 elif align == '=':
6117 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006118 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006119 half = len(padding)//2
6120 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006121 else:
6122 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006123
Christian Heimesf16baeb2008-02-29 14:57:44 +00006124 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006125
Mark Dickinson79f52032009-03-17 23:12:51 +00006126def _group_lengths(grouping):
6127 """Convert a localeconv-style grouping into a (possibly infinite)
6128 iterable of integers representing group lengths.
6129
6130 """
6131 # The result from localeconv()['grouping'], and the input to this
6132 # function, should be a list of integers in one of the
6133 # following three forms:
6134 #
6135 # (1) an empty list, or
6136 # (2) nonempty list of positive integers + [0]
6137 # (3) list of positive integers + [locale.CHAR_MAX], or
6138
6139 from itertools import chain, repeat
6140 if not grouping:
6141 return []
6142 elif grouping[-1] == 0 and len(grouping) >= 2:
6143 return chain(grouping[:-1], repeat(grouping[-2]))
6144 elif grouping[-1] == _locale.CHAR_MAX:
6145 return grouping[:-1]
6146 else:
6147 raise ValueError('unrecognised format for grouping')
6148
6149def _insert_thousands_sep(digits, spec, min_width=1):
6150 """Insert thousands separators into a digit string.
6151
6152 spec is a dictionary whose keys should include 'thousands_sep' and
6153 'grouping'; typically it's the result of parsing the format
6154 specifier using _parse_format_specifier.
6155
6156 The min_width keyword argument gives the minimum length of the
6157 result, which will be padded on the left with zeros if necessary.
6158
6159 If necessary, the zero padding adds an extra '0' on the left to
6160 avoid a leading thousands separator. For example, inserting
6161 commas every three digits in '123456', with min_width=8, gives
6162 '0,123,456', even though that has length 9.
6163
6164 """
6165
6166 sep = spec['thousands_sep']
6167 grouping = spec['grouping']
6168
6169 groups = []
6170 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006171 if l <= 0:
6172 raise ValueError("group length should be positive")
6173 # max(..., 1) forces at least 1 digit to the left of a separator
6174 l = min(max(len(digits), min_width, 1), l)
6175 groups.append('0'*(l - len(digits)) + digits[-l:])
6176 digits = digits[:-l]
6177 min_width -= l
6178 if not digits and min_width <= 0:
6179 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006180 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006181 else:
6182 l = max(len(digits), min_width, 1)
6183 groups.append('0'*(l - len(digits)) + digits[-l:])
6184 return sep.join(reversed(groups))
6185
6186def _format_sign(is_negative, spec):
6187 """Determine sign character."""
6188
6189 if is_negative:
6190 return '-'
6191 elif spec['sign'] in ' +':
6192 return spec['sign']
6193 else:
6194 return ''
6195
6196def _format_number(is_negative, intpart, fracpart, exp, spec):
6197 """Format a number, given the following data:
6198
6199 is_negative: true if the number is negative, else false
6200 intpart: string of digits that must appear before the decimal point
6201 fracpart: string of digits that must come after the point
6202 exp: exponent, as an integer
6203 spec: dictionary resulting from parsing the format specifier
6204
6205 This function uses the information in spec to:
6206 insert separators (decimal separator and thousands separators)
6207 format the sign
6208 format the exponent
6209 add trailing '%' for the '%' type
6210 zero-pad if necessary
6211 fill and align if necessary
6212 """
6213
6214 sign = _format_sign(is_negative, spec)
6215
6216 if fracpart:
6217 fracpart = spec['decimal_point'] + fracpart
6218
6219 if exp != 0 or spec['type'] in 'eE':
6220 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6221 fracpart += "{0}{1:+}".format(echar, exp)
6222 if spec['type'] == '%':
6223 fracpart += '%'
6224
6225 if spec['zeropad']:
6226 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6227 else:
6228 min_width = 0
6229 intpart = _insert_thousands_sep(intpart, spec, min_width)
6230
6231 return _format_align(sign, intpart+fracpart, spec)
6232
6233
Guido van Rossumd8faa362007-04-27 19:54:29 +00006234##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006235
Guido van Rossumd8faa362007-04-27 19:54:29 +00006236# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006237_Infinity = Decimal('Inf')
6238_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006239_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006240_Zero = Decimal(0)
6241_One = Decimal(1)
6242_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006243
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006244# _SignedInfinity[sign] is infinity w/ that sign
6245_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006246
Mark Dickinsondc787d22010-05-23 13:33:13 +00006247# Constants related to the hash implementation; hash(x) is based
6248# on the reduction of x modulo _PyHASH_MODULUS
6249import sys
6250_PyHASH_MODULUS = sys.hash_info.modulus
6251# hash values to use for positive and negative infinities, and nans
6252_PyHASH_INF = sys.hash_info.inf
6253_PyHASH_NAN = sys.hash_info.nan
6254del sys
6255
6256# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6257_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006258
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006259
6260if __name__ == '__main__':
6261 import doctest, sys
6262 doctest.testmod(sys.modules[__name__])