blob: 828027cd6150e693fc4552d790d8e6ad89819ac8 [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:
2050 if ye >= 0:
2051 exponent = xe*yc*10**ye
2052 else:
2053 exponent, remainder = divmod(xe*yc, 10**-ye)
2054 if remainder:
2055 return None
2056 if y.sign == 1:
2057 exponent = -exponent
2058 # if other is a nonnegative integer, use ideal exponent
2059 if other._isinteger() and other._sign == 0:
2060 ideal_exponent = self._exp*int(other)
2061 zeros = min(exponent-ideal_exponent, p-1)
2062 else:
2063 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002064 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002065
2066 # case where y is negative: xc must be either a power
2067 # of 2 or a power of 5.
2068 if y.sign == 1:
2069 last_digit = xc % 10
2070 if last_digit in (2,4,6,8):
2071 # quick test for power of 2
2072 if xc & -xc != xc:
2073 return None
2074 # now xc is a power of 2; e is its exponent
2075 e = _nbits(xc)-1
2076 # find e*y and xe*y; both must be integers
2077 if ye >= 0:
2078 y_as_int = yc*10**ye
2079 e = e*y_as_int
2080 xe = xe*y_as_int
2081 else:
2082 ten_pow = 10**-ye
2083 e, remainder = divmod(e*yc, ten_pow)
2084 if remainder:
2085 return None
2086 xe, remainder = divmod(xe*yc, ten_pow)
2087 if remainder:
2088 return None
2089
2090 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2091 return None
2092 xc = 5**e
2093
2094 elif last_digit == 5:
2095 # e >= log_5(xc) if xc is a power of 5; we have
2096 # equality all the way up to xc=5**2658
2097 e = _nbits(xc)*28//65
2098 xc, remainder = divmod(5**e, xc)
2099 if remainder:
2100 return None
2101 while xc % 5 == 0:
2102 xc //= 5
2103 e -= 1
2104 if ye >= 0:
2105 y_as_integer = yc*10**ye
2106 e = e*y_as_integer
2107 xe = xe*y_as_integer
2108 else:
2109 ten_pow = 10**-ye
2110 e, remainder = divmod(e*yc, ten_pow)
2111 if remainder:
2112 return None
2113 xe, remainder = divmod(xe*yc, ten_pow)
2114 if remainder:
2115 return None
2116 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2117 return None
2118 xc = 2**e
2119 else:
2120 return None
2121
2122 if xc >= 10**p:
2123 return None
2124 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002125 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002126
2127 # now y is positive; find m and n such that y = m/n
2128 if ye >= 0:
2129 m, n = yc*10**ye, 1
2130 else:
2131 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2132 return None
2133 xc_bits = _nbits(xc)
2134 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2135 return None
2136 m, n = yc, 10**(-ye)
2137 while m % 2 == n % 2 == 0:
2138 m //= 2
2139 n //= 2
2140 while m % 5 == n % 5 == 0:
2141 m //= 5
2142 n //= 5
2143
2144 # compute nth root of xc*10**xe
2145 if n > 1:
2146 # if 1 < xc < 2**n then xc isn't an nth power
2147 if xc != 1 and xc_bits <= n:
2148 return None
2149
2150 xe, rem = divmod(xe, n)
2151 if rem != 0:
2152 return None
2153
2154 # compute nth root of xc using Newton's method
2155 a = 1 << -(-_nbits(xc)//n) # initial estimate
2156 while True:
2157 q, r = divmod(xc, a**(n-1))
2158 if a <= q:
2159 break
2160 else:
2161 a = (a*(n-1) + q)//n
2162 if not (a == q and r == 0):
2163 return None
2164 xc = a
2165
2166 # now xc*10**xe is the nth root of the original xc*10**xe
2167 # compute mth power of xc*10**xe
2168
2169 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2170 # 10**p and the result is not representable.
2171 if xc > 1 and m > p*100//_log10_lb(xc):
2172 return None
2173 xc = xc**m
2174 xe *= m
2175 if xc > 10**p:
2176 return None
2177
2178 # by this point the result *is* exactly representable
2179 # adjust the exponent to get as close as possible to the ideal
2180 # exponent, if necessary
2181 str_xc = str(xc)
2182 if other._isinteger() and other._sign == 0:
2183 ideal_exponent = self._exp*int(other)
2184 zeros = min(xe-ideal_exponent, p-len(str_xc))
2185 else:
2186 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002187 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002188
2189 def __pow__(self, other, modulo=None, context=None):
2190 """Return self ** other [ % modulo].
2191
2192 With two arguments, compute self**other.
2193
2194 With three arguments, compute (self**other) % modulo. For the
2195 three argument form, the following restrictions on the
2196 arguments hold:
2197
2198 - all three arguments must be integral
2199 - other must be nonnegative
2200 - either self or other (or both) must be nonzero
2201 - modulo must be nonzero and must have at most p digits,
2202 where p is the context precision.
2203
2204 If any of these restrictions is violated the InvalidOperation
2205 flag is raised.
2206
2207 The result of pow(self, other, modulo) is identical to the
2208 result that would be obtained by computing (self**other) %
2209 modulo with unbounded precision, but is computed more
2210 efficiently. It is always exact.
2211 """
2212
2213 if modulo is not None:
2214 return self._power_modulo(other, modulo, context)
2215
2216 other = _convert_other(other)
2217 if other is NotImplemented:
2218 return other
2219
2220 if context is None:
2221 context = getcontext()
2222
2223 # either argument is a NaN => result is NaN
2224 ans = self._check_nans(other, context)
2225 if ans:
2226 return ans
2227
2228 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2229 if not other:
2230 if not self:
2231 return context._raise_error(InvalidOperation, '0 ** 0')
2232 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002233 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002234
2235 # result has sign 1 iff self._sign is 1 and other is an odd integer
2236 result_sign = 0
2237 if self._sign == 1:
2238 if other._isinteger():
2239 if not other._iseven():
2240 result_sign = 1
2241 else:
2242 # -ve**noninteger = NaN
2243 # (-0)**noninteger = 0**noninteger
2244 if self:
2245 return context._raise_error(InvalidOperation,
2246 'x ** y with x negative and y not an integer')
2247 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002248 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002249
2250 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2251 if not self:
2252 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002253 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002254 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002255 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002256
2257 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002258 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002259 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002260 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002261 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002262 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002263
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002264 # 1**other = 1, but the choice of exponent and the flags
2265 # depend on the exponent of self, and on whether other is a
2266 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002267 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002268 if other._isinteger():
2269 # exp = max(self._exp*max(int(other), 0),
2270 # 1-context.prec) but evaluating int(other) directly
2271 # is dangerous until we know other is small (other
2272 # could be 1e999999999)
2273 if other._sign == 1:
2274 multiplier = 0
2275 elif other > context.prec:
2276 multiplier = context.prec
2277 else:
2278 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002279
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002280 exp = self._exp * multiplier
2281 if exp < 1-context.prec:
2282 exp = 1-context.prec
2283 context._raise_error(Rounded)
2284 else:
2285 context._raise_error(Inexact)
2286 context._raise_error(Rounded)
2287 exp = 1-context.prec
2288
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002289 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002290
2291 # compute adjusted exponent of self
2292 self_adj = self.adjusted()
2293
2294 # self ** infinity is infinity if self > 1, 0 if self < 1
2295 # self ** -infinity is infinity if self < 1, 0 if self > 1
2296 if other._isinfinity():
2297 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002298 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002299 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002300 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002301
2302 # from here on, the result always goes through the call
2303 # to _fix at the end of this function.
2304 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002305 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002306
2307 # crude test to catch cases of extreme overflow/underflow. If
2308 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2309 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2310 # self**other >= 10**(Emax+1), so overflow occurs. The test
2311 # for underflow is similar.
2312 bound = self._log10_exp_bound() + other.adjusted()
2313 if (self_adj >= 0) == (other._sign == 0):
2314 # self > 1 and other +ve, or self < 1 and other -ve
2315 # possibility of overflow
2316 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002317 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002318 else:
2319 # self > 1 and other -ve, or self < 1 and other +ve
2320 # possibility of underflow to 0
2321 Etiny = context.Etiny()
2322 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002323 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002324
2325 # try for an exact result with precision +1
2326 if ans is None:
2327 ans = self._power_exact(other, context.prec + 1)
2328 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002329 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002330 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002331
2332 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2333 if ans is None:
2334 p = context.prec
2335 x = _WorkRep(self)
2336 xc, xe = x.int, x.exp
2337 y = _WorkRep(other)
2338 yc, ye = y.int, y.exp
2339 if y.sign == 1:
2340 yc = -yc
2341
2342 # compute correctly rounded result: start with precision +3,
2343 # then increase precision until result is unambiguously roundable
2344 extra = 3
2345 while True:
2346 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2347 if coeff % (5*10**(len(str(coeff))-p-1)):
2348 break
2349 extra += 3
2350
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002351 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002352
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002353 # unlike exp, ln and log10, the power function respects the
2354 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2355
2356 # There's a difficulty here when 'other' is not an integer and
2357 # the result is exact. In this case, the specification
2358 # requires that the Inexact flag be raised (in spite of
2359 # exactness), but since the result is exact _fix won't do this
2360 # for us. (Correspondingly, the Underflow signal should also
2361 # be raised for subnormal results.) We can't directly raise
2362 # these signals either before or after calling _fix, since
2363 # that would violate the precedence for signals. So we wrap
2364 # the ._fix call in a temporary context, and reraise
2365 # afterwards.
2366 if exact and not other._isinteger():
2367 # pad with zeros up to length context.prec+1 if necessary; this
2368 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002369 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002370 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002371 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2372 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002373
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002374 # create a copy of the current context, with cleared flags/traps
2375 newcontext = context.copy()
2376 newcontext.clear_flags()
2377 for exception in _signals:
2378 newcontext.traps[exception] = 0
2379
2380 # round in the new context
2381 ans = ans._fix(newcontext)
2382
2383 # raise Inexact, and if necessary, Underflow
2384 newcontext._raise_error(Inexact)
2385 if newcontext.flags[Subnormal]:
2386 newcontext._raise_error(Underflow)
2387
2388 # propagate signals to the original context; _fix could
2389 # have raised any of Overflow, Underflow, Subnormal,
2390 # Inexact, Rounded, Clamped. Overflow needs the correct
2391 # arguments. Note that the order of the exceptions is
2392 # important here.
2393 if newcontext.flags[Overflow]:
2394 context._raise_error(Overflow, 'above Emax', ans._sign)
2395 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2396 if newcontext.flags[exception]:
2397 context._raise_error(exception)
2398
2399 else:
2400 ans = ans._fix(context)
2401
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002402 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403
2404 def __rpow__(self, other, context=None):
2405 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002406 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002407 if other is NotImplemented:
2408 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 return other.__pow__(self, context=context)
2410
2411 def normalize(self, context=None):
2412 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002414 if context is None:
2415 context = getcontext()
2416
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002417 if self._is_special:
2418 ans = self._check_nans(context=context)
2419 if ans:
2420 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002421
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002422 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002423 if dup._isinfinity():
2424 return dup
2425
2426 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002427 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002428 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429 end = len(dup._int)
2430 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002431 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432 exp += 1
2433 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002434 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002435
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002436 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437 """Quantize self so its exponent is the same as that of exp.
2438
2439 Similar to self._rescale(exp._exp) but with error checking.
2440 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002441 exp = _convert_other(exp, raiseit=True)
2442
2443 if context is None:
2444 context = getcontext()
2445 if rounding is None:
2446 rounding = context.rounding
2447
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002448 if self._is_special or exp._is_special:
2449 ans = self._check_nans(exp, context)
2450 if ans:
2451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002452
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002453 if exp._isinfinity() or self._isinfinity():
2454 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002455 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002456 return context._raise_error(InvalidOperation,
2457 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002458
2459 # if we're not watching exponents, do a simple rescale
2460 if not watchexp:
2461 ans = self._rescale(exp._exp, rounding)
2462 # raise Inexact and Rounded where appropriate
2463 if ans._exp > self._exp:
2464 context._raise_error(Rounded)
2465 if ans != self:
2466 context._raise_error(Inexact)
2467 return ans
2468
2469 # exp._exp should be between Etiny and Emax
2470 if not (context.Etiny() <= exp._exp <= context.Emax):
2471 return context._raise_error(InvalidOperation,
2472 'target exponent out of bounds in quantize')
2473
2474 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002475 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002476 return ans._fix(context)
2477
2478 self_adjusted = self.adjusted()
2479 if self_adjusted > context.Emax:
2480 return context._raise_error(InvalidOperation,
2481 'exponent of quantize result too large for current context')
2482 if self_adjusted - exp._exp + 1 > context.prec:
2483 return context._raise_error(InvalidOperation,
2484 'quantize result has too many digits for current context')
2485
2486 ans = self._rescale(exp._exp, rounding)
2487 if ans.adjusted() > context.Emax:
2488 return context._raise_error(InvalidOperation,
2489 'exponent of quantize result too large for current context')
2490 if len(ans._int) > context.prec:
2491 return context._raise_error(InvalidOperation,
2492 'quantize result has too many digits for current context')
2493
2494 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002495 if ans and ans.adjusted() < context.Emin:
2496 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002497 if ans._exp > self._exp:
2498 if ans != self:
2499 context._raise_error(Inexact)
2500 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002501
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002502 # call to fix takes care of any necessary folddown, and
2503 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002504 ans = ans._fix(context)
2505 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002506
2507 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002508 """Return True if self and other have the same exponent; otherwise
2509 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002511 If either operand is a special value, the following rules are used:
2512 * return True if both operands are infinities
2513 * return True if both operands are NaNs
2514 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002516 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002517 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002518 return (self.is_nan() and other.is_nan() or
2519 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520 return self._exp == other._exp
2521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002522 def _rescale(self, exp, rounding):
2523 """Rescale self so that the exponent is exp, either by padding with zeros
2524 or by truncating digits, using the given rounding mode.
2525
2526 Specials are returned without change. This operation is
2527 quiet: it raises no flags, and uses no information from the
2528 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002529
2530 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002531 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002533 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002534 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002535 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002536 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002538 if self._exp >= exp:
2539 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002540 return _dec_from_triple(self._sign,
2541 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 # too many digits; round and lose data. If self.adjusted() <
2544 # exp-1, replace self by 10**(exp-1) before rounding
2545 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002546 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002547 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002548 digits = 0
2549 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002550 changed = this_function(digits)
2551 coeff = self._int[:digits] or '0'
2552 if changed == 1:
2553 coeff = str(int(coeff)+1)
2554 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555
Christian Heimesf16baeb2008-02-29 14:57:44 +00002556 def _round(self, places, rounding):
2557 """Round a nonzero, nonspecial Decimal to a fixed number of
2558 significant figures, using the given rounding mode.
2559
2560 Infinities, NaNs and zeros are returned unaltered.
2561
2562 This operation is quiet: it raises no flags, and uses no
2563 information from the context.
2564
2565 """
2566 if places <= 0:
2567 raise ValueError("argument should be at least 1 in _round")
2568 if self._is_special or not self:
2569 return Decimal(self)
2570 ans = self._rescale(self.adjusted()+1-places, rounding)
2571 # it can happen that the rescale alters the adjusted exponent;
2572 # for example when rounding 99.97 to 3 significant figures.
2573 # When this happens we end up with an extra 0 at the end of
2574 # the number; a second rescale fixes this.
2575 if ans.adjusted() != self.adjusted():
2576 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2577 return ans
2578
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002579 def to_integral_exact(self, rounding=None, context=None):
2580 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002581
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002582 If no rounding mode is specified, take the rounding mode from
2583 the context. This method raises the Rounded and Inexact flags
2584 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002586 See also: to_integral_value, which does exactly the same as
2587 this method except that it doesn't raise Inexact or Rounded.
2588 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002589 if self._is_special:
2590 ans = self._check_nans(context=context)
2591 if ans:
2592 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002593 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002594 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002595 return Decimal(self)
2596 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002597 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002598 if context is None:
2599 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002600 if rounding is None:
2601 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002602 ans = self._rescale(0, rounding)
2603 if ans != self:
2604 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002605 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606 return ans
2607
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002608 def to_integral_value(self, rounding=None, context=None):
2609 """Rounds to the nearest integer, without raising inexact, rounded."""
2610 if context is None:
2611 context = getcontext()
2612 if rounding is None:
2613 rounding = context.rounding
2614 if self._is_special:
2615 ans = self._check_nans(context=context)
2616 if ans:
2617 return ans
2618 return Decimal(self)
2619 if self._exp >= 0:
2620 return Decimal(self)
2621 else:
2622 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002624 # the method name changed, but we provide also the old one, for compatibility
2625 to_integral = to_integral_value
2626
2627 def sqrt(self, context=None):
2628 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002629 if context is None:
2630 context = getcontext()
2631
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002632 if self._is_special:
2633 ans = self._check_nans(context=context)
2634 if ans:
2635 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002637 if self._isinfinity() and self._sign == 0:
2638 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639
2640 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002641 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002642 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002643 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002644
2645 if self._sign == 1:
2646 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2647
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002648 # At this point self represents a positive number. Let p be
2649 # the desired precision and express self in the form c*100**e
2650 # with c a positive real number and e an integer, c and e
2651 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2652 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2653 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2654 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2655 # the closest integer to sqrt(c) with the even integer chosen
2656 # in the case of a tie.
2657 #
2658 # To ensure correct rounding in all cases, we use the
2659 # following trick: we compute the square root to an extra
2660 # place (precision p+1 instead of precision p), rounding down.
2661 # Then, if the result is inexact and its last digit is 0 or 5,
2662 # we increase the last digit to 1 or 6 respectively; if it's
2663 # exact we leave the last digit alone. Now the final round to
2664 # p places (or fewer in the case of underflow) will round
2665 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002666
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002667 # use an extra digit of precision
2668 prec = context.prec+1
2669
2670 # write argument in the form c*100**e where e = self._exp//2
2671 # is the 'ideal' exponent, to be used if the square root is
2672 # exactly representable. l is the number of 'digits' of c in
2673 # base 100, so that 100**(l-1) <= c < 100**l.
2674 op = _WorkRep(self)
2675 e = op.exp >> 1
2676 if op.exp & 1:
2677 c = op.int * 10
2678 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002679 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002680 c = op.int
2681 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002683 # rescale so that c has exactly prec base 100 'digits'
2684 shift = prec-l
2685 if shift >= 0:
2686 c *= 100**shift
2687 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002688 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002689 c, remainder = divmod(c, 100**-shift)
2690 exact = not remainder
2691 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002692
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002693 # find n = floor(sqrt(c)) using Newton's method
2694 n = 10**prec
2695 while True:
2696 q = c//n
2697 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002698 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002699 else:
2700 n = n + q >> 1
2701 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002702
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002703 if exact:
2704 # result is exact; rescale to use ideal exponent e
2705 if shift >= 0:
2706 # assert n % 10**shift == 0
2707 n //= 10**shift
2708 else:
2709 n *= 10**-shift
2710 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002711 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002712 # result is not exact; fix last digit as described above
2713 if n % 5 == 0:
2714 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002715
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002716 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002717
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002718 # round, and fit to current context
2719 context = context._shallow_copy()
2720 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002721 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002722 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002723
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002724 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002725
2726 def max(self, other, context=None):
2727 """Returns the larger value.
2728
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002730 NaN (and signals if one is sNaN). Also rounds.
2731 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002732 other = _convert_other(other, raiseit=True)
2733
2734 if context is None:
2735 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002736
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002737 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002738 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002739 # number is always returned
2740 sn = self._isnan()
2741 on = other._isnan()
2742 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002743 if on == 1 and sn == 0:
2744 return self._fix(context)
2745 if sn == 1 and on == 0:
2746 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002747 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002748
Christian Heimes77c02eb2008-02-09 02:18:51 +00002749 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002750 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002751 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002752 # then an ordering is applied:
2753 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002754 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002755 # positive sign and min returns the operand with the negative sign
2756 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002757 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002758 # the result. This is exactly the ordering used in compare_total.
2759 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002760
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 if c == -1:
2762 ans = other
2763 else:
2764 ans = self
2765
Christian Heimes2c181612007-12-17 20:04:13 +00002766 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002767
2768 def min(self, other, context=None):
2769 """Returns the smaller value.
2770
Guido van Rossumd8faa362007-04-27 19:54:29 +00002771 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002772 NaN (and signals if one is sNaN). Also rounds.
2773 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002774 other = _convert_other(other, raiseit=True)
2775
2776 if context is None:
2777 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002778
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002779 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002780 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002781 # number is always returned
2782 sn = self._isnan()
2783 on = other._isnan()
2784 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002785 if on == 1 and sn == 0:
2786 return self._fix(context)
2787 if sn == 1 and on == 0:
2788 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002789 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002790
Christian Heimes77c02eb2008-02-09 02:18:51 +00002791 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002792 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002793 c = self.compare_total(other)
2794
2795 if c == -1:
2796 ans = self
2797 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002798 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002799
Christian Heimes2c181612007-12-17 20:04:13 +00002800 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002801
2802 def _isinteger(self):
2803 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002804 if self._is_special:
2805 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002806 if self._exp >= 0:
2807 return True
2808 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002809 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002810
2811 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002812 """Returns True if self is even. Assumes self is an integer."""
2813 if not self or self._exp > 0:
2814 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002815 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002816
2817 def adjusted(self):
2818 """Return the adjusted exponent of self"""
2819 try:
2820 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002821 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002822 except TypeError:
2823 return 0
2824
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002825 def canonical(self, context=None):
2826 """Returns the same Decimal object.
2827
2828 As we do not have different encodings for the same number, the
2829 received object already is in its canonical form.
2830 """
2831 return self
2832
2833 def compare_signal(self, other, context=None):
2834 """Compares self to the other operand numerically.
2835
2836 It's pretty much like compare(), but all NaNs signal, with signaling
2837 NaNs taking precedence over quiet NaNs.
2838 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002839 other = _convert_other(other, raiseit = True)
2840 ans = self._compare_check_nans(other, context)
2841 if ans:
2842 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002843 return self.compare(other, context=context)
2844
2845 def compare_total(self, other):
2846 """Compares self to other using the abstract representations.
2847
2848 This is not like the standard compare, which use their numerical
2849 value. Note that a total ordering is defined for all possible abstract
2850 representations.
2851 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002852 other = _convert_other(other, raiseit=True)
2853
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002854 # if one is negative and the other is positive, it's easy
2855 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002856 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002857 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002858 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859 sign = self._sign
2860
2861 # let's handle both NaN types
2862 self_nan = self._isnan()
2863 other_nan = other._isnan()
2864 if self_nan or other_nan:
2865 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002866 # compare payloads as though they're integers
2867 self_key = len(self._int), self._int
2868 other_key = len(other._int), other._int
2869 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002870 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002871 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002872 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002873 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002874 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002875 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002876 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002877 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002878 return _One
2879 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880
2881 if sign:
2882 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002883 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002884 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002885 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002886 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002887 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002888 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002889 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002890 else:
2891 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002892 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002893 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002894 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002895 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002896 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002897 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002898 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002899
2900 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002901 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002902 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002903 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002904
2905 if self._exp < other._exp:
2906 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002907 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002908 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002909 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002910 if self._exp > other._exp:
2911 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002912 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002913 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002914 return _One
2915 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916
2917
2918 def compare_total_mag(self, other):
2919 """Compares self to other using abstract repr., ignoring sign.
2920
2921 Like compare_total, but with operand's sign ignored and assumed to be 0.
2922 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002923 other = _convert_other(other, raiseit=True)
2924
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002925 s = self.copy_abs()
2926 o = other.copy_abs()
2927 return s.compare_total(o)
2928
2929 def copy_abs(self):
2930 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002931 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002932
2933 def copy_negate(self):
2934 """Returns a copy with the sign inverted."""
2935 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002936 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002937 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002938 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002939
2940 def copy_sign(self, other):
2941 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002942 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002943 return _dec_from_triple(other._sign, self._int,
2944 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002945
2946 def exp(self, context=None):
2947 """Returns e ** self."""
2948
2949 if context is None:
2950 context = getcontext()
2951
2952 # exp(NaN) = NaN
2953 ans = self._check_nans(context=context)
2954 if ans:
2955 return ans
2956
2957 # exp(-Infinity) = 0
2958 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002959 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002960
2961 # exp(0) = 1
2962 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002963 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002964
2965 # exp(Infinity) = Infinity
2966 if self._isinfinity() == 1:
2967 return Decimal(self)
2968
2969 # the result is now guaranteed to be inexact (the true
2970 # mathematical result is transcendental). There's no need to
2971 # raise Rounded and Inexact here---they'll always be raised as
2972 # a result of the call to _fix.
2973 p = context.prec
2974 adj = self.adjusted()
2975
2976 # we only need to do any computation for quite a small range
2977 # of adjusted exponents---for example, -29 <= adj <= 10 for
2978 # the default context. For smaller exponent the result is
2979 # indistinguishable from 1 at the given precision, while for
2980 # larger exponent the result either overflows or underflows.
2981 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2982 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002983 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002984 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2985 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002986 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002987 elif self._sign == 0 and adj < -p:
2988 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002989 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002990 elif self._sign == 1 and adj < -p-1:
2991 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002992 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002993 # general case
2994 else:
2995 op = _WorkRep(self)
2996 c, e = op.int, op.exp
2997 if op.sign == 1:
2998 c = -c
2999
3000 # compute correctly rounded result: increase precision by
3001 # 3 digits at a time until we get an unambiguously
3002 # roundable result
3003 extra = 3
3004 while True:
3005 coeff, exp = _dexp(c, e, p+extra)
3006 if coeff % (5*10**(len(str(coeff))-p-1)):
3007 break
3008 extra += 3
3009
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003010 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003011
3012 # at this stage, ans should round correctly with *any*
3013 # rounding mode, not just with ROUND_HALF_EVEN
3014 context = context._shallow_copy()
3015 rounding = context._set_rounding(ROUND_HALF_EVEN)
3016 ans = ans._fix(context)
3017 context.rounding = rounding
3018
3019 return ans
3020
3021 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003022 """Return True if self is canonical; otherwise return False.
3023
3024 Currently, the encoding of a Decimal instance is always
3025 canonical, so this method returns True for any Decimal.
3026 """
3027 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003028
3029 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003030 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003031
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003032 A Decimal instance is considered finite if it is neither
3033 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003034 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003035 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003036
3037 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003038 """Return True if self is infinite; otherwise return False."""
3039 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003040
3041 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003042 """Return True if self is a qNaN or sNaN; otherwise return False."""
3043 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003044
3045 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003046 """Return True if self is a normal number; otherwise return False."""
3047 if self._is_special or not self:
3048 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003049 if context is None:
3050 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003051 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003052
3053 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003054 """Return True if self is a quiet NaN; otherwise return False."""
3055 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003056
3057 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003058 """Return True if self is negative; otherwise return False."""
3059 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003060
3061 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003062 """Return True if self is a signaling NaN; otherwise return False."""
3063 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003064
3065 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003066 """Return True if self is subnormal; otherwise return False."""
3067 if self._is_special or not self:
3068 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003069 if context is None:
3070 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003071 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003072
3073 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003074 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003075 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003076
3077 def _ln_exp_bound(self):
3078 """Compute a lower bound for the adjusted exponent of self.ln().
3079 In other words, compute r such that self.ln() >= 10**r. Assumes
3080 that self is finite and positive and that self != 1.
3081 """
3082
3083 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3084 adj = self._exp + len(self._int) - 1
3085 if adj >= 1:
3086 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3087 return len(str(adj*23//10)) - 1
3088 if adj <= -2:
3089 # argument <= 0.1
3090 return len(str((-1-adj)*23//10)) - 1
3091 op = _WorkRep(self)
3092 c, e = op.int, op.exp
3093 if adj == 0:
3094 # 1 < self < 10
3095 num = str(c-10**-e)
3096 den = str(c)
3097 return len(num) - len(den) - (num < den)
3098 # adj == -1, 0.1 <= self < 1
3099 return e + len(str(10**-e - c)) - 1
3100
3101
3102 def ln(self, context=None):
3103 """Returns the natural (base e) logarithm of self."""
3104
3105 if context is None:
3106 context = getcontext()
3107
3108 # ln(NaN) = NaN
3109 ans = self._check_nans(context=context)
3110 if ans:
3111 return ans
3112
3113 # ln(0.0) == -Infinity
3114 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003115 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003116
3117 # ln(Infinity) = Infinity
3118 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003119 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003120
3121 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003122 if self == _One:
3123 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003124
3125 # ln(negative) raises InvalidOperation
3126 if self._sign == 1:
3127 return context._raise_error(InvalidOperation,
3128 'ln of a negative value')
3129
3130 # result is irrational, so necessarily inexact
3131 op = _WorkRep(self)
3132 c, e = op.int, op.exp
3133 p = context.prec
3134
3135 # correctly rounded result: repeatedly increase precision by 3
3136 # until we get an unambiguously roundable result
3137 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3138 while True:
3139 coeff = _dlog(c, e, places)
3140 # assert len(str(abs(coeff)))-p >= 1
3141 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3142 break
3143 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003144 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003145
3146 context = context._shallow_copy()
3147 rounding = context._set_rounding(ROUND_HALF_EVEN)
3148 ans = ans._fix(context)
3149 context.rounding = rounding
3150 return ans
3151
3152 def _log10_exp_bound(self):
3153 """Compute a lower bound for the adjusted exponent of self.log10().
3154 In other words, find r such that self.log10() >= 10**r.
3155 Assumes that self is finite and positive and that self != 1.
3156 """
3157
3158 # For x >= 10 or x < 0.1 we only need a bound on the integer
3159 # part of log10(self), and this comes directly from the
3160 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3161 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3162 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3163
3164 adj = self._exp + len(self._int) - 1
3165 if adj >= 1:
3166 # self >= 10
3167 return len(str(adj))-1
3168 if adj <= -2:
3169 # self < 0.1
3170 return len(str(-1-adj))-1
3171 op = _WorkRep(self)
3172 c, e = op.int, op.exp
3173 if adj == 0:
3174 # 1 < self < 10
3175 num = str(c-10**-e)
3176 den = str(231*c)
3177 return len(num) - len(den) - (num < den) + 2
3178 # adj == -1, 0.1 <= self < 1
3179 num = str(10**-e-c)
3180 return len(num) + e - (num < "231") - 1
3181
3182 def log10(self, context=None):
3183 """Returns the base 10 logarithm of self."""
3184
3185 if context is None:
3186 context = getcontext()
3187
3188 # log10(NaN) = NaN
3189 ans = self._check_nans(context=context)
3190 if ans:
3191 return ans
3192
3193 # log10(0.0) == -Infinity
3194 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003195 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003196
3197 # log10(Infinity) = Infinity
3198 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003199 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003200
3201 # log10(negative or -Infinity) raises InvalidOperation
3202 if self._sign == 1:
3203 return context._raise_error(InvalidOperation,
3204 'log10 of a negative value')
3205
3206 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003207 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003208 # answer may need rounding
3209 ans = Decimal(self._exp + len(self._int) - 1)
3210 else:
3211 # result is irrational, so necessarily inexact
3212 op = _WorkRep(self)
3213 c, e = op.int, op.exp
3214 p = context.prec
3215
3216 # correctly rounded result: repeatedly increase precision
3217 # until result is unambiguously roundable
3218 places = p-self._log10_exp_bound()+2
3219 while True:
3220 coeff = _dlog10(c, e, places)
3221 # assert len(str(abs(coeff)))-p >= 1
3222 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3223 break
3224 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003225 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003226
3227 context = context._shallow_copy()
3228 rounding = context._set_rounding(ROUND_HALF_EVEN)
3229 ans = ans._fix(context)
3230 context.rounding = rounding
3231 return ans
3232
3233 def logb(self, context=None):
3234 """ Returns the exponent of the magnitude of self's MSD.
3235
3236 The result is the integer which is the exponent of the magnitude
3237 of the most significant digit of self (as though it were truncated
3238 to a single digit while maintaining the value of that digit and
3239 without limiting the resulting exponent).
3240 """
3241 # logb(NaN) = NaN
3242 ans = self._check_nans(context=context)
3243 if ans:
3244 return ans
3245
3246 if context is None:
3247 context = getcontext()
3248
3249 # logb(+/-Inf) = +Inf
3250 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003251 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003252
3253 # logb(0) = -Inf, DivisionByZero
3254 if not self:
3255 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3256
3257 # otherwise, simply return the adjusted exponent of self, as a
3258 # Decimal. Note that no attempt is made to fit the result
3259 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003260 ans = Decimal(self.adjusted())
3261 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003262
3263 def _islogical(self):
3264 """Return True if self is a logical operand.
3265
Christian Heimes679db4a2008-01-18 09:56:22 +00003266 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003267 an exponent of 0, and a coefficient whose digits must all be
3268 either 0 or 1.
3269 """
3270 if self._sign != 0 or self._exp != 0:
3271 return False
3272 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003273 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003274 return False
3275 return True
3276
3277 def _fill_logical(self, context, opa, opb):
3278 dif = context.prec - len(opa)
3279 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003280 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003281 elif dif < 0:
3282 opa = opa[-context.prec:]
3283 dif = context.prec - len(opb)
3284 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003285 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003286 elif dif < 0:
3287 opb = opb[-context.prec:]
3288 return opa, opb
3289
3290 def logical_and(self, other, context=None):
3291 """Applies an 'and' operation between self and other's digits."""
3292 if context is None:
3293 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003294
3295 other = _convert_other(other, raiseit=True)
3296
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003297 if not self._islogical() or not other._islogical():
3298 return context._raise_error(InvalidOperation)
3299
3300 # fill to context.prec
3301 (opa, opb) = self._fill_logical(context, self._int, other._int)
3302
3303 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003304 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3305 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003306
3307 def logical_invert(self, context=None):
3308 """Invert all its digits."""
3309 if context is None:
3310 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003311 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3312 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003313
3314 def logical_or(self, other, context=None):
3315 """Applies an 'or' operation between self and other's digits."""
3316 if context is None:
3317 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003318
3319 other = _convert_other(other, raiseit=True)
3320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003321 if not self._islogical() or not other._islogical():
3322 return context._raise_error(InvalidOperation)
3323
3324 # fill to context.prec
3325 (opa, opb) = self._fill_logical(context, self._int, other._int)
3326
3327 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003328 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003329 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003330
3331 def logical_xor(self, other, context=None):
3332 """Applies an 'xor' operation between self and other's digits."""
3333 if context is None:
3334 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003335
3336 other = _convert_other(other, raiseit=True)
3337
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003338 if not self._islogical() or not other._islogical():
3339 return context._raise_error(InvalidOperation)
3340
3341 # fill to context.prec
3342 (opa, opb) = self._fill_logical(context, self._int, other._int)
3343
3344 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003345 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003346 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003347
3348 def max_mag(self, other, context=None):
3349 """Compares the values numerically with their sign ignored."""
3350 other = _convert_other(other, raiseit=True)
3351
3352 if context is None:
3353 context = getcontext()
3354
3355 if self._is_special or other._is_special:
3356 # If one operand is a quiet NaN and the other is number, then the
3357 # number is always returned
3358 sn = self._isnan()
3359 on = other._isnan()
3360 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003361 if on == 1 and sn == 0:
3362 return self._fix(context)
3363 if sn == 1 and on == 0:
3364 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003365 return self._check_nans(other, context)
3366
Christian Heimes77c02eb2008-02-09 02:18:51 +00003367 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003368 if c == 0:
3369 c = self.compare_total(other)
3370
3371 if c == -1:
3372 ans = other
3373 else:
3374 ans = self
3375
Christian Heimes2c181612007-12-17 20:04:13 +00003376 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003377
3378 def min_mag(self, other, context=None):
3379 """Compares the values numerically with their sign ignored."""
3380 other = _convert_other(other, raiseit=True)
3381
3382 if context is None:
3383 context = getcontext()
3384
3385 if self._is_special or other._is_special:
3386 # If one operand is a quiet NaN and the other is number, then the
3387 # number is always returned
3388 sn = self._isnan()
3389 on = other._isnan()
3390 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003391 if on == 1 and sn == 0:
3392 return self._fix(context)
3393 if sn == 1 and on == 0:
3394 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003395 return self._check_nans(other, context)
3396
Christian Heimes77c02eb2008-02-09 02:18:51 +00003397 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003398 if c == 0:
3399 c = self.compare_total(other)
3400
3401 if c == -1:
3402 ans = self
3403 else:
3404 ans = other
3405
Christian Heimes2c181612007-12-17 20:04:13 +00003406 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003407
3408 def next_minus(self, context=None):
3409 """Returns the largest representable number smaller than itself."""
3410 if context is None:
3411 context = getcontext()
3412
3413 ans = self._check_nans(context=context)
3414 if ans:
3415 return ans
3416
3417 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003418 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003419 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003420 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003421
3422 context = context.copy()
3423 context._set_rounding(ROUND_FLOOR)
3424 context._ignore_all_flags()
3425 new_self = self._fix(context)
3426 if new_self != self:
3427 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003428 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3429 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003430
3431 def next_plus(self, context=None):
3432 """Returns the smallest representable number larger than itself."""
3433 if context is None:
3434 context = getcontext()
3435
3436 ans = self._check_nans(context=context)
3437 if ans:
3438 return ans
3439
3440 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003441 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003442 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003443 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003444
3445 context = context.copy()
3446 context._set_rounding(ROUND_CEILING)
3447 context._ignore_all_flags()
3448 new_self = self._fix(context)
3449 if new_self != self:
3450 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003451 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3452 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003453
3454 def next_toward(self, other, context=None):
3455 """Returns the number closest to self, in the direction towards other.
3456
3457 The result is the closest representable number to self
3458 (excluding self) that is in the direction towards other,
3459 unless both have the same value. If the two operands are
3460 numerically equal, then the result is a copy of self with the
3461 sign set to be the same as the sign of other.
3462 """
3463 other = _convert_other(other, raiseit=True)
3464
3465 if context is None:
3466 context = getcontext()
3467
3468 ans = self._check_nans(other, context)
3469 if ans:
3470 return ans
3471
Christian Heimes77c02eb2008-02-09 02:18:51 +00003472 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003473 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003474 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003475
3476 if comparison == -1:
3477 ans = self.next_plus(context)
3478 else: # comparison == 1
3479 ans = self.next_minus(context)
3480
3481 # decide which flags to raise using value of ans
3482 if ans._isinfinity():
3483 context._raise_error(Overflow,
3484 'Infinite result from next_toward',
3485 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003486 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003487 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003488 elif ans.adjusted() < context.Emin:
3489 context._raise_error(Underflow)
3490 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003491 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003492 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003493 # if precision == 1 then we don't raise Clamped for a
3494 # result 0E-Etiny.
3495 if not ans:
3496 context._raise_error(Clamped)
3497
3498 return ans
3499
3500 def number_class(self, context=None):
3501 """Returns an indication of the class of self.
3502
3503 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003504 sNaN
3505 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003506 -Infinity
3507 -Normal
3508 -Subnormal
3509 -Zero
3510 +Zero
3511 +Subnormal
3512 +Normal
3513 +Infinity
3514 """
3515 if self.is_snan():
3516 return "sNaN"
3517 if self.is_qnan():
3518 return "NaN"
3519 inf = self._isinfinity()
3520 if inf == 1:
3521 return "+Infinity"
3522 if inf == -1:
3523 return "-Infinity"
3524 if self.is_zero():
3525 if self._sign:
3526 return "-Zero"
3527 else:
3528 return "+Zero"
3529 if context is None:
3530 context = getcontext()
3531 if self.is_subnormal(context=context):
3532 if self._sign:
3533 return "-Subnormal"
3534 else:
3535 return "+Subnormal"
3536 # just a normal, regular, boring number, :)
3537 if self._sign:
3538 return "-Normal"
3539 else:
3540 return "+Normal"
3541
3542 def radix(self):
3543 """Just returns 10, as this is Decimal, :)"""
3544 return Decimal(10)
3545
3546 def rotate(self, other, context=None):
3547 """Returns a rotated copy of self, value-of-other times."""
3548 if context is None:
3549 context = getcontext()
3550
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003551 other = _convert_other(other, raiseit=True)
3552
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003553 ans = self._check_nans(other, context)
3554 if ans:
3555 return ans
3556
3557 if other._exp != 0:
3558 return context._raise_error(InvalidOperation)
3559 if not (-context.prec <= int(other) <= context.prec):
3560 return context._raise_error(InvalidOperation)
3561
3562 if self._isinfinity():
3563 return Decimal(self)
3564
3565 # get values, pad if necessary
3566 torot = int(other)
3567 rotdig = self._int
3568 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003569 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003570 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003571 elif topad < 0:
3572 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003573
3574 # let's rotate!
3575 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003576 return _dec_from_triple(self._sign,
3577 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003578
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003579 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003580 """Returns self operand after adding the second value to its exp."""
3581 if context is None:
3582 context = getcontext()
3583
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003584 other = _convert_other(other, raiseit=True)
3585
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003586 ans = self._check_nans(other, context)
3587 if ans:
3588 return ans
3589
3590 if other._exp != 0:
3591 return context._raise_error(InvalidOperation)
3592 liminf = -2 * (context.Emax + context.prec)
3593 limsup = 2 * (context.Emax + context.prec)
3594 if not (liminf <= int(other) <= limsup):
3595 return context._raise_error(InvalidOperation)
3596
3597 if self._isinfinity():
3598 return Decimal(self)
3599
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003600 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003601 d = d._fix(context)
3602 return d
3603
3604 def shift(self, other, context=None):
3605 """Returns a shifted copy of self, value-of-other times."""
3606 if context is None:
3607 context = getcontext()
3608
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003609 other = _convert_other(other, raiseit=True)
3610
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003611 ans = self._check_nans(other, context)
3612 if ans:
3613 return ans
3614
3615 if other._exp != 0:
3616 return context._raise_error(InvalidOperation)
3617 if not (-context.prec <= int(other) <= context.prec):
3618 return context._raise_error(InvalidOperation)
3619
3620 if self._isinfinity():
3621 return Decimal(self)
3622
3623 # get values, pad if necessary
3624 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003625 rotdig = self._int
3626 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003627 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003628 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003629 elif topad < 0:
3630 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003631
3632 # let's shift!
3633 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003634 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003635 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003636 shifted = rotdig + '0'*torot
3637 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003638
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003639 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003640 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003641
Guido van Rossumd8faa362007-04-27 19:54:29 +00003642 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003643 def __reduce__(self):
3644 return (self.__class__, (str(self),))
3645
3646 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003647 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003648 return self # I'm immutable; therefore I am my own clone
3649 return self.__class__(str(self))
3650
3651 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003652 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003653 return self # My components are also immutable
3654 return self.__class__(str(self))
3655
Mark Dickinson79f52032009-03-17 23:12:51 +00003656 # PEP 3101 support. the _localeconv keyword argument should be
3657 # considered private: it's provided for ease of testing only.
3658 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003659 """Format a Decimal instance according to the given specifier.
3660
3661 The specifier should be a standard format specifier, with the
3662 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003663 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3664 type is omitted it defaults to 'g' or 'G', depending on the
3665 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003666 """
3667
3668 # Note: PEP 3101 says that if the type is not present then
3669 # there should be at least one digit after the decimal point.
3670 # We take the liberty of ignoring this requirement for
3671 # Decimal---it's presumably there to make sure that
3672 # format(float, '') behaves similarly to str(float).
3673 if context is None:
3674 context = getcontext()
3675
Mark Dickinson79f52032009-03-17 23:12:51 +00003676 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003677
Mark Dickinson79f52032009-03-17 23:12:51 +00003678 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003679 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003680 sign = _format_sign(self._sign, spec)
3681 body = str(self.copy_abs())
3682 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003683
3684 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003685 if spec['type'] is None:
3686 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003687
3688 # if type is '%', adjust exponent of self accordingly
3689 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003690 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3691
3692 # round if necessary, taking rounding mode from the context
3693 rounding = context.rounding
3694 precision = spec['precision']
3695 if precision is not None:
3696 if spec['type'] in 'eE':
3697 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003698 elif spec['type'] in 'fF%':
3699 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003700 elif spec['type'] in 'gG' and len(self._int) > precision:
3701 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003702 # special case: zeros with a positive exponent can't be
3703 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003704 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003705 self = self._rescale(0, rounding)
3706
3707 # figure out placement of the decimal point
3708 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003709 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003710 if not self and precision is not None:
3711 dotplace = 1 - precision
3712 else:
3713 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003714 elif spec['type'] in 'fF%':
3715 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003716 elif spec['type'] in 'gG':
3717 if self._exp <= 0 and leftdigits > -6:
3718 dotplace = leftdigits
3719 else:
3720 dotplace = 1
3721
Mark Dickinson79f52032009-03-17 23:12:51 +00003722 # find digits before and after decimal point, and get exponent
3723 if dotplace < 0:
3724 intpart = '0'
3725 fracpart = '0'*(-dotplace) + self._int
3726 elif dotplace > len(self._int):
3727 intpart = self._int + '0'*(dotplace-len(self._int))
3728 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003729 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003730 intpart = self._int[:dotplace] or '0'
3731 fracpart = self._int[dotplace:]
3732 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003733
Mark Dickinson79f52032009-03-17 23:12:51 +00003734 # done with the decimal-specific stuff; hand over the rest
3735 # of the formatting to the _format_number function
3736 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003737
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003738def _dec_from_triple(sign, coefficient, exponent, special=False):
3739 """Create a decimal instance directly, without any validation,
3740 normalization (e.g. removal of leading zeros) or argument
3741 conversion.
3742
3743 This function is for *internal use only*.
3744 """
3745
3746 self = object.__new__(Decimal)
3747 self._sign = sign
3748 self._int = coefficient
3749 self._exp = exponent
3750 self._is_special = special
3751
3752 return self
3753
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003754# Register Decimal as a kind of Number (an abstract base class).
3755# However, do not register it as Real (because Decimals are not
3756# interoperable with floats).
3757_numbers.Number.register(Decimal)
3758
3759
Guido van Rossumd8faa362007-04-27 19:54:29 +00003760##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003761
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003762
3763# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003764rounding_functions = [name for name in Decimal.__dict__.keys()
3765 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003766for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003767 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003768 globalname = name[1:].upper()
3769 val = globals()[globalname]
3770 Decimal._pick_rounding_function[val] = name
3771
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003772del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003773
Thomas Wouters89f507f2006-12-13 04:49:30 +00003774class _ContextManager(object):
3775 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003776
Thomas Wouters89f507f2006-12-13 04:49:30 +00003777 Sets a copy of the supplied context in __enter__() and restores
3778 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003779 """
3780 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003781 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003782 def __enter__(self):
3783 self.saved_context = getcontext()
3784 setcontext(self.new_context)
3785 return self.new_context
3786 def __exit__(self, t, v, tb):
3787 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003788
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003789class Context(object):
3790 """Contains the context for a Decimal instance.
3791
3792 Contains:
3793 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003794 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003795 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003796 raised when it is caused. Otherwise, a value is
3797 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003798 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799 (Whether or not the trap_enabler is set)
3800 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003801 Emin - Minimum exponent
3802 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003803 capitals - If 1, 1*10^1 is printed as 1E+1.
3804 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003805 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003806 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003807
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003808 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003809 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003810 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003811 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003812 _ignored_flags=None):
3813 if flags is None:
3814 flags = []
3815 if _ignored_flags is None:
3816 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003817 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003818 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003819 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003820 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003821 for name, val in locals().items():
3822 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003823 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003824 else:
3825 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826 del self.self
3827
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003828 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003829 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003830 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003831 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003832 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3833 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003834 % vars(self))
3835 names = [f.__name__ for f, v in self.flags.items() if v]
3836 s.append('flags=[' + ', '.join(names) + ']')
3837 names = [t.__name__ for t, v in self.traps.items() if v]
3838 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003839 return ', '.join(s) + ')'
3840
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003841 def clear_flags(self):
3842 """Reset all flags to zero"""
3843 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003844 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003845
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003846 def _shallow_copy(self):
3847 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003848 nc = Context(self.prec, self.rounding, self.traps,
3849 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003850 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003851 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003852
3853 def copy(self):
3854 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003855 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003856 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003857 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003858 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003859 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003860
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003861 # _clamp is provided for backwards compatibility with third-party
3862 # code. May be removed in Python >= 3.3.
3863 def _get_clamp(self):
3864 "_clamp mirrors the clamp attribute. Its use is deprecated."
3865 import warnings
3866 warnings.warn('Use of the _clamp attribute is deprecated. '
3867 'Please use clamp instead.',
3868 DeprecationWarning)
3869 return self.clamp
3870
3871 def _set_clamp(self, clamp):
3872 "_clamp mirrors the clamp attribute. Its use is deprecated."
3873 import warnings
3874 warnings.warn('Use of the _clamp attribute is deprecated. '
3875 'Please use clamp instead.',
3876 DeprecationWarning)
3877 self.clamp = clamp
3878
3879 # don't bother with _del_clamp; no sane 3rd party code should
3880 # be deleting the _clamp attribute
3881 _clamp = property(_get_clamp, _set_clamp)
3882
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003883 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003884 """Handles an error
3885
3886 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003887 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003888 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003889 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003890 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003891 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003892 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003893 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003894 return error().handle(self, *args)
3895
Raymond Hettinger86173da2008-02-01 20:38:12 +00003896 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003897 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003898 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003899 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003900
3901 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003902 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003903 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003904
3905 def _ignore_all_flags(self):
3906 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003907 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003908
3909 def _ignore_flags(self, *flags):
3910 """Ignore the flags, if they are raised"""
3911 # Do not mutate-- This way, copies of a context leave the original
3912 # alone.
3913 self._ignored_flags = (self._ignored_flags + list(flags))
3914 return list(flags)
3915
3916 def _regard_flags(self, *flags):
3917 """Stop ignoring the flags, if they are raised"""
3918 if flags and isinstance(flags[0], (tuple,list)):
3919 flags = flags[0]
3920 for flag in flags:
3921 self._ignored_flags.remove(flag)
3922
Nick Coghland1abd252008-07-15 15:46:38 +00003923 # We inherit object.__hash__, so we must deny this explicitly
3924 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003925
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003926 def Etiny(self):
3927 """Returns Etiny (= Emin - prec + 1)"""
3928 return int(self.Emin - self.prec + 1)
3929
3930 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003931 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003932 return int(self.Emax - self.prec + 1)
3933
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003934 def _set_rounding(self, type):
3935 """Sets the rounding type.
3936
3937 Sets the rounding type, and returns the current (previous)
3938 rounding type. Often used like:
3939
3940 context = context.copy()
3941 # so you don't change the calling context
3942 # if an error occurs in the middle.
3943 rounding = context._set_rounding(ROUND_UP)
3944 val = self.__sub__(other, context=context)
3945 context._set_rounding(rounding)
3946
3947 This will make it round up for that operation.
3948 """
3949 rounding = self.rounding
3950 self.rounding= type
3951 return rounding
3952
Raymond Hettingerfed52962004-07-14 15:41:57 +00003953 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003954 """Creates a new Decimal instance but using self as context.
3955
3956 This method implements the to-number operation of the
3957 IBM Decimal specification."""
3958
3959 if isinstance(num, str) and num != num.strip():
3960 return self._raise_error(ConversionSyntax,
3961 "no trailing or leading whitespace is "
3962 "permitted.")
3963
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003964 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003965 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003966 return self._raise_error(ConversionSyntax,
3967 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003968 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003969
Raymond Hettinger771ed762009-01-03 19:20:32 +00003970 def create_decimal_from_float(self, f):
3971 """Creates a new Decimal instance from a float but rounding using self
3972 as the context.
3973
3974 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3975 >>> context.create_decimal_from_float(3.1415926535897932)
3976 Decimal('3.1415')
3977 >>> context = Context(prec=5, traps=[Inexact])
3978 >>> context.create_decimal_from_float(3.1415926535897932)
3979 Traceback (most recent call last):
3980 ...
3981 decimal.Inexact: None
3982
3983 """
3984 d = Decimal.from_float(f) # An exact conversion
3985 return d._fix(self) # Apply the context rounding
3986
Guido van Rossumd8faa362007-04-27 19:54:29 +00003987 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003988 def abs(self, a):
3989 """Returns the absolute value of the operand.
3990
3991 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003992 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003993 the plus operation on the operand.
3994
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003995 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003996 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003997 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003998 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003999 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004000 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004001 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004002 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004003 >>> ExtendedContext.abs(-1)
4004 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004005 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004006 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004007 return a.__abs__(context=self)
4008
4009 def add(self, a, b):
4010 """Return the sum of the two operands.
4011
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004012 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004013 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004014 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004015 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004016 >>> ExtendedContext.add(1, Decimal(2))
4017 Decimal('3')
4018 >>> ExtendedContext.add(Decimal(8), 5)
4019 Decimal('13')
4020 >>> ExtendedContext.add(5, 5)
4021 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004022 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004023 a = _convert_other(a, raiseit=True)
4024 r = a.__add__(b, context=self)
4025 if r is NotImplemented:
4026 raise TypeError("Unable to convert %s to Decimal" % b)
4027 else:
4028 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004029
4030 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004031 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004032
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004033 def canonical(self, a):
4034 """Returns the same Decimal object.
4035
4036 As we do not have different encodings for the same number, the
4037 received object already is in its canonical form.
4038
4039 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004040 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004041 """
4042 return a.canonical(context=self)
4043
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004044 def compare(self, a, b):
4045 """Compares values numerically.
4046
4047 If the signs of the operands differ, a value representing each operand
4048 ('-1' if the operand is less than zero, '0' if the operand is zero or
4049 negative zero, or '1' if the operand is greater than zero) is used in
4050 place of that operand for the comparison instead of the actual
4051 operand.
4052
4053 The comparison is then effected by subtracting the second operand from
4054 the first and then returning a value according to the result of the
4055 subtraction: '-1' if the result is less than zero, '0' if the result is
4056 zero or negative zero, or '1' if the result is greater than zero.
4057
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004058 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004059 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004060 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004061 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004062 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004064 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004065 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004066 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004067 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004068 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004069 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004070 >>> ExtendedContext.compare(1, 2)
4071 Decimal('-1')
4072 >>> ExtendedContext.compare(Decimal(1), 2)
4073 Decimal('-1')
4074 >>> ExtendedContext.compare(1, Decimal(2))
4075 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004076 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004077 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004078 return a.compare(b, context=self)
4079
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004080 def compare_signal(self, a, b):
4081 """Compares the values of the two operands numerically.
4082
4083 It's pretty much like compare(), but all NaNs signal, with signaling
4084 NaNs taking precedence over quiet NaNs.
4085
4086 >>> c = ExtendedContext
4087 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004088 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004089 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004091 >>> c.flags[InvalidOperation] = 0
4092 >>> print(c.flags[InvalidOperation])
4093 0
4094 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004095 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004096 >>> print(c.flags[InvalidOperation])
4097 1
4098 >>> c.flags[InvalidOperation] = 0
4099 >>> print(c.flags[InvalidOperation])
4100 0
4101 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004102 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004103 >>> print(c.flags[InvalidOperation])
4104 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004105 >>> c.compare_signal(-1, 2)
4106 Decimal('-1')
4107 >>> c.compare_signal(Decimal(-1), 2)
4108 Decimal('-1')
4109 >>> c.compare_signal(-1, Decimal(2))
4110 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004111 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004112 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004113 return a.compare_signal(b, context=self)
4114
4115 def compare_total(self, a, b):
4116 """Compares two operands using their abstract representation.
4117
4118 This is not like the standard compare, which use their numerical
4119 value. Note that a total ordering is defined for all possible abstract
4120 representations.
4121
4122 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004123 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004124 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004125 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004126 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004127 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004128 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004129 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004130 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004131 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004132 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004133 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004134 >>> ExtendedContext.compare_total(1, 2)
4135 Decimal('-1')
4136 >>> ExtendedContext.compare_total(Decimal(1), 2)
4137 Decimal('-1')
4138 >>> ExtendedContext.compare_total(1, Decimal(2))
4139 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004140 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004141 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004142 return a.compare_total(b)
4143
4144 def compare_total_mag(self, a, b):
4145 """Compares two operands using their abstract representation ignoring sign.
4146
4147 Like compare_total, but with operand's sign ignored and assumed to be 0.
4148 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004149 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004150 return a.compare_total_mag(b)
4151
4152 def copy_abs(self, a):
4153 """Returns a copy of the operand with the sign set to 0.
4154
4155 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004156 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004157 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004158 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004159 >>> ExtendedContext.copy_abs(-1)
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.copy_abs()
4164
4165 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004166 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004167
4168 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004169 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004170 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004171 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004172 >>> ExtendedContext.copy_decimal(1)
4173 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004174 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004175 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004176 return Decimal(a)
4177
4178 def copy_negate(self, a):
4179 """Returns a copy of the operand with the sign inverted.
4180
4181 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004182 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004183 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004184 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004185 >>> ExtendedContext.copy_negate(1)
4186 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004187 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004188 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004189 return a.copy_negate()
4190
4191 def copy_sign(self, a, b):
4192 """Copies the second operand's sign to the first one.
4193
4194 In detail, it returns a copy of the first operand with the sign
4195 equal to the sign of the second operand.
4196
4197 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004198 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004199 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004200 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004201 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004202 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004203 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004204 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004205 >>> ExtendedContext.copy_sign(1, -2)
4206 Decimal('-1')
4207 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4208 Decimal('-1')
4209 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4210 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004211 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004212 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004213 return a.copy_sign(b)
4214
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004215 def divide(self, a, b):
4216 """Decimal division in a specified context.
4217
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004218 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004219 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004220 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004221 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004222 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004223 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004224 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004225 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004226 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004227 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004228 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004229 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004230 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004231 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004232 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004233 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004234 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004235 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004236 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004237 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004238 >>> ExtendedContext.divide(5, 5)
4239 Decimal('1')
4240 >>> ExtendedContext.divide(Decimal(5), 5)
4241 Decimal('1')
4242 >>> ExtendedContext.divide(5, Decimal(5))
4243 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004244 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004245 a = _convert_other(a, raiseit=True)
4246 r = a.__truediv__(b, context=self)
4247 if r is NotImplemented:
4248 raise TypeError("Unable to convert %s to Decimal" % b)
4249 else:
4250 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004251
4252 def divide_int(self, a, b):
4253 """Divides two numbers and returns the integer part of the result.
4254
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004255 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004256 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004257 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004258 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004259 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004260 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004261 >>> ExtendedContext.divide_int(10, 3)
4262 Decimal('3')
4263 >>> ExtendedContext.divide_int(Decimal(10), 3)
4264 Decimal('3')
4265 >>> ExtendedContext.divide_int(10, Decimal(3))
4266 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004267 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004268 a = _convert_other(a, raiseit=True)
4269 r = a.__floordiv__(b, context=self)
4270 if r is NotImplemented:
4271 raise TypeError("Unable to convert %s to Decimal" % b)
4272 else:
4273 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004274
4275 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004276 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004277
4278 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4279 (Decimal('2'), Decimal('2'))
4280 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4281 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004282 >>> ExtendedContext.divmod(8, 4)
4283 (Decimal('2'), Decimal('0'))
4284 >>> ExtendedContext.divmod(Decimal(8), 4)
4285 (Decimal('2'), Decimal('0'))
4286 >>> ExtendedContext.divmod(8, Decimal(4))
4287 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004288 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004289 a = _convert_other(a, raiseit=True)
4290 r = a.__divmod__(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
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004296 def exp(self, a):
4297 """Returns e ** a.
4298
4299 >>> c = ExtendedContext.copy()
4300 >>> c.Emin = -999
4301 >>> c.Emax = 999
4302 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004303 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004304 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004305 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004306 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004307 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004308 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004309 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004310 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004311 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004312 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004313 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004314 >>> c.exp(10)
4315 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004316 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004317 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004318 return a.exp(context=self)
4319
4320 def fma(self, a, b, c):
4321 """Returns a multiplied by b, plus c.
4322
4323 The first two operands are multiplied together, using multiply,
4324 the third operand is then added to the result of that
4325 multiplication, using add, all with only one final rounding.
4326
4327 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004328 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004329 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004330 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004332 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004333 >>> ExtendedContext.fma(1, 3, 4)
4334 Decimal('7')
4335 >>> ExtendedContext.fma(1, Decimal(3), 4)
4336 Decimal('7')
4337 >>> ExtendedContext.fma(1, 3, Decimal(4))
4338 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004339 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004340 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004341 return a.fma(b, c, context=self)
4342
4343 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004344 """Return True if the operand is canonical; otherwise return False.
4345
4346 Currently, the encoding of a Decimal instance is always
4347 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004348
4349 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004350 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004351 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004352 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004353
4354 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004355 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004356
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004357 A Decimal instance is considered finite if it is neither
4358 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004359
4360 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004361 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004362 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004363 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004364 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004365 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004366 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004367 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004368 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004369 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004370 >>> ExtendedContext.is_finite(1)
4371 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004372 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004373 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374 return a.is_finite()
4375
4376 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004377 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004378
4379 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004380 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004381 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004382 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004383 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004384 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004385 >>> ExtendedContext.is_infinite(1)
4386 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004387 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004388 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 return a.is_infinite()
4390
4391 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004392 """Return True if the operand is a qNaN or sNaN;
4393 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004394
4395 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004396 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004397 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004398 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004400 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004401 >>> ExtendedContext.is_nan(1)
4402 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004403 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004404 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004405 return a.is_nan()
4406
4407 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004408 """Return True if the operand is a normal number;
4409 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004410
4411 >>> c = ExtendedContext.copy()
4412 >>> c.Emin = -999
4413 >>> c.Emax = 999
4414 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004415 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004416 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004417 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004419 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004421 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004423 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004424 >>> c.is_normal(1)
4425 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004426 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004427 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004428 return a.is_normal(context=self)
4429
4430 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004431 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004432
4433 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004434 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004435 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004436 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004437 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004438 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004439 >>> ExtendedContext.is_qnan(1)
4440 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004442 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 return a.is_qnan()
4444
4445 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004446 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004447
4448 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004449 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004450 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004451 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004453 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004454 >>> ExtendedContext.is_signed(8)
4455 False
4456 >>> ExtendedContext.is_signed(-8)
4457 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004458 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004459 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004460 return a.is_signed()
4461
4462 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004463 """Return True if the operand is a signaling NaN;
4464 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004465
4466 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004467 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004468 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004469 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004470 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004471 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004472 >>> ExtendedContext.is_snan(1)
4473 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004474 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004475 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004476 return a.is_snan()
4477
4478 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004479 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004480
4481 >>> c = ExtendedContext.copy()
4482 >>> c.Emin = -999
4483 >>> c.Emax = 999
4484 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004485 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004486 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004487 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004488 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004489 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004490 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004491 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004492 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004493 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004494 >>> c.is_subnormal(1)
4495 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004496 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004497 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004498 return a.is_subnormal(context=self)
4499
4500 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004501 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004502
4503 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004504 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004505 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004506 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004507 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004508 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004509 >>> ExtendedContext.is_zero(1)
4510 False
4511 >>> ExtendedContext.is_zero(0)
4512 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004514 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 return a.is_zero()
4516
4517 def ln(self, a):
4518 """Returns the natural (base e) logarithm of the operand.
4519
4520 >>> c = ExtendedContext.copy()
4521 >>> c.Emin = -999
4522 >>> c.Emax = 999
4523 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004524 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004525 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004526 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004527 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004528 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004529 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004530 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004531 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004532 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004533 >>> c.ln(1)
4534 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004535 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004536 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004537 return a.ln(context=self)
4538
4539 def log10(self, a):
4540 """Returns the base 10 logarithm of the operand.
4541
4542 >>> c = ExtendedContext.copy()
4543 >>> c.Emin = -999
4544 >>> c.Emax = 999
4545 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004546 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004547 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004548 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004549 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004550 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004551 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004552 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004553 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004554 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004555 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004556 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004557 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004558 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004559 >>> c.log10(0)
4560 Decimal('-Infinity')
4561 >>> c.log10(1)
4562 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004563 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004564 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004565 return a.log10(context=self)
4566
4567 def logb(self, a):
4568 """ Returns the exponent of the magnitude of the operand's MSD.
4569
4570 The result is the integer which is the exponent of the magnitude
4571 of the most significant digit of the operand (as though the
4572 operand were truncated to a single digit while maintaining the
4573 value of that digit and without limiting the resulting exponent).
4574
4575 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004576 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004577 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004578 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004579 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004580 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004581 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004582 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004583 >>> ExtendedContext.logb(1)
4584 Decimal('0')
4585 >>> ExtendedContext.logb(10)
4586 Decimal('1')
4587 >>> ExtendedContext.logb(100)
4588 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004589 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004590 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004591 return a.logb(context=self)
4592
4593 def logical_and(self, a, b):
4594 """Applies the logical operation 'and' between each operand's digits.
4595
4596 The operands must be both logical numbers.
4597
4598 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004599 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004600 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004602 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004603 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004604 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004605 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004606 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004607 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004608 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004609 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004610 >>> ExtendedContext.logical_and(110, 1101)
4611 Decimal('100')
4612 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4613 Decimal('100')
4614 >>> ExtendedContext.logical_and(110, Decimal(1101))
4615 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004616 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004617 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004618 return a.logical_and(b, context=self)
4619
4620 def logical_invert(self, a):
4621 """Invert all the digits in the operand.
4622
4623 The operand must be a logical number.
4624
4625 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004626 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004627 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004631 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004632 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004633 >>> ExtendedContext.logical_invert(1101)
4634 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004635 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004636 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004637 return a.logical_invert(context=self)
4638
4639 def logical_or(self, a, b):
4640 """Applies the logical operation 'or' between each operand's digits.
4641
4642 The operands must be both logical numbers.
4643
4644 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004645 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004646 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004647 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004648 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004650 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004656 >>> ExtendedContext.logical_or(110, 1101)
4657 Decimal('1111')
4658 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4659 Decimal('1111')
4660 >>> ExtendedContext.logical_or(110, Decimal(1101))
4661 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004662 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004663 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004664 return a.logical_or(b, context=self)
4665
4666 def logical_xor(self, a, b):
4667 """Applies the logical operation 'xor' between each operand's digits.
4668
4669 The operands must be both logical numbers.
4670
4671 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004672 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004673 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004675 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004677 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004679 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004680 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004681 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004682 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004683 >>> ExtendedContext.logical_xor(110, 1101)
4684 Decimal('1011')
4685 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4686 Decimal('1011')
4687 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4688 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004689 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004690 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004691 return a.logical_xor(b, context=self)
4692
Mark Dickinson84230a12010-02-18 14:49:50 +00004693 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004694 """max compares two values numerically and returns the maximum.
4695
4696 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004697 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004698 operation. If they are numerically equal then the left-hand operand
4699 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004700 infinity) of the two operands is chosen as the result.
4701
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004702 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004703 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004704 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004705 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004706 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004707 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004708 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004709 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004710 >>> ExtendedContext.max(1, 2)
4711 Decimal('2')
4712 >>> ExtendedContext.max(Decimal(1), 2)
4713 Decimal('2')
4714 >>> ExtendedContext.max(1, Decimal(2))
4715 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004716 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004717 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004718 return a.max(b, context=self)
4719
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004720 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004721 """Compares the values numerically with their sign ignored.
4722
4723 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4724 Decimal('7')
4725 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4726 Decimal('-10')
4727 >>> ExtendedContext.max_mag(1, -2)
4728 Decimal('-2')
4729 >>> ExtendedContext.max_mag(Decimal(1), -2)
4730 Decimal('-2')
4731 >>> ExtendedContext.max_mag(1, Decimal(-2))
4732 Decimal('-2')
4733 """
4734 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004735 return a.max_mag(b, context=self)
4736
Mark Dickinson84230a12010-02-18 14:49:50 +00004737 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004738 """min compares two values numerically and returns the minimum.
4739
4740 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004741 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004742 operation. If they are numerically equal then the left-hand operand
4743 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004744 infinity) of the two operands is chosen as the result.
4745
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004746 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004747 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004748 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004749 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004750 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004751 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004752 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004753 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004754 >>> ExtendedContext.min(1, 2)
4755 Decimal('1')
4756 >>> ExtendedContext.min(Decimal(1), 2)
4757 Decimal('1')
4758 >>> ExtendedContext.min(1, Decimal(29))
4759 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004760 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004761 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004762 return a.min(b, context=self)
4763
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004764 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004765 """Compares the values numerically with their sign ignored.
4766
4767 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4768 Decimal('-2')
4769 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4770 Decimal('-3')
4771 >>> ExtendedContext.min_mag(1, -2)
4772 Decimal('1')
4773 >>> ExtendedContext.min_mag(Decimal(1), -2)
4774 Decimal('1')
4775 >>> ExtendedContext.min_mag(1, Decimal(-2))
4776 Decimal('1')
4777 """
4778 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004779 return a.min_mag(b, context=self)
4780
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004781 def minus(self, a):
4782 """Minus corresponds to unary prefix minus in Python.
4783
4784 The operation is evaluated using the same rules as subtract; the
4785 operation minus(a) is calculated as subtract('0', a) where the '0'
4786 has the same exponent as the operand.
4787
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004788 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004789 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004790 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004791 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004792 >>> ExtendedContext.minus(1)
4793 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004794 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004795 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004796 return a.__neg__(context=self)
4797
4798 def multiply(self, a, b):
4799 """multiply multiplies two operands.
4800
4801 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004802 Otherwise, the operands are multiplied together
4803 ('long multiplication'), resulting in a number which may be as long as
4804 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004805
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004806 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004807 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004808 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004809 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004810 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004811 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004812 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004813 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004814 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004815 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004816 >>> ExtendedContext.multiply(7, 7)
4817 Decimal('49')
4818 >>> ExtendedContext.multiply(Decimal(7), 7)
4819 Decimal('49')
4820 >>> ExtendedContext.multiply(7, Decimal(7))
4821 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004822 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004823 a = _convert_other(a, raiseit=True)
4824 r = a.__mul__(b, context=self)
4825 if r is NotImplemented:
4826 raise TypeError("Unable to convert %s to Decimal" % b)
4827 else:
4828 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004829
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004830 def next_minus(self, a):
4831 """Returns the largest representable number smaller than a.
4832
4833 >>> c = ExtendedContext.copy()
4834 >>> c.Emin = -999
4835 >>> c.Emax = 999
4836 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004837 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004838 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004839 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004840 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004841 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004842 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004843 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004844 >>> c.next_minus(1)
4845 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004846 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004847 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004848 return a.next_minus(context=self)
4849
4850 def next_plus(self, a):
4851 """Returns the smallest representable number larger than a.
4852
4853 >>> c = ExtendedContext.copy()
4854 >>> c.Emin = -999
4855 >>> c.Emax = 999
4856 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004857 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004858 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004859 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004860 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004861 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004862 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004863 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004864 >>> c.next_plus(1)
4865 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004866 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004867 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004868 return a.next_plus(context=self)
4869
4870 def next_toward(self, a, b):
4871 """Returns the number closest to a, in direction towards b.
4872
4873 The result is the closest representable number from the first
4874 operand (but not the first operand) that is in the direction
4875 towards the second operand, unless the operands have the same
4876 value.
4877
4878 >>> c = ExtendedContext.copy()
4879 >>> c.Emin = -999
4880 >>> c.Emax = 999
4881 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004882 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004883 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004884 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004885 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004886 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004887 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004888 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004889 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004890 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004891 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004892 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004893 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004894 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004895 >>> c.next_toward(0, 1)
4896 Decimal('1E-1007')
4897 >>> c.next_toward(Decimal(0), 1)
4898 Decimal('1E-1007')
4899 >>> c.next_toward(0, Decimal(1))
4900 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004901 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004902 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004903 return a.next_toward(b, context=self)
4904
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004905 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004906 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004907
4908 Essentially a plus operation with all trailing zeros removed from the
4909 result.
4910
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004911 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004912 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004913 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004914 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004915 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004916 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004917 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004918 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004919 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004920 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004921 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004922 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004923 >>> ExtendedContext.normalize(6)
4924 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004925 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004926 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004927 return a.normalize(context=self)
4928
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004929 def number_class(self, a):
4930 """Returns an indication of the class of the operand.
4931
4932 The class is one of the following strings:
4933 -sNaN
4934 -NaN
4935 -Infinity
4936 -Normal
4937 -Subnormal
4938 -Zero
4939 +Zero
4940 +Subnormal
4941 +Normal
4942 +Infinity
4943
4944 >>> c = Context(ExtendedContext)
4945 >>> c.Emin = -999
4946 >>> c.Emax = 999
4947 >>> c.number_class(Decimal('Infinity'))
4948 '+Infinity'
4949 >>> c.number_class(Decimal('1E-10'))
4950 '+Normal'
4951 >>> c.number_class(Decimal('2.50'))
4952 '+Normal'
4953 >>> c.number_class(Decimal('0.1E-999'))
4954 '+Subnormal'
4955 >>> c.number_class(Decimal('0'))
4956 '+Zero'
4957 >>> c.number_class(Decimal('-0'))
4958 '-Zero'
4959 >>> c.number_class(Decimal('-0.1E-999'))
4960 '-Subnormal'
4961 >>> c.number_class(Decimal('-1E-10'))
4962 '-Normal'
4963 >>> c.number_class(Decimal('-2.50'))
4964 '-Normal'
4965 >>> c.number_class(Decimal('-Infinity'))
4966 '-Infinity'
4967 >>> c.number_class(Decimal('NaN'))
4968 'NaN'
4969 >>> c.number_class(Decimal('-NaN'))
4970 'NaN'
4971 >>> c.number_class(Decimal('sNaN'))
4972 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004973 >>> c.number_class(123)
4974 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004975 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004976 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004977 return a.number_class(context=self)
4978
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004979 def plus(self, a):
4980 """Plus corresponds to unary prefix plus in Python.
4981
4982 The operation is evaluated using the same rules as add; the
4983 operation plus(a) is calculated as add('0', a) where the '0'
4984 has the same exponent as the operand.
4985
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004986 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004987 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004988 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004989 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004990 >>> ExtendedContext.plus(-1)
4991 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004992 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004993 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004994 return a.__pos__(context=self)
4995
4996 def power(self, a, b, modulo=None):
4997 """Raises a to the power of b, to modulo if given.
4998
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004999 With two arguments, compute a**b. If a is negative then b
5000 must be integral. The result will be inexact unless b is
5001 integral and the result is finite and can be expressed exactly
5002 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005003
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005004 With three arguments, compute (a**b) % modulo. For the
5005 three argument form, the following restrictions on the
5006 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005007
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005008 - all three arguments must be integral
5009 - b must be nonnegative
5010 - at least one of a or b must be nonzero
5011 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005012
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005013 The result of pow(a, b, modulo) is identical to the result
5014 that would be obtained by computing (a**b) % modulo with
5015 unbounded precision, but is computed more efficiently. It is
5016 always exact.
5017
5018 >>> c = ExtendedContext.copy()
5019 >>> c.Emin = -999
5020 >>> c.Emax = 999
5021 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005022 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005023 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005024 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005025 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005026 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005027 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005028 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005029 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005030 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005031 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005032 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005033 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005034 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005035 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005036 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005037 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005038 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005039 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005040 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005041 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005042 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005043 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005044 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005045 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005046 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005047
5048 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005049 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005050 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005051 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005052 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005053 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005054 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005055 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005056 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005057 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005058 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005059 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005060 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005061 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005062 >>> ExtendedContext.power(7, 7)
5063 Decimal('823543')
5064 >>> ExtendedContext.power(Decimal(7), 7)
5065 Decimal('823543')
5066 >>> ExtendedContext.power(7, Decimal(7), 2)
5067 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005068 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005069 a = _convert_other(a, raiseit=True)
5070 r = a.__pow__(b, modulo, context=self)
5071 if r is NotImplemented:
5072 raise TypeError("Unable to convert %s to Decimal" % b)
5073 else:
5074 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005075
5076 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005077 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005078
5079 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005080 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005081 exponent is being increased), multiplied by a positive power of ten (if
5082 the exponent is being decreased), or is unchanged (if the exponent is
5083 already equal to that of the right-hand operand).
5084
5085 Unlike other operations, if the length of the coefficient after the
5086 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005087 operation condition is raised. This guarantees that, unless there is
5088 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005089 equal to that of the right-hand operand.
5090
5091 Also unlike other operations, quantize will never raise Underflow, even
5092 if the result is subnormal and inexact.
5093
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005094 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005095 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005096 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005097 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005098 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005099 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005100 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005101 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005102 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005103 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005104 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005105 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005106 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005107 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005108 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005109 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005110 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005111 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005112 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005113 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005114 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005115 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005116 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005117 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005118 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005119 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005120 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005121 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005122 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005123 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005124 >>> ExtendedContext.quantize(1, 2)
5125 Decimal('1')
5126 >>> ExtendedContext.quantize(Decimal(1), 2)
5127 Decimal('1')
5128 >>> ExtendedContext.quantize(1, Decimal(2))
5129 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005130 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005131 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005132 return a.quantize(b, context=self)
5133
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005134 def radix(self):
5135 """Just returns 10, as this is Decimal, :)
5136
5137 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005138 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005139 """
5140 return Decimal(10)
5141
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005142 def remainder(self, a, b):
5143 """Returns the remainder from integer division.
5144
5145 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005146 calculating integer division as described for divide-integer, rounded
5147 to precision digits if necessary. The sign of the result, if
5148 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005149
5150 This operation will fail under the same conditions as integer division
5151 (that is, if integer division on the same two operands would fail, the
5152 remainder cannot be calculated).
5153
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005154 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005155 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005156 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005157 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005158 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005159 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005160 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005161 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005162 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005163 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005164 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005165 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005166 >>> ExtendedContext.remainder(22, 6)
5167 Decimal('4')
5168 >>> ExtendedContext.remainder(Decimal(22), 6)
5169 Decimal('4')
5170 >>> ExtendedContext.remainder(22, Decimal(6))
5171 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005172 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005173 a = _convert_other(a, raiseit=True)
5174 r = a.__mod__(b, context=self)
5175 if r is NotImplemented:
5176 raise TypeError("Unable to convert %s to Decimal" % b)
5177 else:
5178 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005179
5180 def remainder_near(self, a, b):
5181 """Returns to be "a - b * n", where n is the integer nearest the exact
5182 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005183 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005184 sign of a.
5185
5186 This operation will fail under the same conditions as integer division
5187 (that is, if integer division on the same two operands would fail, the
5188 remainder cannot be calculated).
5189
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005190 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005191 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005192 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005193 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005194 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005195 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005196 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005197 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005198 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005199 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005200 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005201 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005202 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005203 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005204 >>> ExtendedContext.remainder_near(3, 11)
5205 Decimal('3')
5206 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5207 Decimal('3')
5208 >>> ExtendedContext.remainder_near(3, Decimal(11))
5209 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005210 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005211 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005212 return a.remainder_near(b, context=self)
5213
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005214 def rotate(self, a, b):
5215 """Returns a rotated copy of a, b times.
5216
5217 The coefficient of the result is a rotated copy of the digits in
5218 the coefficient of the first operand. The number of places of
5219 rotation is taken from the absolute value of the second operand,
5220 with the rotation being to the left if the second operand is
5221 positive or to the right otherwise.
5222
5223 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005224 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005225 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005226 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005227 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005228 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005229 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005230 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005231 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005232 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005233 >>> ExtendedContext.rotate(1333333, 1)
5234 Decimal('13333330')
5235 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5236 Decimal('13333330')
5237 >>> ExtendedContext.rotate(1333333, Decimal(1))
5238 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005239 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005240 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005241 return a.rotate(b, context=self)
5242
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005243 def same_quantum(self, a, b):
5244 """Returns True if the two operands have the same exponent.
5245
5246 The result is never affected by either the sign or the coefficient of
5247 either operand.
5248
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005249 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005250 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005251 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005252 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005253 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005254 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005255 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005256 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005257 >>> ExtendedContext.same_quantum(10000, -1)
5258 True
5259 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5260 True
5261 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5262 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005263 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005264 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005265 return a.same_quantum(b)
5266
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005267 def scaleb (self, a, b):
5268 """Returns the first operand after adding the second value its exp.
5269
5270 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005271 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005272 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005273 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005274 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005275 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005276 >>> ExtendedContext.scaleb(1, 4)
5277 Decimal('1E+4')
5278 >>> ExtendedContext.scaleb(Decimal(1), 4)
5279 Decimal('1E+4')
5280 >>> ExtendedContext.scaleb(1, Decimal(4))
5281 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005282 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005283 a = _convert_other(a, raiseit=True)
5284 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005285
5286 def shift(self, a, b):
5287 """Returns a shifted copy of a, b times.
5288
5289 The coefficient of the result is a shifted copy of the digits
5290 in the coefficient of the first operand. The number of places
5291 to shift is taken from the absolute value of the second operand,
5292 with the shift being to the left if the second operand is
5293 positive or to the right otherwise. Digits shifted into the
5294 coefficient are zeros.
5295
5296 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005297 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005298 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005299 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005300 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005301 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005302 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005303 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005304 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005305 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005306 >>> ExtendedContext.shift(88888888, 2)
5307 Decimal('888888800')
5308 >>> ExtendedContext.shift(Decimal(88888888), 2)
5309 Decimal('888888800')
5310 >>> ExtendedContext.shift(88888888, Decimal(2))
5311 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005312 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005313 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005314 return a.shift(b, context=self)
5315
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005316 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005317 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005318
5319 If the result must be inexact, it is rounded using the round-half-even
5320 algorithm.
5321
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005322 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005323 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005324 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005325 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005326 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005327 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005328 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005329 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005330 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005331 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005332 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005333 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005334 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005335 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005336 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005337 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005338 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005339 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005340 >>> ExtendedContext.sqrt(2)
5341 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005342 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005343 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005344 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005345 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005346 return a.sqrt(context=self)
5347
5348 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005349 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005350
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005351 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005352 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005353 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005354 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005355 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005356 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005357 >>> ExtendedContext.subtract(8, 5)
5358 Decimal('3')
5359 >>> ExtendedContext.subtract(Decimal(8), 5)
5360 Decimal('3')
5361 >>> ExtendedContext.subtract(8, Decimal(5))
5362 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005363 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005364 a = _convert_other(a, raiseit=True)
5365 r = a.__sub__(b, context=self)
5366 if r is NotImplemented:
5367 raise TypeError("Unable to convert %s to Decimal" % b)
5368 else:
5369 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005370
5371 def to_eng_string(self, a):
5372 """Converts a number to a string, using scientific notation.
5373
5374 The operation is not affected by the context.
5375 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005376 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005377 return a.to_eng_string(context=self)
5378
5379 def to_sci_string(self, a):
5380 """Converts a number to a string, using scientific notation.
5381
5382 The operation is not affected by the context.
5383 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005384 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005385 return a.__str__(context=self)
5386
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005387 def to_integral_exact(self, a):
5388 """Rounds to an integer.
5389
5390 When the operand has a negative exponent, the result is the same
5391 as using the quantize() operation using the given operand as the
5392 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5393 of the operand as the precision setting; Inexact and Rounded flags
5394 are allowed in this operation. The rounding mode is taken from the
5395 context.
5396
5397 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005398 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005399 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005400 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005401 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005402 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005403 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005404 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005405 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005406 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005407 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005408 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005409 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005410 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005411 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005412 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005413 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005414 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005415 return a.to_integral_exact(context=self)
5416
5417 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005418 """Rounds to an integer.
5419
5420 When the operand has a negative exponent, the result is the same
5421 as using the quantize() operation using the given operand as the
5422 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5423 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005424 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005425
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005426 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005427 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005428 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005429 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005430 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005431 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005432 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005433 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005434 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005435 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005436 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005437 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005438 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005439 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005440 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005441 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005442 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005443 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005444 return a.to_integral_value(context=self)
5445
5446 # the method name changed, but we provide also the old one, for compatibility
5447 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005448
5449class _WorkRep(object):
5450 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005451 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005452 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005453 # exp: None, int, or string
5454
5455 def __init__(self, value=None):
5456 if value is None:
5457 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005458 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005459 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005460 elif isinstance(value, Decimal):
5461 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005462 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005463 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005464 else:
5465 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005466 self.sign = value[0]
5467 self.int = value[1]
5468 self.exp = value[2]
5469
5470 def __repr__(self):
5471 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5472
5473 __str__ = __repr__
5474
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005475
5476
Christian Heimes2c181612007-12-17 20:04:13 +00005477def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005478 """Normalizes op1, op2 to have the same exp and length of coefficient.
5479
5480 Done during addition.
5481 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005482 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005483 tmp = op2
5484 other = op1
5485 else:
5486 tmp = op1
5487 other = op2
5488
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005489 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5490 # Then adding 10**exp to tmp has the same effect (after rounding)
5491 # as adding any positive quantity smaller than 10**exp; similarly
5492 # for subtraction. So if other is smaller than 10**exp we replace
5493 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005494 tmp_len = len(str(tmp.int))
5495 other_len = len(str(other.int))
5496 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5497 if other_len + other.exp - 1 < exp:
5498 other.int = 1
5499 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005500
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005501 tmp.int *= 10 ** (tmp.exp - other.exp)
5502 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005503 return op1, op2
5504
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005505##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005506
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005507# This function from Tim Peters was taken from here:
5508# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5509# The correction being in the function definition is for speed, and
5510# the whole function is not resolved with math.log because of avoiding
5511# the use of floats.
5512def _nbits(n, correction = {
5513 '0': 4, '1': 3, '2': 2, '3': 2,
5514 '4': 1, '5': 1, '6': 1, '7': 1,
5515 '8': 0, '9': 0, 'a': 0, 'b': 0,
5516 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5517 """Number of bits in binary representation of the positive integer n,
5518 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005519 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005520 if n < 0:
5521 raise ValueError("The argument to _nbits should be nonnegative.")
5522 hex_n = "%x" % n
5523 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005524
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005525def _sqrt_nearest(n, a):
5526 """Closest integer to the square root of the positive integer n. a is
5527 an initial approximation to the square root. Any positive integer
5528 will do for a, but the closer a is to the square root of n the
5529 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005530
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005531 """
5532 if n <= 0 or a <= 0:
5533 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5534
5535 b=0
5536 while a != b:
5537 b, a = a, a--n//a>>1
5538 return a
5539
5540def _rshift_nearest(x, shift):
5541 """Given an integer x and a nonnegative integer shift, return closest
5542 integer to x / 2**shift; use round-to-even in case of a tie.
5543
5544 """
5545 b, q = 1 << shift, x >> shift
5546 return q + (2*(x & (b-1)) + (q&1) > b)
5547
5548def _div_nearest(a, b):
5549 """Closest integer to a/b, a and b positive integers; rounds to even
5550 in the case of a tie.
5551
5552 """
5553 q, r = divmod(a, b)
5554 return q + (2*r + (q&1) > b)
5555
5556def _ilog(x, M, L = 8):
5557 """Integer approximation to M*log(x/M), with absolute error boundable
5558 in terms only of x/M.
5559
5560 Given positive integers x and M, return an integer approximation to
5561 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5562 between the approximation and the exact result is at most 22. For
5563 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5564 both cases these are upper bounds on the error; it will usually be
5565 much smaller."""
5566
5567 # The basic algorithm is the following: let log1p be the function
5568 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5569 # the reduction
5570 #
5571 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5572 #
5573 # repeatedly until the argument to log1p is small (< 2**-L in
5574 # absolute value). For small y we can use the Taylor series
5575 # expansion
5576 #
5577 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5578 #
5579 # truncating at T such that y**T is small enough. The whole
5580 # computation is carried out in a form of fixed-point arithmetic,
5581 # with a real number z being represented by an integer
5582 # approximation to z*M. To avoid loss of precision, the y below
5583 # is actually an integer approximation to 2**R*y*M, where R is the
5584 # number of reductions performed so far.
5585
5586 y = x-M
5587 # argument reduction; R = number of reductions performed
5588 R = 0
5589 while (R <= L and abs(y) << L-R >= M or
5590 R > L and abs(y) >> R-L >= M):
5591 y = _div_nearest((M*y) << 1,
5592 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5593 R += 1
5594
5595 # Taylor series with T terms
5596 T = -int(-10*len(str(M))//(3*L))
5597 yshift = _rshift_nearest(y, R)
5598 w = _div_nearest(M, T)
5599 for k in range(T-1, 0, -1):
5600 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5601
5602 return _div_nearest(w*y, M)
5603
5604def _dlog10(c, e, p):
5605 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5606 approximation to 10**p * log10(c*10**e), with an absolute error of
5607 at most 1. Assumes that c*10**e is not exactly 1."""
5608
5609 # increase precision by 2; compensate for this by dividing
5610 # final result by 100
5611 p += 2
5612
5613 # write c*10**e as d*10**f with either:
5614 # f >= 0 and 1 <= d <= 10, or
5615 # f <= 0 and 0.1 <= d <= 1.
5616 # Thus for c*10**e close to 1, f = 0
5617 l = len(str(c))
5618 f = e+l - (e+l >= 1)
5619
5620 if p > 0:
5621 M = 10**p
5622 k = e+p-f
5623 if k >= 0:
5624 c *= 10**k
5625 else:
5626 c = _div_nearest(c, 10**-k)
5627
5628 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005629 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005630 log_d = _div_nearest(log_d*M, log_10)
5631 log_tenpower = f*M # exact
5632 else:
5633 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005634 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005635
5636 return _div_nearest(log_tenpower+log_d, 100)
5637
5638def _dlog(c, e, p):
5639 """Given integers c, e and p with c > 0, compute an integer
5640 approximation to 10**p * log(c*10**e), with an absolute error of
5641 at most 1. Assumes that c*10**e is not exactly 1."""
5642
5643 # Increase precision by 2. The precision increase is compensated
5644 # for at the end with a division by 100.
5645 p += 2
5646
5647 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5648 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5649 # as 10**p * log(d) + 10**p*f * log(10).
5650 l = len(str(c))
5651 f = e+l - (e+l >= 1)
5652
5653 # compute approximation to 10**p*log(d), with error < 27
5654 if p > 0:
5655 k = e+p-f
5656 if k >= 0:
5657 c *= 10**k
5658 else:
5659 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5660
5661 # _ilog magnifies existing error in c by a factor of at most 10
5662 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5663 else:
5664 # p <= 0: just approximate the whole thing by 0; error < 2.31
5665 log_d = 0
5666
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005667 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005668 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005669 extra = len(str(abs(f)))-1
5670 if p + extra >= 0:
5671 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5672 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5673 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005674 else:
5675 f_log_ten = 0
5676 else:
5677 f_log_ten = 0
5678
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005679 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005680 return _div_nearest(f_log_ten + log_d, 100)
5681
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005682class _Log10Memoize(object):
5683 """Class to compute, store, and allow retrieval of, digits of the
5684 constant log(10) = 2.302585.... This constant is needed by
5685 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5686 def __init__(self):
5687 self.digits = "23025850929940456840179914546843642076011014886"
5688
5689 def getdigits(self, p):
5690 """Given an integer p >= 0, return floor(10**p)*log(10).
5691
5692 For example, self.getdigits(3) returns 2302.
5693 """
5694 # digits are stored as a string, for quick conversion to
5695 # integer in the case that we've already computed enough
5696 # digits; the stored digits should always be correct
5697 # (truncated, not rounded to nearest).
5698 if p < 0:
5699 raise ValueError("p should be nonnegative")
5700
5701 if p >= len(self.digits):
5702 # compute p+3, p+6, p+9, ... digits; continue until at
5703 # least one of the extra digits is nonzero
5704 extra = 3
5705 while True:
5706 # compute p+extra digits, correct to within 1ulp
5707 M = 10**(p+extra+2)
5708 digits = str(_div_nearest(_ilog(10*M, M), 100))
5709 if digits[-extra:] != '0'*extra:
5710 break
5711 extra += 3
5712 # keep all reliable digits so far; remove trailing zeros
5713 # and next nonzero digit
5714 self.digits = digits.rstrip('0')[:-1]
5715 return int(self.digits[:p+1])
5716
5717_log10_digits = _Log10Memoize().getdigits
5718
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005719def _iexp(x, M, L=8):
5720 """Given integers x and M, M > 0, such that x/M is small in absolute
5721 value, compute an integer approximation to M*exp(x/M). For 0 <=
5722 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5723 is usually much smaller)."""
5724
5725 # Algorithm: to compute exp(z) for a real number z, first divide z
5726 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5727 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5728 # series
5729 #
5730 # expm1(x) = x + x**2/2! + x**3/3! + ...
5731 #
5732 # Now use the identity
5733 #
5734 # expm1(2x) = expm1(x)*(expm1(x)+2)
5735 #
5736 # R times to compute the sequence expm1(z/2**R),
5737 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5738
5739 # Find R such that x/2**R/M <= 2**-L
5740 R = _nbits((x<<L)//M)
5741
5742 # Taylor series. (2**L)**T > M
5743 T = -int(-10*len(str(M))//(3*L))
5744 y = _div_nearest(x, T)
5745 Mshift = M<<R
5746 for i in range(T-1, 0, -1):
5747 y = _div_nearest(x*(Mshift + y), Mshift * i)
5748
5749 # Expansion
5750 for k in range(R-1, -1, -1):
5751 Mshift = M<<(k+2)
5752 y = _div_nearest(y*(y+Mshift), Mshift)
5753
5754 return M+y
5755
5756def _dexp(c, e, p):
5757 """Compute an approximation to exp(c*10**e), with p decimal places of
5758 precision.
5759
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005760 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005761
5762 10**(p-1) <= d <= 10**p, and
5763 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5764
5765 In other words, d*10**f is an approximation to exp(c*10**e) with p
5766 digits of precision, and with an error in d of at most 1. This is
5767 almost, but not quite, the same as the error being < 1ulp: when d
5768 = 10**(p-1) the error could be up to 10 ulp."""
5769
5770 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5771 p += 2
5772
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005773 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005774 extra = max(0, e + len(str(c)) - 1)
5775 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005776
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005777 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005778 # rounding down
5779 shift = e+q
5780 if shift >= 0:
5781 cshift = c*10**shift
5782 else:
5783 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005784 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005785
5786 # reduce remainder back to original precision
5787 rem = _div_nearest(rem, 10**extra)
5788
5789 # error in result of _iexp < 120; error after division < 0.62
5790 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5791
5792def _dpower(xc, xe, yc, ye, p):
5793 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5794 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5795
5796 10**(p-1) <= c <= 10**p, and
5797 (c-1)*10**e < x**y < (c+1)*10**e
5798
5799 in other words, c*10**e is an approximation to x**y with p digits
5800 of precision, and with an error in c of at most 1. (This is
5801 almost, but not quite, the same as the error being < 1ulp: when c
5802 == 10**(p-1) we can only guarantee error < 10ulp.)
5803
5804 We assume that: x is positive and not equal to 1, and y is nonzero.
5805 """
5806
5807 # Find b such that 10**(b-1) <= |y| <= 10**b
5808 b = len(str(abs(yc))) + ye
5809
5810 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5811 lxc = _dlog(xc, xe, p+b+1)
5812
5813 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5814 shift = ye-b
5815 if shift >= 0:
5816 pc = lxc*yc*10**shift
5817 else:
5818 pc = _div_nearest(lxc*yc, 10**-shift)
5819
5820 if pc == 0:
5821 # we prefer a result that isn't exactly 1; this makes it
5822 # easier to compute a correctly rounded result in __pow__
5823 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5824 coeff, exp = 10**(p-1)+1, 1-p
5825 else:
5826 coeff, exp = 10**p-1, -p
5827 else:
5828 coeff, exp = _dexp(pc, -(p+1), p+1)
5829 coeff = _div_nearest(coeff, 10)
5830 exp += 1
5831
5832 return coeff, exp
5833
5834def _log10_lb(c, correction = {
5835 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5836 '6': 23, '7': 16, '8': 10, '9': 5}):
5837 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5838 if c <= 0:
5839 raise ValueError("The argument to _log10_lb should be nonnegative.")
5840 str_c = str(c)
5841 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005842
Guido van Rossumd8faa362007-04-27 19:54:29 +00005843##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005844
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005845def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005846 """Convert other to Decimal.
5847
5848 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005849 If allow_float is true, allow conversion from float; this
5850 is used in the comparison methods (__eq__ and friends).
5851
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005852 """
5853 if isinstance(other, Decimal):
5854 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005855 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005856 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005857 if allow_float and isinstance(other, float):
5858 return Decimal.from_float(other)
5859
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005860 if raiseit:
5861 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005862 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005863
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005864def _convert_for_comparison(self, other, equality_op=False):
5865 """Given a Decimal instance self and a Python object other, return
Mark Dickinson1c164a62010-06-11 16:49:20 +00005866 a pair (s, o) of Decimal instances such that "s op o" is
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005867 equivalent to "self op other" for any of the 6 comparison
5868 operators "op".
5869
5870 """
5871 if isinstance(other, Decimal):
5872 return self, other
5873
5874 # Comparison with a Rational instance (also includes integers):
5875 # self op n/d <=> self*d op n (for n and d integers, d positive).
5876 # A NaN or infinity can be left unchanged without affecting the
5877 # comparison result.
5878 if isinstance(other, _numbers.Rational):
5879 if not self._is_special:
5880 self = _dec_from_triple(self._sign,
5881 str(int(self._int) * other.denominator),
5882 self._exp)
5883 return self, Decimal(other.numerator)
5884
5885 # Comparisons with float and complex types. == and != comparisons
5886 # with complex numbers should succeed, returning either True or False
5887 # as appropriate. Other comparisons return NotImplemented.
5888 if equality_op and isinstance(other, _numbers.Complex) and other.imag == 0:
5889 other = other.real
5890 if isinstance(other, float):
5891 return self, Decimal.from_float(other)
5892 return NotImplemented, NotImplemented
5893
5894
Guido van Rossumd8faa362007-04-27 19:54:29 +00005895##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005896
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005897# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005898# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005899
5900DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005901 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005902 traps=[DivisionByZero, Overflow, InvalidOperation],
5903 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005904 Emax=999999999,
5905 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005906 capitals=1,
5907 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005908)
5909
5910# Pre-made alternate contexts offered by the specification
5911# Don't change these; the user should be able to select these
5912# contexts and be able to reproduce results from other implementations
5913# of the spec.
5914
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005915BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005916 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005917 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5918 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005919)
5920
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005921ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005922 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005923 traps=[],
5924 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005925)
5926
5927
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005928##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005929#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005930# Regular expression used for parsing numeric strings. Additional
5931# comments:
5932#
5933# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5934# whitespace. But note that the specification disallows whitespace in
5935# a numeric string.
5936#
5937# 2. For finite numbers (not infinities and NaNs) the body of the
5938# number between the optional sign and the optional exponent must have
5939# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005940# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005941
5942import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005943_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005944# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005945 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005946 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005947 (?=\d|\.\d) # ...a number (with at least one digit)
5948 (?P<int>\d*) # having a (possibly empty) integer part
5949 (\.(?P<frac>\d*))? # followed by an optional fractional part
5950 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005951 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005952 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005953 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005954 (?P<signal>s)? # ...an (optionally signaling)
5955 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005956 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005957 )
5958# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005959 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005960""", re.VERBOSE | re.IGNORECASE).match
5961
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005962_all_zeros = re.compile('0*$').match
5963_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005964
5965##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005966# The functions in this section have little to do with the Decimal
5967# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005968# Python numeric classes that want to implement __format__
5969#
5970# A format specifier for Decimal looks like:
5971#
Mark Dickinson79f52032009-03-17 23:12:51 +00005972# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005973
5974_parse_format_specifier_regex = re.compile(r"""\A
5975(?:
5976 (?P<fill>.)?
5977 (?P<align>[<>=^])
5978)?
5979(?P<sign>[-+ ])?
5980(?P<zeropad>0)?
5981(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005982(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005983(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005984(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005985\Z
5986""", re.VERBOSE)
5987
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005988del re
5989
Mark Dickinson79f52032009-03-17 23:12:51 +00005990# The locale module is only needed for the 'n' format specifier. The
5991# rest of the PEP 3101 code functions quite happily without it, so we
5992# don't care too much if locale isn't present.
5993try:
5994 import locale as _locale
5995except ImportError:
5996 pass
5997
5998def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005999 """Parse and validate a format specifier.
6000
6001 Turns a standard numeric format specifier into a dict, with the
6002 following entries:
6003
6004 fill: fill character to pad field to minimum width
6005 align: alignment type, either '<', '>', '=' or '^'
6006 sign: either '+', '-' or ' '
6007 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006008 zeropad: boolean, indicating whether to pad with zeros
6009 thousands_sep: string to use as thousands separator, or ''
6010 grouping: grouping for thousands separators, in format
6011 used by localeconv
6012 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006013 precision: nonnegative integer giving precision, or None
6014 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006015
6016 """
6017 m = _parse_format_specifier_regex.match(format_spec)
6018 if m is None:
6019 raise ValueError("Invalid format specifier: " + format_spec)
6020
6021 # get the dictionary
6022 format_dict = m.groupdict()
6023
Mark Dickinson79f52032009-03-17 23:12:51 +00006024 # zeropad; defaults for fill and alignment. If zero padding
6025 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006026 fill = format_dict['fill']
6027 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006028 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6029 if format_dict['zeropad']:
6030 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006031 raise ValueError("Fill character conflicts with '0'"
6032 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006033 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006034 raise ValueError("Alignment conflicts with '0' in "
6035 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006036 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006037 # PEP 3101 originally specified that the default alignment should
6038 # be left; it was later agreed that right-aligned makes more sense
6039 # for numeric types. See http://bugs.python.org/issue6857.
6040 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006041
Mark Dickinson79f52032009-03-17 23:12:51 +00006042 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006043 if format_dict['sign'] is None:
6044 format_dict['sign'] = '-'
6045
Christian Heimesf16baeb2008-02-29 14:57:44 +00006046 # minimumwidth defaults to 0; precision remains None if not given
6047 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6048 if format_dict['precision'] is not None:
6049 format_dict['precision'] = int(format_dict['precision'])
6050
6051 # if format type is 'g' or 'G' then a precision of 0 makes little
6052 # sense; convert it to 1. Same if format type is unspecified.
6053 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006054 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006055 format_dict['precision'] = 1
6056
Mark Dickinson79f52032009-03-17 23:12:51 +00006057 # determine thousands separator, grouping, and decimal separator, and
6058 # add appropriate entries to format_dict
6059 if format_dict['type'] == 'n':
6060 # apart from separators, 'n' behaves just like 'g'
6061 format_dict['type'] = 'g'
6062 if _localeconv is None:
6063 _localeconv = _locale.localeconv()
6064 if format_dict['thousands_sep'] is not None:
6065 raise ValueError("Explicit thousands separator conflicts with "
6066 "'n' type in format specifier: " + format_spec)
6067 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6068 format_dict['grouping'] = _localeconv['grouping']
6069 format_dict['decimal_point'] = _localeconv['decimal_point']
6070 else:
6071 if format_dict['thousands_sep'] is None:
6072 format_dict['thousands_sep'] = ''
6073 format_dict['grouping'] = [3, 0]
6074 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006075
6076 return format_dict
6077
Mark Dickinson79f52032009-03-17 23:12:51 +00006078def _format_align(sign, body, spec):
6079 """Given an unpadded, non-aligned numeric string 'body' and sign
6080 string 'sign', add padding and aligment conforming to the given
6081 format specifier dictionary 'spec' (as produced by
6082 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006083
6084 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006085 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006086 minimumwidth = spec['minimumwidth']
6087 fill = spec['fill']
6088 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006089
Mark Dickinson79f52032009-03-17 23:12:51 +00006090 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006091 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006092 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006093 elif align == '>':
6094 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006095 elif align == '=':
6096 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006097 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006098 half = len(padding)//2
6099 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006100 else:
6101 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006102
Christian Heimesf16baeb2008-02-29 14:57:44 +00006103 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006104
Mark Dickinson79f52032009-03-17 23:12:51 +00006105def _group_lengths(grouping):
6106 """Convert a localeconv-style grouping into a (possibly infinite)
6107 iterable of integers representing group lengths.
6108
6109 """
6110 # The result from localeconv()['grouping'], and the input to this
6111 # function, should be a list of integers in one of the
6112 # following three forms:
6113 #
6114 # (1) an empty list, or
6115 # (2) nonempty list of positive integers + [0]
6116 # (3) list of positive integers + [locale.CHAR_MAX], or
6117
6118 from itertools import chain, repeat
6119 if not grouping:
6120 return []
6121 elif grouping[-1] == 0 and len(grouping) >= 2:
6122 return chain(grouping[:-1], repeat(grouping[-2]))
6123 elif grouping[-1] == _locale.CHAR_MAX:
6124 return grouping[:-1]
6125 else:
6126 raise ValueError('unrecognised format for grouping')
6127
6128def _insert_thousands_sep(digits, spec, min_width=1):
6129 """Insert thousands separators into a digit string.
6130
6131 spec is a dictionary whose keys should include 'thousands_sep' and
6132 'grouping'; typically it's the result of parsing the format
6133 specifier using _parse_format_specifier.
6134
6135 The min_width keyword argument gives the minimum length of the
6136 result, which will be padded on the left with zeros if necessary.
6137
6138 If necessary, the zero padding adds an extra '0' on the left to
6139 avoid a leading thousands separator. For example, inserting
6140 commas every three digits in '123456', with min_width=8, gives
6141 '0,123,456', even though that has length 9.
6142
6143 """
6144
6145 sep = spec['thousands_sep']
6146 grouping = spec['grouping']
6147
6148 groups = []
6149 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006150 if l <= 0:
6151 raise ValueError("group length should be positive")
6152 # max(..., 1) forces at least 1 digit to the left of a separator
6153 l = min(max(len(digits), min_width, 1), l)
6154 groups.append('0'*(l - len(digits)) + digits[-l:])
6155 digits = digits[:-l]
6156 min_width -= l
6157 if not digits and min_width <= 0:
6158 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006159 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006160 else:
6161 l = max(len(digits), min_width, 1)
6162 groups.append('0'*(l - len(digits)) + digits[-l:])
6163 return sep.join(reversed(groups))
6164
6165def _format_sign(is_negative, spec):
6166 """Determine sign character."""
6167
6168 if is_negative:
6169 return '-'
6170 elif spec['sign'] in ' +':
6171 return spec['sign']
6172 else:
6173 return ''
6174
6175def _format_number(is_negative, intpart, fracpart, exp, spec):
6176 """Format a number, given the following data:
6177
6178 is_negative: true if the number is negative, else false
6179 intpart: string of digits that must appear before the decimal point
6180 fracpart: string of digits that must come after the point
6181 exp: exponent, as an integer
6182 spec: dictionary resulting from parsing the format specifier
6183
6184 This function uses the information in spec to:
6185 insert separators (decimal separator and thousands separators)
6186 format the sign
6187 format the exponent
6188 add trailing '%' for the '%' type
6189 zero-pad if necessary
6190 fill and align if necessary
6191 """
6192
6193 sign = _format_sign(is_negative, spec)
6194
6195 if fracpart:
6196 fracpart = spec['decimal_point'] + fracpart
6197
6198 if exp != 0 or spec['type'] in 'eE':
6199 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6200 fracpart += "{0}{1:+}".format(echar, exp)
6201 if spec['type'] == '%':
6202 fracpart += '%'
6203
6204 if spec['zeropad']:
6205 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6206 else:
6207 min_width = 0
6208 intpart = _insert_thousands_sep(intpart, spec, min_width)
6209
6210 return _format_align(sign, intpart+fracpart, spec)
6211
6212
Guido van Rossumd8faa362007-04-27 19:54:29 +00006213##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006214
Guido van Rossumd8faa362007-04-27 19:54:29 +00006215# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006216_Infinity = Decimal('Inf')
6217_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006218_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006219_Zero = Decimal(0)
6220_One = Decimal(1)
6221_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006222
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006223# _SignedInfinity[sign] is infinity w/ that sign
6224_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006225
Mark Dickinsondc787d22010-05-23 13:33:13 +00006226# Constants related to the hash implementation; hash(x) is based
6227# on the reduction of x modulo _PyHASH_MODULUS
6228import sys
6229_PyHASH_MODULUS = sys.hash_info.modulus
6230# hash values to use for positive and negative infinities, and nans
6231_PyHASH_INF = sys.hash_info.inf
6232_PyHASH_NAN = sys.hash_info.nan
6233del sys
6234
6235# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6236_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006237
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006238
6239if __name__ == '__main__':
6240 import doctest, sys
6241 doctest.testmod(sys.modules[__name__])