blob: 83933651d21ab8a2a220f33365a3b00ad784d5f5 [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingera016deb2009-04-27 21:12:27 +0000137__version__ = '1.70' # Highest version of the spec this complies with
Raymond Hettingerdaeceb22009-03-10 04:49:21 +0000138
Raymond Hettingereb260842005-06-07 18:52:34 +0000139import copy as _copy
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000140import math as _math
Raymond Hettinger2c8585b2009-02-03 03:37:03 +0000141import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000142
Raymond Hettinger097a1902008-01-11 02:24:13 +0000143try:
144 from collections import namedtuple as _namedtuple
145 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
146except ImportError:
147 DecimalTuple = lambda *args: args
148
Facundo Batista59c58842007-04-10 12:58:45 +0000149# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000150ROUND_DOWN = 'ROUND_DOWN'
151ROUND_HALF_UP = 'ROUND_HALF_UP'
152ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
153ROUND_CEILING = 'ROUND_CEILING'
154ROUND_FLOOR = 'ROUND_FLOOR'
155ROUND_UP = 'ROUND_UP'
156ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000157ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000158
Facundo Batista59c58842007-04-10 12:58:45 +0000159# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000162 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000163
164 Used exceptions derive from this.
165 If an exception derives from another exception besides this (such as
166 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
167 called if the others are present. This isn't actually used for
168 anything, though.
169
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000170 handle -- Called when context._raise_error is called and the
171 trap_enabler is set. First argument is self, second is the
172 context. More arguments can be given, those being after
173 the explanation in _raise_error (For example,
174 context._raise_error(NewError, '(-x)!', self._sign) would
175 call NewError().handle(context, self._sign).)
176
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 To define a new exception, it should be sufficient to have it derive
178 from DecimalException.
179 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000180 def handle(self, context, *args):
181 pass
182
183
184class Clamped(DecimalException):
185 """Exponent of a 0 changed to fit bounds.
186
187 This occurs and signals clamped if the exponent of a result has been
188 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000189 representation. This may occur when the exponent of a zero result would
190 be outside the bounds of a representation, or when a large normal
191 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192 this latter case, the exponent is reduced to fit and the corresponding
193 number of zero digits are appended to the coefficient ("fold-down").
194 """
195
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000196class InvalidOperation(DecimalException):
197 """An invalid operation was performed.
198
199 Various bad things cause this:
200
201 Something creates a signaling NaN
202 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000203 0 * (+-)INF
204 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000205 x % 0
206 (+-)INF % x
207 x._rescale( non-integer )
208 sqrt(-x) , x > 0
209 0 ** 0
210 x ** (non-integer)
211 x ** (+-)INF
212 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000213
214 The result of the operation after these is a quiet positive NaN,
215 except when the cause is a signaling NaN, in which case the result is
216 also a quiet NaN, but with the original sign, and an optional
217 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000218 """
219 def handle(self, context, *args):
220 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000221 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
222 return ans._fix_nan(context)
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000223 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000224
225class ConversionSyntax(InvalidOperation):
226 """Trying to convert badly formed string.
227
228 This occurs and signals invalid-operation if an string is being
229 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000230 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000232 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000233 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000234
235class DivisionByZero(DecimalException, ZeroDivisionError):
236 """Division by 0.
237
238 This occurs and signals division-by-zero if division of a finite number
239 by zero was attempted (during a divide-integer or divide operation, or a
240 power operation with negative right-hand operand), and the dividend was
241 not zero.
242
243 The result of the operation is [sign,inf], where sign is the exclusive
244 or of the signs of the operands for divide, or is 1 for an odd power of
245 -0, for power.
246 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000247
Facundo Batistacce8df22007-09-18 16:53:18 +0000248 def handle(self, context, sign, *args):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000249 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000250
251class DivisionImpossible(InvalidOperation):
252 """Cannot perform the division adequately.
253
254 This occurs and signals invalid-operation if the integer result of a
255 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000256 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000258
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000259 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000260 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000261
262class DivisionUndefined(InvalidOperation, ZeroDivisionError):
263 """Undefined result of division.
264
265 This occurs and signals invalid-operation if division by zero was
266 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000267 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000269
Facundo Batistacce8df22007-09-18 16:53:18 +0000270 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000271 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000272
273class Inexact(DecimalException):
274 """Had to round, losing information.
275
276 This occurs and signals inexact whenever the result of an operation is
277 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000278 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000279 result in all cases is unchanged.
280
281 The inexact signal may be tested (or trapped) to determine if a given
282 operation (or sequence of operations) was inexact.
283 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000284
285class InvalidContext(InvalidOperation):
286 """Invalid context. Unknown rounding, for example.
287
288 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000289 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 on creation and either the precision exceeds the capability of the
291 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000292 was specified. These aspects of the context need only be checked when
293 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000296 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000297 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000298
299class Rounded(DecimalException):
300 """Number got rounded (not necessarily changed during rounding).
301
302 This occurs and signals rounded whenever the result of an operation is
303 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000304 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000305 result in all cases is unchanged.
306
307 The rounded signal may be tested (or trapped) to determine if a given
308 operation (or sequence of operations) caused a loss of precision.
309 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000310
311class Subnormal(DecimalException):
312 """Exponent < Emin before rounding.
313
314 This occurs and signals subnormal whenever the result of a conversion or
315 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000316 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318 The subnormal signal may be tested (or trapped) to determine if a given
319 or operation (or sequence of operations) yielded a subnormal result.
320 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000321
322class Overflow(Inexact, Rounded):
323 """Numerical overflow.
324
325 This occurs and signals overflow if the adjusted exponent of a result
326 (from a conversion or from an operation that is not an attempt to divide
327 by zero), after rounding, would be greater than the largest value that
328 can be handled by the implementation (the value Emax).
329
330 The result depends on the rounding mode:
331
332 For round-half-up and round-half-even (and for round-half-down and
333 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000334 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000336 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000338 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000340 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000342 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 def handle(self, context, sign, *args):
345 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000346 ROUND_HALF_DOWN, ROUND_UP):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000347 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000348 if sign == 0:
349 if context.rounding == ROUND_CEILING:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000350 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000351 return _dec_from_triple(sign, '9'*context.prec,
352 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000353 if sign == 1:
354 if context.rounding == ROUND_FLOOR:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000355 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000356 return _dec_from_triple(sign, '9'*context.prec,
357 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000358
359
360class Underflow(Inexact, Rounded, Subnormal):
361 """Numerical underflow with result rounded to 0.
362
363 This occurs and signals underflow if a result is inexact and the
364 adjusted exponent of the result would be smaller (more negative) than
365 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000366 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367
368 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000369 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000370 in 0 with the sign of the intermediate result and an exponent of Etiny.
371
372 In all cases, Inexact, Rounded, and Subnormal will also be raised.
373 """
374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000376_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000377 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000378
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000379# Map conditions (per the spec) to signals
380_condition_map = {ConversionSyntax:InvalidOperation,
381 DivisionImpossible:InvalidOperation,
382 DivisionUndefined:InvalidOperation,
383 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000384
Facundo Batista59c58842007-04-10 12:58:45 +0000385##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000386
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000387# The getcontext() and setcontext() function manage access to a thread-local
388# current context. Py2.4 offers direct support for thread locals. If that
389# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000390# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000391# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000392
393try:
394 import threading
395except ImportError:
396 # Python was compiled without threads; create a mock object instead
397 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000398 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000399 def local(self, sys=sys):
400 return sys.modules[__name__]
401 threading = MockThreading()
402 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404try:
405 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000406
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000407except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000408
Facundo Batista59c58842007-04-10 12:58:45 +0000409 # To fix reloading, force it to create a new context
410 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000411 if hasattr(threading.currentThread(), '__decimal_context__'):
412 del threading.currentThread().__decimal_context__
413
414 def setcontext(context):
415 """Set this thread's context to context."""
416 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000417 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000418 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000419 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000420
421 def getcontext():
422 """Returns this thread's context.
423
424 If this thread does not yet have a context, returns
425 a new context and sets this thread's context.
426 New contexts are copies of DefaultContext.
427 """
428 try:
429 return threading.currentThread().__decimal_context__
430 except AttributeError:
431 context = Context()
432 threading.currentThread().__decimal_context__ = context
433 return context
434
435else:
436
437 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000438 if hasattr(local, '__decimal_context__'):
439 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000440
441 def getcontext(_local=local):
442 """Returns this thread's context.
443
444 If this thread does not yet have a context, returns
445 a new context and sets this thread's context.
446 New contexts are copies of DefaultContext.
447 """
448 try:
449 return _local.__decimal_context__
450 except AttributeError:
451 context = Context()
452 _local.__decimal_context__ = context
453 return context
454
455 def setcontext(context, _local=local):
456 """Set this thread's context to context."""
457 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000458 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000459 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000460 _local.__decimal_context__ = context
461
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000462 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000463
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000464def localcontext(ctx=None):
465 """Return a context manager for a copy of the supplied context
466
467 Uses a copy of the current context if no context is specified
468 The returned context manager creates a local decimal context
469 in a with statement:
470 def sin(x):
471 with localcontext() as ctx:
472 ctx.prec += 2
473 # Rest of sin calculation algorithm
474 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000475 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000476
477 def sin(x):
478 with localcontext(ExtendedContext):
479 # Rest of sin calculation algorithm
480 # uses the Extended Context from the
481 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000482 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000483
Facundo Batistaee340e52008-05-02 17:39:00 +0000484 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000485 >>> print getcontext().prec
486 28
487 >>> with localcontext():
488 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000489 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000490 ... print ctx.prec
491 ...
492 30
493 >>> with localcontext(ExtendedContext):
494 ... print getcontext().prec
495 ...
496 9
497 >>> print getcontext().prec
498 28
499 """
Nick Coghlanced12182006-09-02 03:54:17 +0000500 if ctx is None: ctx = getcontext()
501 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000502
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000503
Facundo Batista59c58842007-04-10 12:58:45 +0000504##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000505
506class Decimal(object):
507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000519 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000521 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000522 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000525 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Facundo Batista72bc54f2007-11-23 17:59:00 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Facundo Batista0d157a02007-11-30 17:15:25 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000543 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Facundo Batista0d157a02007-11-30 17:15:25 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson4326ad82009-08-02 10:59:36 +0000557 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson4326ad82009-08-02 10:59:36 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000579 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000585 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000636 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], (int, long)):
640 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000641 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
651 raise TypeError("Cannot convert float to Decimal. " +
652 "First convert the float to a string")
653
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000654 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000655
Mark Dickinson6a961632009-01-04 21:10:56 +0000656 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
657 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000658 def from_float(cls, f):
659 """Converts a float to a decimal number, exactly.
660
661 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
662 Since 0.1 is not exactly representable in binary floating point, the
663 value is stored as the nearest representable value which is
664 0x1.999999999999ap-4. The exact equivalent of the value in decimal
665 is 0.1000000000000000055511151231257827021181583404541015625.
666
667 >>> Decimal.from_float(0.1)
668 Decimal('0.1000000000000000055511151231257827021181583404541015625')
669 >>> Decimal.from_float(float('nan'))
670 Decimal('NaN')
671 >>> Decimal.from_float(float('inf'))
672 Decimal('Infinity')
673 >>> Decimal.from_float(-float('inf'))
674 Decimal('-Infinity')
675 >>> Decimal.from_float(-0.0)
676 Decimal('-0')
677
678 """
679 if isinstance(f, (int, long)): # handle integer inputs
680 return cls(f)
681 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
682 return cls(repr(f))
Mark Dickinson6a961632009-01-04 21:10:56 +0000683 if _math.copysign(1.0, f) == 1.0:
684 sign = 0
685 else:
686 sign = 1
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000687 n, d = abs(f).as_integer_ratio()
688 k = d.bit_length() - 1
689 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinson6a961632009-01-04 21:10:56 +0000690 if cls is Decimal:
691 return result
692 else:
693 return cls(result)
694 from_float = classmethod(from_float)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000695
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000696 def _isnan(self):
697 """Returns whether the number is not actually one.
698
699 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000700 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 2 if sNaN
702 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000703 if self._is_special:
704 exp = self._exp
705 if exp == 'n':
706 return 1
707 elif exp == 'N':
708 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000709 return 0
710
711 def _isinfinity(self):
712 """Returns whether the number is infinite
713
714 0 if finite or not a number
715 1 if +INF
716 -1 if -INF
717 """
718 if self._exp == 'F':
719 if self._sign:
720 return -1
721 return 1
722 return 0
723
Facundo Batista353750c2007-09-13 18:13:15 +0000724 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000725 """Returns whether the number is not actually one.
726
727 if self, other are sNaN, signal
728 if self, other are NaN return nan
729 return 0
730
731 Done before operations.
732 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000733
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000734 self_is_nan = self._isnan()
735 if other is None:
736 other_is_nan = False
737 else:
738 other_is_nan = other._isnan()
739
740 if self_is_nan or other_is_nan:
741 if context is None:
742 context = getcontext()
743
744 if self_is_nan == 2:
745 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000746 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000747 if other_is_nan == 2:
748 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000749 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000750 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000751 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752
Facundo Batista353750c2007-09-13 18:13:15 +0000753 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000754 return 0
755
Mark Dickinson2fc92632008-02-06 22:10:50 +0000756 def _compare_check_nans(self, other, context):
757 """Version of _check_nans used for the signaling comparisons
758 compare_signal, __le__, __lt__, __ge__, __gt__.
759
760 Signal InvalidOperation if either self or other is a (quiet
761 or signaling) NaN. Signaling NaNs take precedence over quiet
762 NaNs.
763
764 Return 0 if neither operand is a NaN.
765
766 """
767 if context is None:
768 context = getcontext()
769
770 if self._is_special or other._is_special:
771 if self.is_snan():
772 return context._raise_error(InvalidOperation,
773 'comparison involving sNaN',
774 self)
775 elif other.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 other)
779 elif self.is_qnan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving NaN',
782 self)
783 elif other.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 other)
787 return 0
788
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000789 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000790 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000791
Facundo Batista1a191df2007-10-02 17:01:24 +0000792 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000794 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Mark Dickinson2fc92632008-02-06 22:10:50 +0000796 def _cmp(self, other):
797 """Compare the two non-NaN decimal instances self and other.
798
799 Returns -1 if self < other, 0 if self == other and 1
800 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000801
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000802 if self._is_special or other._is_special:
Mark Dickinsone52c3142009-01-25 10:39:15 +0000803 self_inf = self._isinfinity()
804 other_inf = other._isinfinity()
805 if self_inf == other_inf:
806 return 0
807 elif self_inf < other_inf:
808 return -1
809 else:
810 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000811
Mark Dickinsone52c3142009-01-25 10:39:15 +0000812 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000813 if not self:
814 if not other:
815 return 0
816 else:
817 return -((-1)**other._sign)
818 if not other:
819 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000820
Facundo Batista59c58842007-04-10 12:58:45 +0000821 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000822 if other._sign < self._sign:
823 return -1
824 if self._sign < other._sign:
825 return 1
826
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000827 self_adjusted = self.adjusted()
828 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000829 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000830 self_padded = self._int + '0'*(self._exp - other._exp)
831 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone52c3142009-01-25 10:39:15 +0000832 if self_padded == other_padded:
833 return 0
834 elif self_padded < other_padded:
835 return -(-1)**self._sign
836 else:
837 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000838 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000839 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000840 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000841 return -((-1)**self._sign)
842
Mark Dickinson2fc92632008-02-06 22:10:50 +0000843 # Note: The Decimal standard doesn't cover rich comparisons for
844 # Decimals. In particular, the specification is silent on the
845 # subject of what should happen for a comparison involving a NaN.
846 # We take the following approach:
847 #
848 # == comparisons involving a NaN always return False
849 # != comparisons involving a NaN always return True
850 # <, >, <= and >= comparisons involving a (quiet or signaling)
851 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000852 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000853 #
854 # This behavior is designed to conform as closely as possible to
855 # that specified by IEEE 754.
856
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000857 def __eq__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 if self.is_nan() or other.is_nan():
862 return False
863 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000864
865 def __ne__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000866 other = _convert_other(other)
867 if other is NotImplemented:
868 return other
869 if self.is_nan() or other.is_nan():
870 return True
871 return self._cmp(other) != 0
872
873 def __lt__(self, other, context=None):
874 other = _convert_other(other)
875 if other is NotImplemented:
876 return other
877 ans = self._compare_check_nans(other, context)
878 if ans:
879 return False
880 return self._cmp(other) < 0
881
882 def __le__(self, other, context=None):
883 other = _convert_other(other)
884 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
890
891 def __gt__(self, other, context=None):
892 other = _convert_other(other)
893 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
899
900 def __ge__(self, other, context=None):
901 other = _convert_other(other)
902 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
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000908
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000909 def compare(self, other, context=None):
910 """Compares one to another.
911
912 -1 => a < b
913 0 => a = b
914 1 => a > b
915 NaN => one is NaN
916 Like __cmp__, but returns Decimal instances.
917 """
Facundo Batista353750c2007-09-13 18:13:15 +0000918 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000919
Facundo Batista59c58842007-04-10 12:58:45 +0000920 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000921 if (self._is_special or other and other._is_special):
922 ans = self._check_nans(other, context)
923 if ans:
924 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000925
Mark Dickinson2fc92632008-02-06 22:10:50 +0000926 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000927
928 def __hash__(self):
929 """x.__hash__() <==> hash(x)"""
930 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000931 #
932 # The hash of a nonspecial noninteger Decimal must depend only
933 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000934 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000935 if self._is_special:
936 if self._isnan():
937 raise TypeError('Cannot hash a NaN value.')
938 return hash(str(self))
Facundo Batista8c202442007-09-19 17:53:25 +0000939 if not self:
940 return 0
941 if self._isinteger():
942 op = _WorkRep(self.to_integral_value())
943 # to make computation feasible for Decimals with large
944 # exponent, we use the fact that hash(n) == hash(m) for
945 # any two nonzero integers n and m such that (i) n and m
946 # have the same sign, and (ii) n is congruent to m modulo
947 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
948 # hash((-1)**s*c*pow(10, e, 2**64-1).
949 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000950 # The value of a nonzero nonspecial Decimal instance is
951 # faithfully represented by the triple consisting of its sign,
952 # its adjusted exponent, and its coefficient with trailing
953 # zeros removed.
954 return hash((self._sign,
955 self._exp+len(self._int),
956 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000957
958 def as_tuple(self):
959 """Represents the number as a triple tuple.
960
961 To show the internals exactly as they are.
962 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000963 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000964
965 def __repr__(self):
966 """Represents the number as an instance of Decimal."""
967 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000968 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000969
Facundo Batista353750c2007-09-13 18:13:15 +0000970 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971 """Return string representation of the number in scientific notation.
972
973 Captures all of the information in the underlying representation.
974 """
975
Facundo Batista62edb712007-12-03 16:29:52 +0000976 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000977 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +0000978 if self._exp == 'F':
979 return sign + 'Infinity'
980 elif self._exp == 'n':
981 return sign + 'NaN' + self._int
982 else: # self._exp == 'N'
983 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000984
Facundo Batista62edb712007-12-03 16:29:52 +0000985 # number of digits of self._int to left of decimal point
986 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000987
Facundo Batista62edb712007-12-03 16:29:52 +0000988 # dotplace is number of digits of self._int to the left of the
989 # decimal point in the mantissa of the output string (that is,
990 # after adjusting the exponent)
991 if self._exp <= 0 and leftdigits > -6:
992 # no exponent required
993 dotplace = leftdigits
994 elif not eng:
995 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000996 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +0000997 elif self._int == '0':
998 # engineering notation, zero
999 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 else:
Facundo Batista62edb712007-12-03 16:29:52 +00001001 # engineering notation, nonzero
1002 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001003
Facundo Batista62edb712007-12-03 16:29:52 +00001004 if dotplace <= 0:
1005 intpart = '0'
1006 fracpart = '.' + '0'*(-dotplace) + self._int
1007 elif dotplace >= len(self._int):
1008 intpart = self._int+'0'*(dotplace-len(self._int))
1009 fracpart = ''
1010 else:
1011 intpart = self._int[:dotplace]
1012 fracpart = '.' + self._int[dotplace:]
1013 if leftdigits == dotplace:
1014 exp = ''
1015 else:
1016 if context is None:
1017 context = getcontext()
1018 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1019
1020 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001021
1022 def to_eng_string(self, context=None):
1023 """Convert to engineering-type string.
1024
1025 Engineering notation has an exponent which is a multiple of 3, so there
1026 are up to 3 digits left of the decimal place.
1027
1028 Same rules for when in exponential and when as a value as in __str__.
1029 """
Facundo Batista353750c2007-09-13 18:13:15 +00001030 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001031
1032 def __neg__(self, context=None):
1033 """Returns a copy with the sign switched.
1034
1035 Rounds, if it has reason.
1036 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001037 if self._is_special:
1038 ans = self._check_nans(context=context)
1039 if ans:
1040 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001041
1042 if not self:
1043 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001044 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001045 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001046 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001047
1048 if context is None:
1049 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001050 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001051
1052 def __pos__(self, context=None):
1053 """Returns a copy, unless it is a sNaN.
1054
1055 Rounds the number (if more then precision digits)
1056 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001057 if self._is_special:
1058 ans = self._check_nans(context=context)
1059 if ans:
1060 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001061
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062 if not self:
1063 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001064 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001065 else:
1066 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001067
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001068 if context is None:
1069 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001070 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001071
Facundo Batistae64acfa2007-12-17 14:18:42 +00001072 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001073 """Returns the absolute value of self.
1074
Facundo Batistae64acfa2007-12-17 14:18:42 +00001075 If the keyword argument 'round' is false, do not round. The
1076 expression self.__abs__(round=False) is equivalent to
1077 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001078 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001079 if not round:
1080 return self.copy_abs()
1081
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001082 if self._is_special:
1083 ans = self._check_nans(context=context)
1084 if ans:
1085 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001086
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087 if self._sign:
1088 ans = self.__neg__(context=context)
1089 else:
1090 ans = self.__pos__(context=context)
1091
1092 return ans
1093
1094 def __add__(self, other, context=None):
1095 """Returns self + other.
1096
1097 -INF + INF (or the reverse) cause InvalidOperation errors.
1098 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001099 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001100 if other is NotImplemented:
1101 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001102
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103 if context is None:
1104 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001106 if self._is_special or other._is_special:
1107 ans = self._check_nans(other, context)
1108 if ans:
1109 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001110
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001111 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001112 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001113 if self._sign != other._sign and other._isinfinity():
1114 return context._raise_error(InvalidOperation, '-INF + INF')
1115 return Decimal(self)
1116 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001117 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001118
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119 exp = min(self._exp, other._exp)
1120 negativezero = 0
1121 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001122 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001123 negativezero = 1
1124
1125 if not self and not other:
1126 sign = min(self._sign, other._sign)
1127 if negativezero:
1128 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001129 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001130 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001131 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001132 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001133 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001134 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001135 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001136 return ans
1137 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001138 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001139 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001140 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141 return ans
1142
1143 op1 = _WorkRep(self)
1144 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001145 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001146
1147 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001148 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001150 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001151 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001152 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001153 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001154 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001156 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001157 if op1.sign == 1:
1158 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001159 op1.sign, op2.sign = op2.sign, op1.sign
1160 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001161 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001162 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001163 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001164 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001165 op1.sign, op2.sign = (0, 0)
1166 else:
1167 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001168 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001169
Raymond Hettinger17931de2004-10-27 06:21:46 +00001170 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001171 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001173 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001174
1175 result.exp = op1.exp
1176 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001177 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178 return ans
1179
1180 __radd__ = __add__
1181
1182 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001183 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001184 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001185 if other is NotImplemented:
1186 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001187
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001188 if self._is_special or other._is_special:
1189 ans = self._check_nans(other, context=context)
1190 if ans:
1191 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001192
Facundo Batista353750c2007-09-13 18:13:15 +00001193 # self - other is computed as self + other.copy_negate()
1194 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001195
1196 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001197 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001198 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001199 if other is NotImplemented:
1200 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
Facundo Batista353750c2007-09-13 18:13:15 +00001202 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204 def __mul__(self, other, context=None):
1205 """Return self * other.
1206
1207 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1208 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001209 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001210 if other is NotImplemented:
1211 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001212
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001213 if context is None:
1214 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001215
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001216 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001217
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001218 if self._is_special or other._is_special:
1219 ans = self._check_nans(other, context)
1220 if ans:
1221 return ans
1222
1223 if self._isinfinity():
1224 if not other:
1225 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001226 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001227
1228 if other._isinfinity():
1229 if not self:
1230 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001231 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001232
1233 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001234
1235 # Special case for multiplying by zero
1236 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001237 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001238 # Fixing in case the exponent is out of bounds
1239 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001240 return ans
1241
1242 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001243 if self._int == '1':
1244 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001245 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001246 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001247 if other._int == '1':
1248 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001249 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001250 return ans
1251
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001252 op1 = _WorkRep(self)
1253 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001254
Facundo Batista72bc54f2007-11-23 17:59:00 +00001255 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001256 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001257
1258 return ans
1259 __rmul__ = __mul__
1260
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001261 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001262 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001263 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001264 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001265 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001266
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001267 if context is None:
1268 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001269
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001270 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001271
1272 if self._is_special or other._is_special:
1273 ans = self._check_nans(other, context)
1274 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001275 return ans
1276
1277 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001278 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001281 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001282
1283 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001284 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001285 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001286
1287 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001288 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001289 if not self:
1290 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001291 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001292
Facundo Batistacce8df22007-09-18 16:53:18 +00001293 if not self:
1294 exp = self._exp - other._exp
1295 coeff = 0
1296 else:
1297 # OK, so neither = 0, INF or NaN
1298 shift = len(other._int) - len(self._int) + context.prec + 1
1299 exp = self._exp - other._exp - shift
1300 op1 = _WorkRep(self)
1301 op2 = _WorkRep(other)
1302 if shift >= 0:
1303 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1304 else:
1305 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1306 if remainder:
1307 # result is not exact; adjust to ensure correct rounding
1308 if coeff % 5 == 0:
1309 coeff += 1
1310 else:
1311 # result is exact; get as close to ideal exponent as possible
1312 ideal_exp = self._exp - other._exp
1313 while exp < ideal_exp and coeff % 10 == 0:
1314 coeff //= 10
1315 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001316
Facundo Batista72bc54f2007-11-23 17:59:00 +00001317 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001318 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
Facundo Batistacce8df22007-09-18 16:53:18 +00001320 def _divide(self, other, context):
1321 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001322
Facundo Batistacce8df22007-09-18 16:53:18 +00001323 Assumes that neither self nor other is a NaN, that self is not
1324 infinite and that other is nonzero.
1325 """
1326 sign = self._sign ^ other._sign
1327 if other._isinfinity():
1328 ideal_exp = self._exp
1329 else:
1330 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001331
Facundo Batistacce8df22007-09-18 16:53:18 +00001332 expdiff = self.adjusted() - other.adjusted()
1333 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001334 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001335 self._rescale(ideal_exp, context.rounding))
1336 if expdiff <= context.prec:
1337 op1 = _WorkRep(self)
1338 op2 = _WorkRep(other)
1339 if op1.exp >= op2.exp:
1340 op1.int *= 10**(op1.exp - op2.exp)
1341 else:
1342 op2.int *= 10**(op2.exp - op1.exp)
1343 q, r = divmod(op1.int, op2.int)
1344 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001345 return (_dec_from_triple(sign, str(q), 0),
1346 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001347
Facundo Batistacce8df22007-09-18 16:53:18 +00001348 # Here the quotient is too large to be representable
1349 ans = context._raise_error(DivisionImpossible,
1350 'quotient too large in //, % or divmod')
1351 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001352
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001353 def __rtruediv__(self, other, context=None):
1354 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001355 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001356 if other is NotImplemented:
1357 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001358 return other.__truediv__(self, context=context)
1359
1360 __div__ = __truediv__
1361 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001362
1363 def __divmod__(self, other, context=None):
1364 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001365 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001366 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001367 other = _convert_other(other)
1368 if other is NotImplemented:
1369 return other
1370
1371 if context is None:
1372 context = getcontext()
1373
1374 ans = self._check_nans(other, context)
1375 if ans:
1376 return (ans, ans)
1377
1378 sign = self._sign ^ other._sign
1379 if self._isinfinity():
1380 if other._isinfinity():
1381 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1382 return ans, ans
1383 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001384 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001385 context._raise_error(InvalidOperation, 'INF % x'))
1386
1387 if not other:
1388 if not self:
1389 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1390 return ans, ans
1391 else:
1392 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1393 context._raise_error(InvalidOperation, 'x % 0'))
1394
1395 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001396 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001397 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398
1399 def __rdivmod__(self, other, context=None):
1400 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001402 if other is NotImplemented:
1403 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001404 return other.__divmod__(self, context=context)
1405
1406 def __mod__(self, other, context=None):
1407 """
1408 self % other
1409 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001410 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001411 if other is NotImplemented:
1412 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001413
Facundo Batistacce8df22007-09-18 16:53:18 +00001414 if context is None:
1415 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001416
Facundo Batistacce8df22007-09-18 16:53:18 +00001417 ans = self._check_nans(other, context)
1418 if ans:
1419 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420
Facundo Batistacce8df22007-09-18 16:53:18 +00001421 if self._isinfinity():
1422 return context._raise_error(InvalidOperation, 'INF % x')
1423 elif not other:
1424 if self:
1425 return context._raise_error(InvalidOperation, 'x % 0')
1426 else:
1427 return context._raise_error(DivisionUndefined, '0 % 0')
1428
1429 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001430 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001431 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001432
1433 def __rmod__(self, other, context=None):
1434 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001435 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001436 if other is NotImplemented:
1437 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001438 return other.__mod__(self, context=context)
1439
1440 def remainder_near(self, other, context=None):
1441 """
1442 Remainder nearest to 0- abs(remainder-near) <= other/2
1443 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001444 if context is None:
1445 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001446
Facundo Batista353750c2007-09-13 18:13:15 +00001447 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001448
Facundo Batista353750c2007-09-13 18:13:15 +00001449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001452
Facundo Batista353750c2007-09-13 18:13:15 +00001453 # self == +/-infinity -> InvalidOperation
1454 if self._isinfinity():
1455 return context._raise_error(InvalidOperation,
1456 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001457
Facundo Batista353750c2007-09-13 18:13:15 +00001458 # other == 0 -> either InvalidOperation or DivisionUndefined
1459 if not other:
1460 if self:
1461 return context._raise_error(InvalidOperation,
1462 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001463 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001464 return context._raise_error(DivisionUndefined,
1465 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001466
Facundo Batista353750c2007-09-13 18:13:15 +00001467 # other = +/-infinity -> remainder = self
1468 if other._isinfinity():
1469 ans = Decimal(self)
1470 return ans._fix(context)
1471
1472 # self = 0 -> remainder = self, with ideal exponent
1473 ideal_exponent = min(self._exp, other._exp)
1474 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001475 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001476 return ans._fix(context)
1477
1478 # catch most cases of large or small quotient
1479 expdiff = self.adjusted() - other.adjusted()
1480 if expdiff >= context.prec + 1:
1481 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001482 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001483 if expdiff <= -2:
1484 # expdiff <= -2 => abs(self/other) < 0.1
1485 ans = self._rescale(ideal_exponent, context.rounding)
1486 return ans._fix(context)
1487
1488 # adjust both arguments to have the same exponent, then divide
1489 op1 = _WorkRep(self)
1490 op2 = _WorkRep(other)
1491 if op1.exp >= op2.exp:
1492 op1.int *= 10**(op1.exp - op2.exp)
1493 else:
1494 op2.int *= 10**(op2.exp - op1.exp)
1495 q, r = divmod(op1.int, op2.int)
1496 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1497 # 10**ideal_exponent. Apply correction to ensure that
1498 # abs(remainder) <= abs(other)/2
1499 if 2*r + (q&1) > op2.int:
1500 r -= op2.int
1501 q += 1
1502
1503 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001504 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001505
1506 # result has same sign as self unless r is negative
1507 sign = self._sign
1508 if r < 0:
1509 sign = 1-sign
1510 r = -r
1511
Facundo Batista72bc54f2007-11-23 17:59:00 +00001512 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001513 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001514
1515 def __floordiv__(self, other, context=None):
1516 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001517 other = _convert_other(other)
1518 if other is NotImplemented:
1519 return other
1520
1521 if context is None:
1522 context = getcontext()
1523
1524 ans = self._check_nans(other, context)
1525 if ans:
1526 return ans
1527
1528 if self._isinfinity():
1529 if other._isinfinity():
1530 return context._raise_error(InvalidOperation, 'INF // INF')
1531 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001532 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001533
1534 if not other:
1535 if self:
1536 return context._raise_error(DivisionByZero, 'x // 0',
1537 self._sign ^ other._sign)
1538 else:
1539 return context._raise_error(DivisionUndefined, '0 // 0')
1540
1541 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001542
1543 def __rfloordiv__(self, other, context=None):
1544 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001545 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001546 if other is NotImplemented:
1547 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001548 return other.__floordiv__(self, context=context)
1549
1550 def __float__(self):
1551 """Float representation."""
1552 return float(str(self))
1553
1554 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001555 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001556 if self._is_special:
1557 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001558 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001559 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001560 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001561 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001562 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001563 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001564 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001565 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001566
Raymond Hettinger5a053642008-01-24 19:05:29 +00001567 __trunc__ = __int__
1568
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001569 def real(self):
1570 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001571 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001572
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001573 def imag(self):
1574 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001575 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001576
1577 def conjugate(self):
1578 return self
1579
1580 def __complex__(self):
1581 return complex(float(self))
1582
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001583 def __long__(self):
1584 """Converts to a long.
1585
1586 Equivalent to long(int(self))
1587 """
1588 return long(self.__int__())
1589
Facundo Batista353750c2007-09-13 18:13:15 +00001590 def _fix_nan(self, context):
1591 """Decapitate the payload of a NaN to fit the context"""
1592 payload = self._int
1593
1594 # maximum length of payload is precision if _clamp=0,
1595 # precision-1 if _clamp=1.
1596 max_payload_len = context.prec - context._clamp
1597 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001598 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1599 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001600 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001601
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001602 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603 """Round if it is necessary to keep self within prec precision.
1604
1605 Rounds and fixes the exponent. Does not raise on a sNaN.
1606
1607 Arguments:
1608 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001609 context - context used.
1610 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001611
Facundo Batista353750c2007-09-13 18:13:15 +00001612 if self._is_special:
1613 if self._isnan():
1614 # decapitate payload if necessary
1615 return self._fix_nan(context)
1616 else:
1617 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001618 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001619
Facundo Batista353750c2007-09-13 18:13:15 +00001620 # if self is zero then exponent should be between Etiny and
1621 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1622 Etiny = context.Etiny()
1623 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001624 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001625 exp_max = [context.Emax, Etop][context._clamp]
1626 new_exp = min(max(self._exp, Etiny), exp_max)
1627 if new_exp != self._exp:
1628 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001629 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001630 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001631 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001632
1633 # exp_min is the smallest allowable exponent of the result,
1634 # equal to max(self.adjusted()-context.prec+1, Etiny)
1635 exp_min = len(self._int) + self._exp - context.prec
1636 if exp_min > Etop:
1637 # overflow: exp_min > Etop iff self.adjusted() > Emax
1638 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001640 return context._raise_error(Overflow, 'above Emax', self._sign)
1641 self_is_subnormal = exp_min < Etiny
1642 if self_is_subnormal:
1643 context._raise_error(Subnormal)
1644 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001645
Facundo Batista353750c2007-09-13 18:13:15 +00001646 # round if self has too many digits
1647 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001648 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001649 digits = len(self._int) + self._exp - exp_min
1650 if digits < 0:
1651 self = _dec_from_triple(self._sign, '1', exp_min-1)
1652 digits = 0
1653 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1654 changed = this_function(digits)
1655 coeff = self._int[:digits] or '0'
1656 if changed == 1:
1657 coeff = str(int(coeff)+1)
1658 ans = _dec_from_triple(self._sign, coeff, exp_min)
1659
1660 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001661 context._raise_error(Inexact)
1662 if self_is_subnormal:
1663 context._raise_error(Underflow)
1664 if not ans:
1665 # raise Clamped on underflow to 0
1666 context._raise_error(Clamped)
1667 elif len(ans._int) == context.prec+1:
1668 # we get here only if rescaling rounds the
1669 # cofficient up to exactly 10**context.prec
1670 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001671 ans = _dec_from_triple(ans._sign,
1672 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001673 else:
1674 # Inexact and Rounded have already been raised
1675 ans = context._raise_error(Overflow, 'above Emax',
1676 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001677 return ans
1678
Facundo Batista353750c2007-09-13 18:13:15 +00001679 # fold down if _clamp == 1 and self has too few digits
1680 if context._clamp == 1 and self._exp > Etop:
1681 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +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
Facundo Batista353750c2007-09-13 18:13:15 +00001685 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001686 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001687
1688 _pick_rounding_function = {}
1689
Facundo Batista353750c2007-09-13 18:13:15 +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)
Facundo Batista2ec74152007-12-03 17:55:00 +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
Facundo Batista353750c2007-09-13 18:13:15 +00001699
1700 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001702 if _all_zeros(self._int, prec):
1703 return 0
1704 else:
1705 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706
Facundo Batista353750c2007-09-13 18:13:15 +00001707 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001708 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001709 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710
Facundo Batista353750c2007-09-13 18:13:15 +00001711 def _round_half_up(self, prec):
1712 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001713 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001714 return 1
1715 elif _all_zeros(self._int, prec):
1716 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001717 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001718 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001719
1720 def _round_half_down(self, prec):
1721 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001722 if _exact_half(self._int, prec):
1723 return -1
1724 else:
1725 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001726
1727 def _round_half_even(self, prec):
1728 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001729 if _exact_half(self._int, prec) and \
1730 (prec == 0 or self._int[prec-1] in '02468'):
1731 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001732 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001733 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +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:
Facundo Batista353750c2007-09-13 18:13:15 +00001738 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001740 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741
Facundo Batista353750c2007-09-13 18:13:15 +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:
Facundo Batista353750c2007-09-13 18:13:15 +00001745 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001747 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748
Facundo Batista353750c2007-09-13 18:13:15 +00001749 def _round_05up(self, prec):
1750 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001751 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001752 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001753 else:
1754 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001755
Facundo Batista353750c2007-09-13 18:13:15 +00001756 def fma(self, other, third, context=None):
1757 """Fused multiply-add.
1758
1759 Returns self*other+third with no rounding of the intermediate
1760 product self*other.
1761
1762 self and other are multiplied together, with no rounding of
1763 the result. The third operand is then added to the result,
1764 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765 """
Facundo Batista353750c2007-09-13 18:13:15 +00001766
1767 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001768
1769 # compute product; raise InvalidOperation if either operand is
1770 # a signaling NaN or if the product is zero times infinity.
1771 if self._is_special or other._is_special:
1772 if context is None:
1773 context = getcontext()
1774 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001775 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001776 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001777 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001778 if self._exp == 'n':
1779 product = self
1780 elif other._exp == 'n':
1781 product = other
1782 elif self._exp == 'F':
1783 if not other:
1784 return context._raise_error(InvalidOperation,
1785 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001786 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001787 elif other._exp == 'F':
1788 if not self:
1789 return context._raise_error(InvalidOperation,
1790 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001791 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001792 else:
1793 product = _dec_from_triple(self._sign ^ other._sign,
1794 str(int(self._int) * int(other._int)),
1795 self._exp + other._exp)
1796
Facundo Batista353750c2007-09-13 18:13:15 +00001797 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001798 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001799
Facundo Batista353750c2007-09-13 18:13:15 +00001800 def _power_modulo(self, other, modulo, context=None):
1801 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001802
Facundo Batista353750c2007-09-13 18:13:15 +00001803 # if can't convert other and modulo to Decimal, raise
1804 # TypeError; there's no point returning NotImplemented (no
1805 # equivalent of __rpow__ for three argument pow)
1806 other = _convert_other(other, raiseit=True)
1807 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001808
Facundo Batista353750c2007-09-13 18:13:15 +00001809 if context is None:
1810 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001811
Facundo Batista353750c2007-09-13 18:13:15 +00001812 # deal with NaNs: if there are any sNaNs then first one wins,
1813 # (i.e. behaviour for NaNs is identical to that of fma)
1814 self_is_nan = self._isnan()
1815 other_is_nan = other._isnan()
1816 modulo_is_nan = modulo._isnan()
1817 if self_is_nan or other_is_nan or modulo_is_nan:
1818 if self_is_nan == 2:
1819 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001820 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001821 if other_is_nan == 2:
1822 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001823 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001824 if modulo_is_nan == 2:
1825 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001826 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001827 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001828 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001829 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001830 return other._fix_nan(context)
1831 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001832
Facundo Batista353750c2007-09-13 18:13:15 +00001833 # check inputs: we apply same restrictions as Python's pow()
1834 if not (self._isinteger() and
1835 other._isinteger() and
1836 modulo._isinteger()):
1837 return context._raise_error(InvalidOperation,
1838 'pow() 3rd argument not allowed '
1839 'unless all arguments are integers')
1840 if other < 0:
1841 return context._raise_error(InvalidOperation,
1842 'pow() 2nd argument cannot be '
1843 'negative when 3rd argument specified')
1844 if not modulo:
1845 return context._raise_error(InvalidOperation,
1846 'pow() 3rd argument cannot be 0')
1847
1848 # additional restriction for decimal: the modulus must be less
1849 # than 10**prec in absolute value
1850 if modulo.adjusted() >= context.prec:
1851 return context._raise_error(InvalidOperation,
1852 'insufficient precision: pow() 3rd '
1853 'argument must not have more than '
1854 'precision digits')
1855
1856 # define 0**0 == NaN, for consistency with two-argument pow
1857 # (even though it hurts!)
1858 if not other and not self:
1859 return context._raise_error(InvalidOperation,
1860 'at least one of pow() 1st argument '
1861 'and 2nd argument must be nonzero ;'
1862 '0**0 is not defined')
1863
1864 # compute sign of result
1865 if other._iseven():
1866 sign = 0
1867 else:
1868 sign = self._sign
1869
1870 # convert modulo to a Python integer, and self and other to
1871 # Decimal integers (i.e. force their exponents to be >= 0)
1872 modulo = abs(int(modulo))
1873 base = _WorkRep(self.to_integral_value())
1874 exponent = _WorkRep(other.to_integral_value())
1875
1876 # compute result using integer pow()
1877 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1878 for i in xrange(exponent.exp):
1879 base = pow(base, 10, modulo)
1880 base = pow(base, exponent.int, modulo)
1881
Facundo Batista72bc54f2007-11-23 17:59:00 +00001882 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001883
1884 def _power_exact(self, other, p):
1885 """Attempt to compute self**other exactly.
1886
1887 Given Decimals self and other and an integer p, attempt to
1888 compute an exact result for the power self**other, with p
1889 digits of precision. Return None if self**other is not
1890 exactly representable in p digits.
1891
1892 Assumes that elimination of special cases has already been
1893 performed: self and other must both be nonspecial; self must
1894 be positive and not numerically equal to 1; other must be
1895 nonzero. For efficiency, other._exp should not be too large,
1896 so that 10**abs(other._exp) is a feasible calculation."""
1897
1898 # In the comments below, we write x for the value of self and
1899 # y for the value of other. Write x = xc*10**xe and y =
1900 # yc*10**ye.
1901
1902 # The main purpose of this method is to identify the *failure*
1903 # of x**y to be exactly representable with as little effort as
1904 # possible. So we look for cheap and easy tests that
1905 # eliminate the possibility of x**y being exact. Only if all
1906 # these tests are passed do we go on to actually compute x**y.
1907
1908 # Here's the main idea. First normalize both x and y. We
1909 # express y as a rational m/n, with m and n relatively prime
1910 # and n>0. Then for x**y to be exactly representable (at
1911 # *any* precision), xc must be the nth power of a positive
1912 # integer and xe must be divisible by n. If m is negative
1913 # then additionally xc must be a power of either 2 or 5, hence
1914 # a power of 2**n or 5**n.
1915 #
1916 # There's a limit to how small |y| can be: if y=m/n as above
1917 # then:
1918 #
1919 # (1) if xc != 1 then for the result to be representable we
1920 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1921 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1922 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1923 # representable.
1924 #
1925 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1926 # |y| < 1/|xe| then the result is not representable.
1927 #
1928 # Note that since x is not equal to 1, at least one of (1) and
1929 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1930 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1931 #
1932 # There's also a limit to how large y can be, at least if it's
1933 # positive: the normalized result will have coefficient xc**y,
1934 # so if it's representable then xc**y < 10**p, and y <
1935 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1936 # not exactly representable.
1937
1938 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1939 # so |y| < 1/xe and the result is not representable.
1940 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1941 # < 1/nbits(xc).
1942
1943 x = _WorkRep(self)
1944 xc, xe = x.int, x.exp
1945 while xc % 10 == 0:
1946 xc //= 10
1947 xe += 1
1948
1949 y = _WorkRep(other)
1950 yc, ye = y.int, y.exp
1951 while yc % 10 == 0:
1952 yc //= 10
1953 ye += 1
1954
1955 # case where xc == 1: result is 10**(xe*y), with xe*y
1956 # required to be an integer
1957 if xc == 1:
1958 if ye >= 0:
1959 exponent = xe*yc*10**ye
1960 else:
1961 exponent, remainder = divmod(xe*yc, 10**-ye)
1962 if remainder:
1963 return None
1964 if y.sign == 1:
1965 exponent = -exponent
1966 # if other is a nonnegative integer, use ideal exponent
1967 if other._isinteger() and other._sign == 0:
1968 ideal_exponent = self._exp*int(other)
1969 zeros = min(exponent-ideal_exponent, p-1)
1970 else:
1971 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001972 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001973
1974 # case where y is negative: xc must be either a power
1975 # of 2 or a power of 5.
1976 if y.sign == 1:
1977 last_digit = xc % 10
1978 if last_digit in (2,4,6,8):
1979 # quick test for power of 2
1980 if xc & -xc != xc:
1981 return None
1982 # now xc is a power of 2; e is its exponent
1983 e = _nbits(xc)-1
1984 # find e*y and xe*y; both must be integers
1985 if ye >= 0:
1986 y_as_int = yc*10**ye
1987 e = e*y_as_int
1988 xe = xe*y_as_int
1989 else:
1990 ten_pow = 10**-ye
1991 e, remainder = divmod(e*yc, ten_pow)
1992 if remainder:
1993 return None
1994 xe, remainder = divmod(xe*yc, ten_pow)
1995 if remainder:
1996 return None
1997
1998 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1999 return None
2000 xc = 5**e
2001
2002 elif last_digit == 5:
2003 # e >= log_5(xc) if xc is a power of 5; we have
2004 # equality all the way up to xc=5**2658
2005 e = _nbits(xc)*28//65
2006 xc, remainder = divmod(5**e, xc)
2007 if remainder:
2008 return None
2009 while xc % 5 == 0:
2010 xc //= 5
2011 e -= 1
2012 if ye >= 0:
2013 y_as_integer = yc*10**ye
2014 e = e*y_as_integer
2015 xe = xe*y_as_integer
2016 else:
2017 ten_pow = 10**-ye
2018 e, remainder = divmod(e*yc, ten_pow)
2019 if remainder:
2020 return None
2021 xe, remainder = divmod(xe*yc, ten_pow)
2022 if remainder:
2023 return None
2024 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2025 return None
2026 xc = 2**e
2027 else:
2028 return None
2029
2030 if xc >= 10**p:
2031 return None
2032 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002033 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002034
2035 # now y is positive; find m and n such that y = m/n
2036 if ye >= 0:
2037 m, n = yc*10**ye, 1
2038 else:
2039 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2040 return None
2041 xc_bits = _nbits(xc)
2042 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2043 return None
2044 m, n = yc, 10**(-ye)
2045 while m % 2 == n % 2 == 0:
2046 m //= 2
2047 n //= 2
2048 while m % 5 == n % 5 == 0:
2049 m //= 5
2050 n //= 5
2051
2052 # compute nth root of xc*10**xe
2053 if n > 1:
2054 # if 1 < xc < 2**n then xc isn't an nth power
2055 if xc != 1 and xc_bits <= n:
2056 return None
2057
2058 xe, rem = divmod(xe, n)
2059 if rem != 0:
2060 return None
2061
2062 # compute nth root of xc using Newton's method
2063 a = 1L << -(-_nbits(xc)//n) # initial estimate
2064 while True:
2065 q, r = divmod(xc, a**(n-1))
2066 if a <= q:
2067 break
2068 else:
2069 a = (a*(n-1) + q)//n
2070 if not (a == q and r == 0):
2071 return None
2072 xc = a
2073
2074 # now xc*10**xe is the nth root of the original xc*10**xe
2075 # compute mth power of xc*10**xe
2076
2077 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2078 # 10**p and the result is not representable.
2079 if xc > 1 and m > p*100//_log10_lb(xc):
2080 return None
2081 xc = xc**m
2082 xe *= m
2083 if xc > 10**p:
2084 return None
2085
2086 # by this point the result *is* exactly representable
2087 # adjust the exponent to get as close as possible to the ideal
2088 # exponent, if necessary
2089 str_xc = str(xc)
2090 if other._isinteger() and other._sign == 0:
2091 ideal_exponent = self._exp*int(other)
2092 zeros = min(xe-ideal_exponent, p-len(str_xc))
2093 else:
2094 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002095 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002096
2097 def __pow__(self, other, modulo=None, context=None):
2098 """Return self ** other [ % modulo].
2099
2100 With two arguments, compute self**other.
2101
2102 With three arguments, compute (self**other) % modulo. For the
2103 three argument form, the following restrictions on the
2104 arguments hold:
2105
2106 - all three arguments must be integral
2107 - other must be nonnegative
2108 - either self or other (or both) must be nonzero
2109 - modulo must be nonzero and must have at most p digits,
2110 where p is the context precision.
2111
2112 If any of these restrictions is violated the InvalidOperation
2113 flag is raised.
2114
2115 The result of pow(self, other, modulo) is identical to the
2116 result that would be obtained by computing (self**other) %
2117 modulo with unbounded precision, but is computed more
2118 efficiently. It is always exact.
2119 """
2120
2121 if modulo is not None:
2122 return self._power_modulo(other, modulo, context)
2123
2124 other = _convert_other(other)
2125 if other is NotImplemented:
2126 return other
2127
2128 if context is None:
2129 context = getcontext()
2130
2131 # either argument is a NaN => result is NaN
2132 ans = self._check_nans(other, context)
2133 if ans:
2134 return ans
2135
2136 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2137 if not other:
2138 if not self:
2139 return context._raise_error(InvalidOperation, '0 ** 0')
2140 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002141 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002142
2143 # result has sign 1 iff self._sign is 1 and other is an odd integer
2144 result_sign = 0
2145 if self._sign == 1:
2146 if other._isinteger():
2147 if not other._iseven():
2148 result_sign = 1
2149 else:
2150 # -ve**noninteger = NaN
2151 # (-0)**noninteger = 0**noninteger
2152 if self:
2153 return context._raise_error(InvalidOperation,
2154 'x ** y with x negative and y not an integer')
2155 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002156 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002157
2158 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2159 if not self:
2160 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002161 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002162 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002163 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002164
2165 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002166 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002167 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002168 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002169 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002170 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002171
Facundo Batista353750c2007-09-13 18:13:15 +00002172 # 1**other = 1, but the choice of exponent and the flags
2173 # depend on the exponent of self, and on whether other is a
2174 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002175 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002176 if other._isinteger():
2177 # exp = max(self._exp*max(int(other), 0),
2178 # 1-context.prec) but evaluating int(other) directly
2179 # is dangerous until we know other is small (other
2180 # could be 1e999999999)
2181 if other._sign == 1:
2182 multiplier = 0
2183 elif other > context.prec:
2184 multiplier = context.prec
2185 else:
2186 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002187
Facundo Batista353750c2007-09-13 18:13:15 +00002188 exp = self._exp * multiplier
2189 if exp < 1-context.prec:
2190 exp = 1-context.prec
2191 context._raise_error(Rounded)
2192 else:
2193 context._raise_error(Inexact)
2194 context._raise_error(Rounded)
2195 exp = 1-context.prec
2196
Facundo Batista72bc54f2007-11-23 17:59:00 +00002197 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002198
2199 # compute adjusted exponent of self
2200 self_adj = self.adjusted()
2201
2202 # self ** infinity is infinity if self > 1, 0 if self < 1
2203 # self ** -infinity is infinity if self < 1, 0 if self > 1
2204 if other._isinfinity():
2205 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002206 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002207 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002208 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002209
2210 # from here on, the result always goes through the call
2211 # to _fix at the end of this function.
2212 ans = None
2213
2214 # crude test to catch cases of extreme overflow/underflow. If
2215 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2216 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2217 # self**other >= 10**(Emax+1), so overflow occurs. The test
2218 # for underflow is similar.
2219 bound = self._log10_exp_bound() + other.adjusted()
2220 if (self_adj >= 0) == (other._sign == 0):
2221 # self > 1 and other +ve, or self < 1 and other -ve
2222 # possibility of overflow
2223 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002224 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002225 else:
2226 # self > 1 and other -ve, or self < 1 and other +ve
2227 # possibility of underflow to 0
2228 Etiny = context.Etiny()
2229 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002230 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002231
2232 # try for an exact result with precision +1
2233 if ans is None:
2234 ans = self._power_exact(other, context.prec + 1)
2235 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002236 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002237
2238 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2239 if ans is None:
2240 p = context.prec
2241 x = _WorkRep(self)
2242 xc, xe = x.int, x.exp
2243 y = _WorkRep(other)
2244 yc, ye = y.int, y.exp
2245 if y.sign == 1:
2246 yc = -yc
2247
2248 # compute correctly rounded result: start with precision +3,
2249 # then increase precision until result is unambiguously roundable
2250 extra = 3
2251 while True:
2252 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2253 if coeff % (5*10**(len(str(coeff))-p-1)):
2254 break
2255 extra += 3
2256
Facundo Batista72bc54f2007-11-23 17:59:00 +00002257 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002258
2259 # the specification says that for non-integer other we need to
2260 # raise Inexact, even when the result is actually exact. In
2261 # the same way, we need to raise Underflow here if the result
2262 # is subnormal. (The call to _fix will take care of raising
2263 # Rounded and Subnormal, as usual.)
2264 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002265 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002266 # pad with zeros up to length context.prec+1 if necessary
2267 if len(ans._int) <= context.prec:
2268 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002269 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2270 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002271 if ans.adjusted() < context.Emin:
2272 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002273
Facundo Batista353750c2007-09-13 18:13:15 +00002274 # unlike exp, ln and log10, the power function respects the
2275 # rounding mode; no need to use ROUND_HALF_EVEN here
2276 ans = ans._fix(context)
2277 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002278
2279 def __rpow__(self, other, context=None):
2280 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002281 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002282 if other is NotImplemented:
2283 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002284 return other.__pow__(self, context=context)
2285
2286 def normalize(self, context=None):
2287 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002288
Facundo Batista353750c2007-09-13 18:13:15 +00002289 if context is None:
2290 context = getcontext()
2291
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002292 if self._is_special:
2293 ans = self._check_nans(context=context)
2294 if ans:
2295 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002296
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002297 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002298 if dup._isinfinity():
2299 return dup
2300
2301 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002302 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002303 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002304 end = len(dup._int)
2305 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002306 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002307 exp += 1
2308 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002309 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002310
Facundo Batistabd2fe832007-09-13 18:42:09 +00002311 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002312 """Quantize self so its exponent is the same as that of exp.
2313
2314 Similar to self._rescale(exp._exp) but with error checking.
2315 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002316 exp = _convert_other(exp, raiseit=True)
2317
Facundo Batista353750c2007-09-13 18:13:15 +00002318 if context is None:
2319 context = getcontext()
2320 if rounding is None:
2321 rounding = context.rounding
2322
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002323 if self._is_special or exp._is_special:
2324 ans = self._check_nans(exp, context)
2325 if ans:
2326 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002327
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002328 if exp._isinfinity() or self._isinfinity():
2329 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002330 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002331 return context._raise_error(InvalidOperation,
2332 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002333
Facundo Batistabd2fe832007-09-13 18:42:09 +00002334 # if we're not watching exponents, do a simple rescale
2335 if not watchexp:
2336 ans = self._rescale(exp._exp, rounding)
2337 # raise Inexact and Rounded where appropriate
2338 if ans._exp > self._exp:
2339 context._raise_error(Rounded)
2340 if ans != self:
2341 context._raise_error(Inexact)
2342 return ans
2343
Facundo Batista353750c2007-09-13 18:13:15 +00002344 # exp._exp should be between Etiny and Emax
2345 if not (context.Etiny() <= exp._exp <= context.Emax):
2346 return context._raise_error(InvalidOperation,
2347 'target exponent out of bounds in quantize')
2348
2349 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002350 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002351 return ans._fix(context)
2352
2353 self_adjusted = self.adjusted()
2354 if self_adjusted > context.Emax:
2355 return context._raise_error(InvalidOperation,
2356 'exponent of quantize result too large for current context')
2357 if self_adjusted - exp._exp + 1 > context.prec:
2358 return context._raise_error(InvalidOperation,
2359 'quantize result has too many digits for current context')
2360
2361 ans = self._rescale(exp._exp, rounding)
2362 if ans.adjusted() > context.Emax:
2363 return context._raise_error(InvalidOperation,
2364 'exponent of quantize result too large for current context')
2365 if len(ans._int) > context.prec:
2366 return context._raise_error(InvalidOperation,
2367 'quantize result has too many digits for current context')
2368
2369 # raise appropriate flags
2370 if ans._exp > self._exp:
2371 context._raise_error(Rounded)
2372 if ans != self:
2373 context._raise_error(Inexact)
2374 if ans and ans.adjusted() < context.Emin:
2375 context._raise_error(Subnormal)
2376
2377 # call to fix takes care of any necessary folddown
2378 ans = ans._fix(context)
2379 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002380
2381 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002382 """Return True if self and other have the same exponent; otherwise
2383 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002384
Facundo Batista1a191df2007-10-02 17:01:24 +00002385 If either operand is a special value, the following rules are used:
2386 * return True if both operands are infinities
2387 * return True if both operands are NaNs
2388 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002389 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002390 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002391 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002392 return (self.is_nan() and other.is_nan() or
2393 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002394 return self._exp == other._exp
2395
Facundo Batista353750c2007-09-13 18:13:15 +00002396 def _rescale(self, exp, rounding):
2397 """Rescale self so that the exponent is exp, either by padding with zeros
2398 or by truncating digits, using the given rounding mode.
2399
2400 Specials are returned without change. This operation is
2401 quiet: it raises no flags, and uses no information from the
2402 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403
2404 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002405 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002406 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002407 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002408 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002410 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002411
Facundo Batista353750c2007-09-13 18:13:15 +00002412 if self._exp >= exp:
2413 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002414 return _dec_from_triple(self._sign,
2415 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002416
Facundo Batista353750c2007-09-13 18:13:15 +00002417 # too many digits; round and lose data. If self.adjusted() <
2418 # exp-1, replace self by 10**(exp-1) before rounding
2419 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002420 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002421 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002422 digits = 0
2423 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002424 changed = this_function(digits)
2425 coeff = self._int[:digits] or '0'
2426 if changed == 1:
2427 coeff = str(int(coeff)+1)
2428 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002430 def _round(self, places, rounding):
2431 """Round a nonzero, nonspecial Decimal to a fixed number of
2432 significant figures, using the given rounding mode.
2433
2434 Infinities, NaNs and zeros are returned unaltered.
2435
2436 This operation is quiet: it raises no flags, and uses no
2437 information from the context.
2438
2439 """
2440 if places <= 0:
2441 raise ValueError("argument should be at least 1 in _round")
2442 if self._is_special or not self:
2443 return Decimal(self)
2444 ans = self._rescale(self.adjusted()+1-places, rounding)
2445 # it can happen that the rescale alters the adjusted exponent;
2446 # for example when rounding 99.97 to 3 significant figures.
2447 # When this happens we end up with an extra 0 at the end of
2448 # the number; a second rescale fixes this.
2449 if ans.adjusted() != self.adjusted():
2450 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2451 return ans
2452
Facundo Batista353750c2007-09-13 18:13:15 +00002453 def to_integral_exact(self, rounding=None, context=None):
2454 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
Facundo Batista353750c2007-09-13 18:13:15 +00002456 If no rounding mode is specified, take the rounding mode from
2457 the context. This method raises the Rounded and Inexact flags
2458 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002459
Facundo Batista353750c2007-09-13 18:13:15 +00002460 See also: to_integral_value, which does exactly the same as
2461 this method except that it doesn't raise Inexact or Rounded.
2462 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002463 if self._is_special:
2464 ans = self._check_nans(context=context)
2465 if ans:
2466 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002467 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002468 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002469 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002470 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002471 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002472 if context is None:
2473 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002474 if rounding is None:
2475 rounding = context.rounding
2476 context._raise_error(Rounded)
2477 ans = self._rescale(0, rounding)
2478 if ans != self:
2479 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002480 return ans
2481
Facundo Batista353750c2007-09-13 18:13:15 +00002482 def to_integral_value(self, rounding=None, context=None):
2483 """Rounds to the nearest integer, without raising inexact, rounded."""
2484 if context is None:
2485 context = getcontext()
2486 if rounding is None:
2487 rounding = context.rounding
2488 if self._is_special:
2489 ans = self._check_nans(context=context)
2490 if ans:
2491 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002492 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002493 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002494 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002495 else:
2496 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Facundo Batista353750c2007-09-13 18:13:15 +00002498 # the method name changed, but we provide also the old one, for compatibility
2499 to_integral = to_integral_value
2500
2501 def sqrt(self, context=None):
2502 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002503 if context is None:
2504 context = getcontext()
2505
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002506 if self._is_special:
2507 ans = self._check_nans(context=context)
2508 if ans:
2509 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002511 if self._isinfinity() and self._sign == 0:
2512 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002513
2514 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002515 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002516 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002517 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002518
2519 if self._sign == 1:
2520 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2521
Facundo Batista353750c2007-09-13 18:13:15 +00002522 # At this point self represents a positive number. Let p be
2523 # the desired precision and express self in the form c*100**e
2524 # with c a positive real number and e an integer, c and e
2525 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2526 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2527 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2528 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2529 # the closest integer to sqrt(c) with the even integer chosen
2530 # in the case of a tie.
2531 #
2532 # To ensure correct rounding in all cases, we use the
2533 # following trick: we compute the square root to an extra
2534 # place (precision p+1 instead of precision p), rounding down.
2535 # Then, if the result is inexact and its last digit is 0 or 5,
2536 # we increase the last digit to 1 or 6 respectively; if it's
2537 # exact we leave the last digit alone. Now the final round to
2538 # p places (or fewer in the case of underflow) will round
2539 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002540
Facundo Batista353750c2007-09-13 18:13:15 +00002541 # use an extra digit of precision
2542 prec = context.prec+1
2543
2544 # write argument in the form c*100**e where e = self._exp//2
2545 # is the 'ideal' exponent, to be used if the square root is
2546 # exactly representable. l is the number of 'digits' of c in
2547 # base 100, so that 100**(l-1) <= c < 100**l.
2548 op = _WorkRep(self)
2549 e = op.exp >> 1
2550 if op.exp & 1:
2551 c = op.int * 10
2552 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002553 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002554 c = op.int
2555 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002556
Facundo Batista353750c2007-09-13 18:13:15 +00002557 # rescale so that c has exactly prec base 100 'digits'
2558 shift = prec-l
2559 if shift >= 0:
2560 c *= 100**shift
2561 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002562 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002563 c, remainder = divmod(c, 100**-shift)
2564 exact = not remainder
2565 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002566
Facundo Batista353750c2007-09-13 18:13:15 +00002567 # find n = floor(sqrt(c)) using Newton's method
2568 n = 10**prec
2569 while True:
2570 q = c//n
2571 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002572 break
Facundo Batista353750c2007-09-13 18:13:15 +00002573 else:
2574 n = n + q >> 1
2575 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002576
Facundo Batista353750c2007-09-13 18:13:15 +00002577 if exact:
2578 # result is exact; rescale to use ideal exponent e
2579 if shift >= 0:
2580 # assert n % 10**shift == 0
2581 n //= 10**shift
2582 else:
2583 n *= 10**-shift
2584 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002586 # result is not exact; fix last digit as described above
2587 if n % 5 == 0:
2588 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002589
Facundo Batista72bc54f2007-11-23 17:59:00 +00002590 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591
Facundo Batista353750c2007-09-13 18:13:15 +00002592 # round, and fit to current context
2593 context = context._shallow_copy()
2594 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002595 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002596 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002597
Facundo Batista353750c2007-09-13 18:13:15 +00002598 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599
2600 def max(self, other, context=None):
2601 """Returns the larger value.
2602
Facundo Batista353750c2007-09-13 18:13:15 +00002603 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002604 NaN (and signals if one is sNaN). Also rounds.
2605 """
Facundo Batista353750c2007-09-13 18:13:15 +00002606 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002607
Facundo Batista6c398da2007-09-17 17:30:13 +00002608 if context is None:
2609 context = getcontext()
2610
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002611 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002612 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002613 # number is always returned
2614 sn = self._isnan()
2615 on = other._isnan()
2616 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002617 if on == 1 and sn == 0:
2618 return self._fix(context)
2619 if sn == 1 and on == 0:
2620 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002621 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622
Mark Dickinson2fc92632008-02-06 22:10:50 +00002623 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002624 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002625 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002626 # then an ordering is applied:
2627 #
Facundo Batista59c58842007-04-10 12:58:45 +00002628 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002629 # positive sign and min returns the operand with the negative sign
2630 #
Facundo Batista59c58842007-04-10 12:58:45 +00002631 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002632 # the result. This is exactly the ordering used in compare_total.
2633 c = self.compare_total(other)
2634
2635 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002637 else:
2638 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002639
Facundo Batistae64acfa2007-12-17 14:18:42 +00002640 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 def min(self, other, context=None):
2643 """Returns the smaller value.
2644
Facundo Batista59c58842007-04-10 12:58:45 +00002645 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002646 NaN (and signals if one is sNaN). Also rounds.
2647 """
Facundo Batista353750c2007-09-13 18:13:15 +00002648 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
Facundo Batista6c398da2007-09-17 17:30:13 +00002650 if context is None:
2651 context = getcontext()
2652
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002653 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002654 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002655 # number is always returned
2656 sn = self._isnan()
2657 on = other._isnan()
2658 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002659 if on == 1 and sn == 0:
2660 return self._fix(context)
2661 if sn == 1 and on == 0:
2662 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002663 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002664
Mark Dickinson2fc92632008-02-06 22:10:50 +00002665 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002666 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002667 c = self.compare_total(other)
2668
2669 if c == -1:
2670 ans = self
2671 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002673
Facundo Batistae64acfa2007-12-17 14:18:42 +00002674 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002675
2676 def _isinteger(self):
2677 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002678 if self._is_special:
2679 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002680 if self._exp >= 0:
2681 return True
2682 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002683 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002684
2685 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002686 """Returns True if self is even. Assumes self is an integer."""
2687 if not self or self._exp > 0:
2688 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002689 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002690
2691 def adjusted(self):
2692 """Return the adjusted exponent of self"""
2693 try:
2694 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002695 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002696 except TypeError:
2697 return 0
2698
Facundo Batista353750c2007-09-13 18:13:15 +00002699 def canonical(self, context=None):
2700 """Returns the same Decimal object.
2701
2702 As we do not have different encodings for the same number, the
2703 received object already is in its canonical form.
2704 """
2705 return self
2706
2707 def compare_signal(self, other, context=None):
2708 """Compares self to the other operand numerically.
2709
2710 It's pretty much like compare(), but all NaNs signal, with signaling
2711 NaNs taking precedence over quiet NaNs.
2712 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002713 other = _convert_other(other, raiseit = True)
2714 ans = self._compare_check_nans(other, context)
2715 if ans:
2716 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002717 return self.compare(other, context=context)
2718
2719 def compare_total(self, other):
2720 """Compares self to other using the abstract representations.
2721
2722 This is not like the standard compare, which use their numerical
2723 value. Note that a total ordering is defined for all possible abstract
2724 representations.
2725 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002726 other = _convert_other(other, raiseit=True)
2727
Facundo Batista353750c2007-09-13 18:13:15 +00002728 # if one is negative and the other is positive, it's easy
2729 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002730 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002731 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002732 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002733 sign = self._sign
2734
2735 # let's handle both NaN types
2736 self_nan = self._isnan()
2737 other_nan = other._isnan()
2738 if self_nan or other_nan:
2739 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002740 # compare payloads as though they're integers
2741 self_key = len(self._int), self._int
2742 other_key = len(other._int), other._int
2743 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002744 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002745 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002746 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002747 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002748 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002749 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002750 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002751 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002752 return _One
2753 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002754
2755 if sign:
2756 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002757 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002758 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002759 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002760 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002761 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002762 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002763 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002764 else:
2765 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002766 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002767 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002768 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002769 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002770 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002771 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002772 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002773
2774 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002775 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002776 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002777 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002778
2779 if self._exp < other._exp:
2780 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002781 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002782 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002783 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002784 if self._exp > other._exp:
2785 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002786 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002787 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002788 return _One
2789 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002790
2791
2792 def compare_total_mag(self, other):
2793 """Compares self to other using abstract repr., ignoring sign.
2794
2795 Like compare_total, but with operand's sign ignored and assumed to be 0.
2796 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002797 other = _convert_other(other, raiseit=True)
2798
Facundo Batista353750c2007-09-13 18:13:15 +00002799 s = self.copy_abs()
2800 o = other.copy_abs()
2801 return s.compare_total(o)
2802
2803 def copy_abs(self):
2804 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002805 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002806
2807 def copy_negate(self):
2808 """Returns a copy with the sign inverted."""
2809 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002810 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002811 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002812 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002813
2814 def copy_sign(self, other):
2815 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002816 return _dec_from_triple(other._sign, self._int,
2817 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002818
2819 def exp(self, context=None):
2820 """Returns e ** self."""
2821
2822 if context is None:
2823 context = getcontext()
2824
2825 # exp(NaN) = NaN
2826 ans = self._check_nans(context=context)
2827 if ans:
2828 return ans
2829
2830 # exp(-Infinity) = 0
2831 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002832 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002833
2834 # exp(0) = 1
2835 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002836 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002837
2838 # exp(Infinity) = Infinity
2839 if self._isinfinity() == 1:
2840 return Decimal(self)
2841
2842 # the result is now guaranteed to be inexact (the true
2843 # mathematical result is transcendental). There's no need to
2844 # raise Rounded and Inexact here---they'll always be raised as
2845 # a result of the call to _fix.
2846 p = context.prec
2847 adj = self.adjusted()
2848
2849 # we only need to do any computation for quite a small range
2850 # of adjusted exponents---for example, -29 <= adj <= 10 for
2851 # the default context. For smaller exponent the result is
2852 # indistinguishable from 1 at the given precision, while for
2853 # larger exponent the result either overflows or underflows.
2854 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2855 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002856 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002857 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2858 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002859 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002860 elif self._sign == 0 and adj < -p:
2861 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002862 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002863 elif self._sign == 1 and adj < -p-1:
2864 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002865 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002866 # general case
2867 else:
2868 op = _WorkRep(self)
2869 c, e = op.int, op.exp
2870 if op.sign == 1:
2871 c = -c
2872
2873 # compute correctly rounded result: increase precision by
2874 # 3 digits at a time until we get an unambiguously
2875 # roundable result
2876 extra = 3
2877 while True:
2878 coeff, exp = _dexp(c, e, p+extra)
2879 if coeff % (5*10**(len(str(coeff))-p-1)):
2880 break
2881 extra += 3
2882
Facundo Batista72bc54f2007-11-23 17:59:00 +00002883 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002884
2885 # at this stage, ans should round correctly with *any*
2886 # rounding mode, not just with ROUND_HALF_EVEN
2887 context = context._shallow_copy()
2888 rounding = context._set_rounding(ROUND_HALF_EVEN)
2889 ans = ans._fix(context)
2890 context.rounding = rounding
2891
2892 return ans
2893
2894 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002895 """Return True if self is canonical; otherwise return False.
2896
2897 Currently, the encoding of a Decimal instance is always
2898 canonical, so this method returns True for any Decimal.
2899 """
2900 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002901
2902 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002903 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002904
Facundo Batista1a191df2007-10-02 17:01:24 +00002905 A Decimal instance is considered finite if it is neither
2906 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002907 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002908 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002909
2910 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002911 """Return True if self is infinite; otherwise return False."""
2912 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002913
2914 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002915 """Return True if self is a qNaN or sNaN; otherwise return False."""
2916 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002917
2918 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002919 """Return True if self is a normal number; otherwise return False."""
2920 if self._is_special or not self:
2921 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002922 if context is None:
2923 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00002924 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002925
2926 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002927 """Return True if self is a quiet NaN; otherwise return False."""
2928 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002929
2930 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002931 """Return True if self is negative; otherwise return False."""
2932 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002933
2934 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002935 """Return True if self is a signaling NaN; otherwise return False."""
2936 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002937
2938 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002939 """Return True if self is subnormal; otherwise return False."""
2940 if self._is_special or not self:
2941 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002942 if context is None:
2943 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002944 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002945
2946 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002947 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002948 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002949
2950 def _ln_exp_bound(self):
2951 """Compute a lower bound for the adjusted exponent of self.ln().
2952 In other words, compute r such that self.ln() >= 10**r. Assumes
2953 that self is finite and positive and that self != 1.
2954 """
2955
2956 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2957 adj = self._exp + len(self._int) - 1
2958 if adj >= 1:
2959 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2960 return len(str(adj*23//10)) - 1
2961 if adj <= -2:
2962 # argument <= 0.1
2963 return len(str((-1-adj)*23//10)) - 1
2964 op = _WorkRep(self)
2965 c, e = op.int, op.exp
2966 if adj == 0:
2967 # 1 < self < 10
2968 num = str(c-10**-e)
2969 den = str(c)
2970 return len(num) - len(den) - (num < den)
2971 # adj == -1, 0.1 <= self < 1
2972 return e + len(str(10**-e - c)) - 1
2973
2974
2975 def ln(self, context=None):
2976 """Returns the natural (base e) logarithm of self."""
2977
2978 if context is None:
2979 context = getcontext()
2980
2981 # ln(NaN) = NaN
2982 ans = self._check_nans(context=context)
2983 if ans:
2984 return ans
2985
2986 # ln(0.0) == -Infinity
2987 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002988 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002989
2990 # ln(Infinity) = Infinity
2991 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002992 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002993
2994 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002995 if self == _One:
2996 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002997
2998 # ln(negative) raises InvalidOperation
2999 if self._sign == 1:
3000 return context._raise_error(InvalidOperation,
3001 'ln of a negative value')
3002
3003 # result is irrational, so necessarily inexact
3004 op = _WorkRep(self)
3005 c, e = op.int, op.exp
3006 p = context.prec
3007
3008 # correctly rounded result: repeatedly increase precision by 3
3009 # until we get an unambiguously roundable result
3010 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3011 while True:
3012 coeff = _dlog(c, e, places)
3013 # assert len(str(abs(coeff)))-p >= 1
3014 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3015 break
3016 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003017 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003018
3019 context = context._shallow_copy()
3020 rounding = context._set_rounding(ROUND_HALF_EVEN)
3021 ans = ans._fix(context)
3022 context.rounding = rounding
3023 return ans
3024
3025 def _log10_exp_bound(self):
3026 """Compute a lower bound for the adjusted exponent of self.log10().
3027 In other words, find r such that self.log10() >= 10**r.
3028 Assumes that self is finite and positive and that self != 1.
3029 """
3030
3031 # For x >= 10 or x < 0.1 we only need a bound on the integer
3032 # part of log10(self), and this comes directly from the
3033 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3034 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3035 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3036
3037 adj = self._exp + len(self._int) - 1
3038 if adj >= 1:
3039 # self >= 10
3040 return len(str(adj))-1
3041 if adj <= -2:
3042 # self < 0.1
3043 return len(str(-1-adj))-1
3044 op = _WorkRep(self)
3045 c, e = op.int, op.exp
3046 if adj == 0:
3047 # 1 < self < 10
3048 num = str(c-10**-e)
3049 den = str(231*c)
3050 return len(num) - len(den) - (num < den) + 2
3051 # adj == -1, 0.1 <= self < 1
3052 num = str(10**-e-c)
3053 return len(num) + e - (num < "231") - 1
3054
3055 def log10(self, context=None):
3056 """Returns the base 10 logarithm of self."""
3057
3058 if context is None:
3059 context = getcontext()
3060
3061 # log10(NaN) = NaN
3062 ans = self._check_nans(context=context)
3063 if ans:
3064 return ans
3065
3066 # log10(0.0) == -Infinity
3067 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003068 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003069
3070 # log10(Infinity) = Infinity
3071 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003072 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003073
3074 # log10(negative or -Infinity) raises InvalidOperation
3075 if self._sign == 1:
3076 return context._raise_error(InvalidOperation,
3077 'log10 of a negative value')
3078
3079 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003080 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003081 # answer may need rounding
3082 ans = Decimal(self._exp + len(self._int) - 1)
3083 else:
3084 # result is irrational, so necessarily inexact
3085 op = _WorkRep(self)
3086 c, e = op.int, op.exp
3087 p = context.prec
3088
3089 # correctly rounded result: repeatedly increase precision
3090 # until result is unambiguously roundable
3091 places = p-self._log10_exp_bound()+2
3092 while True:
3093 coeff = _dlog10(c, e, places)
3094 # assert len(str(abs(coeff)))-p >= 1
3095 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3096 break
3097 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003098 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003099
3100 context = context._shallow_copy()
3101 rounding = context._set_rounding(ROUND_HALF_EVEN)
3102 ans = ans._fix(context)
3103 context.rounding = rounding
3104 return ans
3105
3106 def logb(self, context=None):
3107 """ Returns the exponent of the magnitude of self's MSD.
3108
3109 The result is the integer which is the exponent of the magnitude
3110 of the most significant digit of self (as though it were truncated
3111 to a single digit while maintaining the value of that digit and
3112 without limiting the resulting exponent).
3113 """
3114 # logb(NaN) = NaN
3115 ans = self._check_nans(context=context)
3116 if ans:
3117 return ans
3118
3119 if context is None:
3120 context = getcontext()
3121
3122 # logb(+/-Inf) = +Inf
3123 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003124 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003125
3126 # logb(0) = -Inf, DivisionByZero
3127 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003128 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003129
3130 # otherwise, simply return the adjusted exponent of self, as a
3131 # Decimal. Note that no attempt is made to fit the result
3132 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003133 ans = Decimal(self.adjusted())
3134 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003135
3136 def _islogical(self):
3137 """Return True if self is a logical operand.
3138
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003139 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003140 an exponent of 0, and a coefficient whose digits must all be
3141 either 0 or 1.
3142 """
3143 if self._sign != 0 or self._exp != 0:
3144 return False
3145 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003146 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003147 return False
3148 return True
3149
3150 def _fill_logical(self, context, opa, opb):
3151 dif = context.prec - len(opa)
3152 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003153 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003154 elif dif < 0:
3155 opa = opa[-context.prec:]
3156 dif = context.prec - len(opb)
3157 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003158 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003159 elif dif < 0:
3160 opb = opb[-context.prec:]
3161 return opa, opb
3162
3163 def logical_and(self, other, context=None):
3164 """Applies an 'and' operation between self and other's digits."""
3165 if context is None:
3166 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003167
3168 other = _convert_other(other, raiseit=True)
3169
Facundo Batista353750c2007-09-13 18:13:15 +00003170 if not self._islogical() or not other._islogical():
3171 return context._raise_error(InvalidOperation)
3172
3173 # fill to context.prec
3174 (opa, opb) = self._fill_logical(context, self._int, other._int)
3175
3176 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003177 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3178 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003179
3180 def logical_invert(self, context=None):
3181 """Invert all its digits."""
3182 if context is None:
3183 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003184 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3185 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003186
3187 def logical_or(self, other, context=None):
3188 """Applies an 'or' operation between self and other's digits."""
3189 if context is None:
3190 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003191
3192 other = _convert_other(other, raiseit=True)
3193
Facundo Batista353750c2007-09-13 18:13:15 +00003194 if not self._islogical() or not other._islogical():
3195 return context._raise_error(InvalidOperation)
3196
3197 # fill to context.prec
3198 (opa, opb) = self._fill_logical(context, self._int, other._int)
3199
3200 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003201 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003202 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003203
3204 def logical_xor(self, other, context=None):
3205 """Applies an 'xor' operation between self and other's digits."""
3206 if context is None:
3207 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003208
3209 other = _convert_other(other, raiseit=True)
3210
Facundo Batista353750c2007-09-13 18:13:15 +00003211 if not self._islogical() or not other._islogical():
3212 return context._raise_error(InvalidOperation)
3213
3214 # fill to context.prec
3215 (opa, opb) = self._fill_logical(context, self._int, other._int)
3216
3217 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003218 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003219 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003220
3221 def max_mag(self, other, context=None):
3222 """Compares the values numerically with their sign ignored."""
3223 other = _convert_other(other, raiseit=True)
3224
Facundo Batista6c398da2007-09-17 17:30:13 +00003225 if context is None:
3226 context = getcontext()
3227
Facundo Batista353750c2007-09-13 18:13:15 +00003228 if self._is_special or other._is_special:
3229 # If one operand is a quiet NaN and the other is number, then the
3230 # number is always returned
3231 sn = self._isnan()
3232 on = other._isnan()
3233 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003234 if on == 1 and sn == 0:
3235 return self._fix(context)
3236 if sn == 1 and on == 0:
3237 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003238 return self._check_nans(other, context)
3239
Mark Dickinson2fc92632008-02-06 22:10:50 +00003240 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003241 if c == 0:
3242 c = self.compare_total(other)
3243
3244 if c == -1:
3245 ans = other
3246 else:
3247 ans = self
3248
Facundo Batistae64acfa2007-12-17 14:18:42 +00003249 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003250
3251 def min_mag(self, other, context=None):
3252 """Compares the values numerically with their sign ignored."""
3253 other = _convert_other(other, raiseit=True)
3254
Facundo Batista6c398da2007-09-17 17:30:13 +00003255 if context is None:
3256 context = getcontext()
3257
Facundo Batista353750c2007-09-13 18:13:15 +00003258 if self._is_special or other._is_special:
3259 # If one operand is a quiet NaN and the other is number, then the
3260 # number is always returned
3261 sn = self._isnan()
3262 on = other._isnan()
3263 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003264 if on == 1 and sn == 0:
3265 return self._fix(context)
3266 if sn == 1 and on == 0:
3267 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003268 return self._check_nans(other, context)
3269
Mark Dickinson2fc92632008-02-06 22:10:50 +00003270 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003271 if c == 0:
3272 c = self.compare_total(other)
3273
3274 if c == -1:
3275 ans = self
3276 else:
3277 ans = other
3278
Facundo Batistae64acfa2007-12-17 14:18:42 +00003279 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003280
3281 def next_minus(self, context=None):
3282 """Returns the largest representable number smaller than itself."""
3283 if context is None:
3284 context = getcontext()
3285
3286 ans = self._check_nans(context=context)
3287 if ans:
3288 return ans
3289
3290 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003291 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003292 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003293 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003294
3295 context = context.copy()
3296 context._set_rounding(ROUND_FLOOR)
3297 context._ignore_all_flags()
3298 new_self = self._fix(context)
3299 if new_self != self:
3300 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003301 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3302 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003303
3304 def next_plus(self, context=None):
3305 """Returns the smallest representable number larger than itself."""
3306 if context is None:
3307 context = getcontext()
3308
3309 ans = self._check_nans(context=context)
3310 if ans:
3311 return ans
3312
3313 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003314 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003315 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003316 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003317
3318 context = context.copy()
3319 context._set_rounding(ROUND_CEILING)
3320 context._ignore_all_flags()
3321 new_self = self._fix(context)
3322 if new_self != self:
3323 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003324 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3325 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003326
3327 def next_toward(self, other, context=None):
3328 """Returns the number closest to self, in the direction towards other.
3329
3330 The result is the closest representable number to self
3331 (excluding self) that is in the direction towards other,
3332 unless both have the same value. If the two operands are
3333 numerically equal, then the result is a copy of self with the
3334 sign set to be the same as the sign of other.
3335 """
3336 other = _convert_other(other, raiseit=True)
3337
3338 if context is None:
3339 context = getcontext()
3340
3341 ans = self._check_nans(other, context)
3342 if ans:
3343 return ans
3344
Mark Dickinson2fc92632008-02-06 22:10:50 +00003345 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003346 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003347 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003348
3349 if comparison == -1:
3350 ans = self.next_plus(context)
3351 else: # comparison == 1
3352 ans = self.next_minus(context)
3353
3354 # decide which flags to raise using value of ans
3355 if ans._isinfinity():
3356 context._raise_error(Overflow,
3357 'Infinite result from next_toward',
3358 ans._sign)
3359 context._raise_error(Rounded)
3360 context._raise_error(Inexact)
3361 elif ans.adjusted() < context.Emin:
3362 context._raise_error(Underflow)
3363 context._raise_error(Subnormal)
3364 context._raise_error(Rounded)
3365 context._raise_error(Inexact)
3366 # if precision == 1 then we don't raise Clamped for a
3367 # result 0E-Etiny.
3368 if not ans:
3369 context._raise_error(Clamped)
3370
3371 return ans
3372
3373 def number_class(self, context=None):
3374 """Returns an indication of the class of self.
3375
3376 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003377 sNaN
3378 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003379 -Infinity
3380 -Normal
3381 -Subnormal
3382 -Zero
3383 +Zero
3384 +Subnormal
3385 +Normal
3386 +Infinity
3387 """
3388 if self.is_snan():
3389 return "sNaN"
3390 if self.is_qnan():
3391 return "NaN"
3392 inf = self._isinfinity()
3393 if inf == 1:
3394 return "+Infinity"
3395 if inf == -1:
3396 return "-Infinity"
3397 if self.is_zero():
3398 if self._sign:
3399 return "-Zero"
3400 else:
3401 return "+Zero"
3402 if context is None:
3403 context = getcontext()
3404 if self.is_subnormal(context=context):
3405 if self._sign:
3406 return "-Subnormal"
3407 else:
3408 return "+Subnormal"
3409 # just a normal, regular, boring number, :)
3410 if self._sign:
3411 return "-Normal"
3412 else:
3413 return "+Normal"
3414
3415 def radix(self):
3416 """Just returns 10, as this is Decimal, :)"""
3417 return Decimal(10)
3418
3419 def rotate(self, other, context=None):
3420 """Returns a rotated copy of self, value-of-other times."""
3421 if context is None:
3422 context = getcontext()
3423
Mark Dickinson0c673122009-10-29 12:04:00 +00003424 other = _convert_other(other, raiseit=True)
3425
Facundo Batista353750c2007-09-13 18:13:15 +00003426 ans = self._check_nans(other, context)
3427 if ans:
3428 return ans
3429
3430 if other._exp != 0:
3431 return context._raise_error(InvalidOperation)
3432 if not (-context.prec <= int(other) <= context.prec):
3433 return context._raise_error(InvalidOperation)
3434
3435 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003436 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003437
3438 # get values, pad if necessary
3439 torot = int(other)
3440 rotdig = self._int
3441 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003442 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003443 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003444 elif topad < 0:
3445 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003446
3447 # let's rotate!
3448 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003449 return _dec_from_triple(self._sign,
3450 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003451
Mark Dickinson0c673122009-10-29 12:04:00 +00003452 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003453 """Returns self operand after adding the second value to its exp."""
3454 if context is None:
3455 context = getcontext()
3456
Mark Dickinson0c673122009-10-29 12:04:00 +00003457 other = _convert_other(other, raiseit=True)
3458
Facundo Batista353750c2007-09-13 18:13:15 +00003459 ans = self._check_nans(other, context)
3460 if ans:
3461 return ans
3462
3463 if other._exp != 0:
3464 return context._raise_error(InvalidOperation)
3465 liminf = -2 * (context.Emax + context.prec)
3466 limsup = 2 * (context.Emax + context.prec)
3467 if not (liminf <= int(other) <= limsup):
3468 return context._raise_error(InvalidOperation)
3469
3470 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003471 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003472
Facundo Batista72bc54f2007-11-23 17:59:00 +00003473 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003474 d = d._fix(context)
3475 return d
3476
3477 def shift(self, other, context=None):
3478 """Returns a shifted copy of self, value-of-other times."""
3479 if context is None:
3480 context = getcontext()
3481
Mark Dickinson0c673122009-10-29 12:04:00 +00003482 other = _convert_other(other, raiseit=True)
3483
Facundo Batista353750c2007-09-13 18:13:15 +00003484 ans = self._check_nans(other, context)
3485 if ans:
3486 return ans
3487
3488 if other._exp != 0:
3489 return context._raise_error(InvalidOperation)
3490 if not (-context.prec <= int(other) <= context.prec):
3491 return context._raise_error(InvalidOperation)
3492
3493 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003494 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003495
3496 # get values, pad if necessary
3497 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003498 rotdig = self._int
3499 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003500 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003501 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003502 elif topad < 0:
3503 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003504
3505 # let's shift!
3506 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003507 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003508 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003509 shifted = rotdig + '0'*torot
3510 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003511
Facundo Batista72bc54f2007-11-23 17:59:00 +00003512 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003513 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003514
Facundo Batista59c58842007-04-10 12:58:45 +00003515 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003516 def __reduce__(self):
3517 return (self.__class__, (str(self),))
3518
3519 def __copy__(self):
3520 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003521 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003522 return self.__class__(str(self))
3523
3524 def __deepcopy__(self, memo):
3525 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003526 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003527 return self.__class__(str(self))
3528
Mark Dickinson277859d2009-03-17 23:03:46 +00003529 # PEP 3101 support. the _localeconv keyword argument should be
3530 # considered private: it's provided for ease of testing only.
3531 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003532 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003533
3534 The specifier should be a standard format specifier, with the
3535 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003536 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3537 type is omitted it defaults to 'g' or 'G', depending on the
3538 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003539 """
3540
3541 # Note: PEP 3101 says that if the type is not present then
3542 # there should be at least one digit after the decimal point.
3543 # We take the liberty of ignoring this requirement for
3544 # Decimal---it's presumably there to make sure that
3545 # format(float, '') behaves similarly to str(float).
3546 if context is None:
3547 context = getcontext()
3548
Mark Dickinson277859d2009-03-17 23:03:46 +00003549 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003550
Mark Dickinson277859d2009-03-17 23:03:46 +00003551 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003552 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003553 sign = _format_sign(self._sign, spec)
3554 body = str(self.copy_abs())
3555 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003556
3557 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003558 if spec['type'] is None:
3559 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003560
3561 # if type is '%', adjust exponent of self accordingly
3562 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003563 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3564
3565 # round if necessary, taking rounding mode from the context
3566 rounding = context.rounding
3567 precision = spec['precision']
3568 if precision is not None:
3569 if spec['type'] in 'eE':
3570 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003571 elif spec['type'] in 'fF%':
3572 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003573 elif spec['type'] in 'gG' and len(self._int) > precision:
3574 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003575 # special case: zeros with a positive exponent can't be
3576 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003577 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003578 self = self._rescale(0, rounding)
3579
3580 # figure out placement of the decimal point
3581 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003582 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003583 if not self and precision is not None:
3584 dotplace = 1 - precision
3585 else:
3586 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003587 elif spec['type'] in 'fF%':
3588 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003589 elif spec['type'] in 'gG':
3590 if self._exp <= 0 and leftdigits > -6:
3591 dotplace = leftdigits
3592 else:
3593 dotplace = 1
3594
Mark Dickinson277859d2009-03-17 23:03:46 +00003595 # find digits before and after decimal point, and get exponent
3596 if dotplace < 0:
3597 intpart = '0'
3598 fracpart = '0'*(-dotplace) + self._int
3599 elif dotplace > len(self._int):
3600 intpart = self._int + '0'*(dotplace-len(self._int))
3601 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003602 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003603 intpart = self._int[:dotplace] or '0'
3604 fracpart = self._int[dotplace:]
3605 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003606
Mark Dickinson277859d2009-03-17 23:03:46 +00003607 # done with the decimal-specific stuff; hand over the rest
3608 # of the formatting to the _format_number function
3609 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003610
Facundo Batista72bc54f2007-11-23 17:59:00 +00003611def _dec_from_triple(sign, coefficient, exponent, special=False):
3612 """Create a decimal instance directly, without any validation,
3613 normalization (e.g. removal of leading zeros) or argument
3614 conversion.
3615
3616 This function is for *internal use only*.
3617 """
3618
3619 self = object.__new__(Decimal)
3620 self._sign = sign
3621 self._int = coefficient
3622 self._exp = exponent
3623 self._is_special = special
3624
3625 return self
3626
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003627# Register Decimal as a kind of Number (an abstract base class).
3628# However, do not register it as Real (because Decimals are not
3629# interoperable with floats).
3630_numbers.Number.register(Decimal)
3631
3632
Facundo Batista59c58842007-04-10 12:58:45 +00003633##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003634
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003635
3636# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003637rounding_functions = [name for name in Decimal.__dict__.keys()
3638 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003639for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003640 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003641 globalname = name[1:].upper()
3642 val = globals()[globalname]
3643 Decimal._pick_rounding_function[val] = name
3644
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003645del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003646
Nick Coghlanced12182006-09-02 03:54:17 +00003647class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003648 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003649
Nick Coghlanced12182006-09-02 03:54:17 +00003650 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003651 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003652 """
3653 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003654 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003655 def __enter__(self):
3656 self.saved_context = getcontext()
3657 setcontext(self.new_context)
3658 return self.new_context
3659 def __exit__(self, t, v, tb):
3660 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003661
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003662class Context(object):
3663 """Contains the context for a Decimal instance.
3664
3665 Contains:
3666 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003667 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003668 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003669 raised when it is caused. Otherwise, a value is
3670 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003671 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003672 (Whether or not the trap_enabler is set)
3673 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003674 Emin - Minimum exponent
3675 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676 capitals - If 1, 1*10^1 is printed as 1E+1.
3677 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003678 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003679 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003680
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003681 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003682 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003683 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003684 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003685 _ignored_flags=None):
3686 if flags is None:
3687 flags = []
3688 if _ignored_flags is None:
3689 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003690 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003691 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003692 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003693 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003694 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003695 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003696 for name, val in locals().items():
3697 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003698 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003699 else:
3700 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003701 del self.self
3702
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003703 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003704 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003705 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003706 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3707 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3708 % vars(self))
3709 names = [f.__name__ for f, v in self.flags.items() if v]
3710 s.append('flags=[' + ', '.join(names) + ']')
3711 names = [t.__name__ for t, v in self.traps.items() if v]
3712 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003713 return ', '.join(s) + ')'
3714
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003715 def clear_flags(self):
3716 """Reset all flags to zero"""
3717 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003718 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003719
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003720 def _shallow_copy(self):
3721 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003722 nc = Context(self.prec, self.rounding, self.traps,
3723 self.flags, self.Emin, self.Emax,
3724 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003725 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003726
3727 def copy(self):
3728 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003729 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003730 self.flags.copy(), self.Emin, self.Emax,
3731 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003732 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003733 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003734
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003735 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003736 """Handles an error
3737
3738 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003739 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003740 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003741 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003742 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003743 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003744 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003745 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003746 return error().handle(self, *args)
3747
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003748 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003749 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003750 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003751 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003752
3753 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003754 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003755 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003756
3757 def _ignore_all_flags(self):
3758 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003759 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003760
3761 def _ignore_flags(self, *flags):
3762 """Ignore the flags, if they are raised"""
3763 # Do not mutate-- This way, copies of a context leave the original
3764 # alone.
3765 self._ignored_flags = (self._ignored_flags + list(flags))
3766 return list(flags)
3767
3768 def _regard_flags(self, *flags):
3769 """Stop ignoring the flags, if they are raised"""
3770 if flags and isinstance(flags[0], (tuple,list)):
3771 flags = flags[0]
3772 for flag in flags:
3773 self._ignored_flags.remove(flag)
3774
Nick Coghlan53663a62008-07-15 14:27:37 +00003775 # We inherit object.__hash__, so we must deny this explicitly
3776 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003777
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003778 def Etiny(self):
3779 """Returns Etiny (= Emin - prec + 1)"""
3780 return int(self.Emin - self.prec + 1)
3781
3782 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003783 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003784 return int(self.Emax - self.prec + 1)
3785
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003786 def _set_rounding(self, type):
3787 """Sets the rounding type.
3788
3789 Sets the rounding type, and returns the current (previous)
3790 rounding type. Often used like:
3791
3792 context = context.copy()
3793 # so you don't change the calling context
3794 # if an error occurs in the middle.
3795 rounding = context._set_rounding(ROUND_UP)
3796 val = self.__sub__(other, context=context)
3797 context._set_rounding(rounding)
3798
3799 This will make it round up for that operation.
3800 """
3801 rounding = self.rounding
3802 self.rounding= type
3803 return rounding
3804
Raymond Hettingerfed52962004-07-14 15:41:57 +00003805 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003806 """Creates a new Decimal instance but using self as context.
3807
3808 This method implements the to-number operation of the
3809 IBM Decimal specification."""
3810
3811 if isinstance(num, basestring) and num != num.strip():
3812 return self._raise_error(ConversionSyntax,
3813 "no trailing or leading whitespace is "
3814 "permitted.")
3815
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003817 if d._isnan() and len(d._int) > self.prec - self._clamp:
3818 return self._raise_error(ConversionSyntax,
3819 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003820 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003821
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003822 def create_decimal_from_float(self, f):
3823 """Creates a new Decimal instance from a float but rounding using self
3824 as the context.
3825
3826 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3827 >>> context.create_decimal_from_float(3.1415926535897932)
3828 Decimal('3.1415')
3829 >>> context = Context(prec=5, traps=[Inexact])
3830 >>> context.create_decimal_from_float(3.1415926535897932)
3831 Traceback (most recent call last):
3832 ...
3833 Inexact: None
3834
3835 """
3836 d = Decimal.from_float(f) # An exact conversion
3837 return d._fix(self) # Apply the context rounding
3838
Facundo Batista59c58842007-04-10 12:58:45 +00003839 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003840 def abs(self, a):
3841 """Returns the absolute value of the operand.
3842
3843 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003844 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003845 the plus operation on the operand.
3846
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003847 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003848 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003849 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003850 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003851 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003852 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003853 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003854 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003855 """
3856 return a.__abs__(context=self)
3857
3858 def add(self, a, b):
3859 """Return the sum of the two operands.
3860
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003861 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003862 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003863 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003864 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003865 """
3866 return a.__add__(b, context=self)
3867
3868 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003869 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003870
Facundo Batista353750c2007-09-13 18:13:15 +00003871 def canonical(self, a):
3872 """Returns the same Decimal object.
3873
3874 As we do not have different encodings for the same number, the
3875 received object already is in its canonical form.
3876
3877 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003878 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003879 """
3880 return a.canonical(context=self)
3881
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003882 def compare(self, a, b):
3883 """Compares values numerically.
3884
3885 If the signs of the operands differ, a value representing each operand
3886 ('-1' if the operand is less than zero, '0' if the operand is zero or
3887 negative zero, or '1' if the operand is greater than zero) is used in
3888 place of that operand for the comparison instead of the actual
3889 operand.
3890
3891 The comparison is then effected by subtracting the second operand from
3892 the first and then returning a value according to the result of the
3893 subtraction: '-1' if the result is less than zero, '0' if the result is
3894 zero or negative zero, or '1' if the result is greater than zero.
3895
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003896 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003897 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003898 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003899 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003900 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003901 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003902 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003903 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003904 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003905 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003906 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003907 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003908 """
3909 return a.compare(b, context=self)
3910
Facundo Batista353750c2007-09-13 18:13:15 +00003911 def compare_signal(self, a, b):
3912 """Compares the values of the two operands numerically.
3913
3914 It's pretty much like compare(), but all NaNs signal, with signaling
3915 NaNs taking precedence over quiet NaNs.
3916
3917 >>> c = ExtendedContext
3918 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003919 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003920 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003921 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003922 >>> c.flags[InvalidOperation] = 0
3923 >>> print c.flags[InvalidOperation]
3924 0
3925 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003926 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003927 >>> print c.flags[InvalidOperation]
3928 1
3929 >>> c.flags[InvalidOperation] = 0
3930 >>> print c.flags[InvalidOperation]
3931 0
3932 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003933 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003934 >>> print c.flags[InvalidOperation]
3935 1
3936 """
3937 return a.compare_signal(b, context=self)
3938
3939 def compare_total(self, a, b):
3940 """Compares two operands using their abstract representation.
3941
3942 This is not like the standard compare, which use their numerical
3943 value. Note that a total ordering is defined for all possible abstract
3944 representations.
3945
3946 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003947 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003948 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003949 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003950 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003951 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003952 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003953 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003954 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003955 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003956 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003957 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003958 """
3959 return a.compare_total(b)
3960
3961 def compare_total_mag(self, a, b):
3962 """Compares two operands using their abstract representation ignoring sign.
3963
3964 Like compare_total, but with operand's sign ignored and assumed to be 0.
3965 """
3966 return a.compare_total_mag(b)
3967
3968 def copy_abs(self, a):
3969 """Returns a copy of the operand with the sign set to 0.
3970
3971 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003973 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003974 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003975 """
3976 return a.copy_abs()
3977
3978 def copy_decimal(self, a):
3979 """Returns a copy of the decimal objet.
3980
3981 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003982 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003983 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003984 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003985 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003986 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003987
3988 def copy_negate(self, a):
3989 """Returns a copy of the operand with the sign inverted.
3990
3991 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003992 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003993 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003994 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003995 """
3996 return a.copy_negate()
3997
3998 def copy_sign(self, a, b):
3999 """Copies the second operand's sign to the first one.
4000
4001 In detail, it returns a copy of the first operand with the sign
4002 equal to the sign of the second operand.
4003
4004 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004005 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004006 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004007 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004008 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004009 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004010 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004012 """
4013 return a.copy_sign(b)
4014
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004015 def divide(self, a, b):
4016 """Decimal division in a specified context.
4017
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004018 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004019 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004020 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004021 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004022 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004023 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004024 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004025 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004026 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004027 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004028 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004029 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004030 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004031 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004032 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004033 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004034 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004035 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004036 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004037 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004038 """
4039 return a.__div__(b, context=self)
4040
4041 def divide_int(self, a, b):
4042 """Divides two numbers and returns the integer part of the result.
4043
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004044 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004045 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004046 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004047 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004048 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004049 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004050 """
4051 return a.__floordiv__(b, context=self)
4052
4053 def divmod(self, a, b):
4054 return a.__divmod__(b, context=self)
4055
Facundo Batista353750c2007-09-13 18:13:15 +00004056 def exp(self, a):
4057 """Returns e ** a.
4058
4059 >>> c = ExtendedContext.copy()
4060 >>> c.Emin = -999
4061 >>> c.Emax = 999
4062 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004063 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004064 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004065 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004067 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004068 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004069 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004070 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004071 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004072 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004073 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004074 """
4075 return a.exp(context=self)
4076
4077 def fma(self, a, b, c):
4078 """Returns a multiplied by b, plus c.
4079
4080 The first two operands are multiplied together, using multiply,
4081 the third operand is then added to the result of that
4082 multiplication, using add, all with only one final rounding.
4083
4084 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004085 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004086 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004087 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004088 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004089 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004090 """
4091 return a.fma(b, c, context=self)
4092
4093 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004094 """Return True if the operand is canonical; otherwise return False.
4095
4096 Currently, the encoding of a Decimal instance is always
4097 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004098
4099 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004100 True
Facundo Batista353750c2007-09-13 18:13:15 +00004101 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004102 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004103
4104 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004105 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004106
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 A Decimal instance is considered finite if it is neither
4108 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004109
4110 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004111 True
Facundo Batista353750c2007-09-13 18:13:15 +00004112 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004113 True
Facundo Batista353750c2007-09-13 18:13:15 +00004114 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004115 True
Facundo Batista353750c2007-09-13 18:13:15 +00004116 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004117 False
Facundo Batista353750c2007-09-13 18:13:15 +00004118 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004119 False
Facundo Batista353750c2007-09-13 18:13:15 +00004120 """
4121 return a.is_finite()
4122
4123 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004124 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004125
4126 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004127 False
Facundo Batista353750c2007-09-13 18:13:15 +00004128 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004129 True
Facundo Batista353750c2007-09-13 18:13:15 +00004130 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004131 False
Facundo Batista353750c2007-09-13 18:13:15 +00004132 """
4133 return a.is_infinite()
4134
4135 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004136 """Return True if the operand is a qNaN or sNaN;
4137 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004138
4139 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004140 False
Facundo Batista353750c2007-09-13 18:13:15 +00004141 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004142 True
Facundo Batista353750c2007-09-13 18:13:15 +00004143 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004144 True
Facundo Batista353750c2007-09-13 18:13:15 +00004145 """
4146 return a.is_nan()
4147
4148 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004149 """Return True if the operand is a normal number;
4150 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004151
4152 >>> c = ExtendedContext.copy()
4153 >>> c.Emin = -999
4154 >>> c.Emax = 999
4155 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004156 True
Facundo Batista353750c2007-09-13 18:13:15 +00004157 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004158 False
Facundo Batista353750c2007-09-13 18:13:15 +00004159 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004160 False
Facundo Batista353750c2007-09-13 18:13:15 +00004161 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004162 False
Facundo Batista353750c2007-09-13 18:13:15 +00004163 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004164 False
Facundo Batista353750c2007-09-13 18:13:15 +00004165 """
4166 return a.is_normal(context=self)
4167
4168 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004169 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004170
4171 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004172 False
Facundo Batista353750c2007-09-13 18:13:15 +00004173 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004174 True
Facundo Batista353750c2007-09-13 18:13:15 +00004175 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004176 False
Facundo Batista353750c2007-09-13 18:13:15 +00004177 """
4178 return a.is_qnan()
4179
4180 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004181 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004182
4183 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004184 False
Facundo Batista353750c2007-09-13 18:13:15 +00004185 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004186 True
Facundo Batista353750c2007-09-13 18:13:15 +00004187 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004188 True
Facundo Batista353750c2007-09-13 18:13:15 +00004189 """
4190 return a.is_signed()
4191
4192 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004193 """Return True if the operand is a signaling NaN;
4194 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004195
4196 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004197 False
Facundo Batista353750c2007-09-13 18:13:15 +00004198 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004199 False
Facundo Batista353750c2007-09-13 18:13:15 +00004200 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004201 True
Facundo Batista353750c2007-09-13 18:13:15 +00004202 """
4203 return a.is_snan()
4204
4205 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004206 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004207
4208 >>> c = ExtendedContext.copy()
4209 >>> c.Emin = -999
4210 >>> c.Emax = 999
4211 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004212 False
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004214 True
Facundo Batista353750c2007-09-13 18:13:15 +00004215 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004216 False
Facundo Batista353750c2007-09-13 18:13:15 +00004217 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004218 False
Facundo Batista353750c2007-09-13 18:13:15 +00004219 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004220 False
Facundo Batista353750c2007-09-13 18:13:15 +00004221 """
4222 return a.is_subnormal(context=self)
4223
4224 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004225 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004226
4227 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004228 True
Facundo Batista353750c2007-09-13 18:13:15 +00004229 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004230 False
Facundo Batista353750c2007-09-13 18:13:15 +00004231 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004232 True
Facundo Batista353750c2007-09-13 18:13:15 +00004233 """
4234 return a.is_zero()
4235
4236 def ln(self, a):
4237 """Returns the natural (base e) logarithm of the operand.
4238
4239 >>> c = ExtendedContext.copy()
4240 >>> c.Emin = -999
4241 >>> c.Emax = 999
4242 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004243 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004244 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004245 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004246 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004247 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004248 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004249 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004250 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004251 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004252 """
4253 return a.ln(context=self)
4254
4255 def log10(self, a):
4256 """Returns the base 10 logarithm of the operand.
4257
4258 >>> c = ExtendedContext.copy()
4259 >>> c.Emin = -999
4260 >>> c.Emax = 999
4261 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004262 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004263 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004264 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004265 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004266 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004267 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004268 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004269 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004270 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004271 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 """
4276 return a.log10(context=self)
4277
4278 def logb(self, a):
4279 """ Returns the exponent of the magnitude of the operand's MSD.
4280
4281 The result is the integer which is the exponent of the magnitude
4282 of the most significant digit of the operand (as though the
4283 operand were truncated to a single digit while maintaining the
4284 value of that digit and without limiting the resulting exponent).
4285
4286 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004287 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004288 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004289 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004290 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004291 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004292 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004293 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004294 """
4295 return a.logb(context=self)
4296
4297 def logical_and(self, a, b):
4298 """Applies the logical operation 'and' between each operand's digits.
4299
4300 The operands must be both logical numbers.
4301
4302 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004303 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004304 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004305 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004306 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004307 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004308 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004309 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004310 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004311 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004312 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004313 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004314 """
4315 return a.logical_and(b, context=self)
4316
4317 def logical_invert(self, a):
4318 """Invert all the digits in the operand.
4319
4320 The operand must be a logical number.
4321
4322 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004323 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004324 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004325 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004326 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004327 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004328 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004329 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004330 """
4331 return a.logical_invert(context=self)
4332
4333 def logical_or(self, a, b):
4334 """Applies the logical operation 'or' between each operand's digits.
4335
4336 The operands must be both logical numbers.
4337
4338 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004339 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004340 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004341 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004342 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004343 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004344 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004345 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004346 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004347 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004348 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004349 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004350 """
4351 return a.logical_or(b, context=self)
4352
4353 def logical_xor(self, a, b):
4354 """Applies the logical operation 'xor' between each operand's digits.
4355
4356 The operands must be both logical numbers.
4357
4358 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004359 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004360 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004361 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004362 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004363 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004364 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004365 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004366 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004367 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004368 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004369 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004370 """
4371 return a.logical_xor(b, context=self)
4372
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004373 def max(self, a,b):
4374 """max compares two values numerically and returns the maximum.
4375
4376 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004377 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004378 operation. If they are numerically equal then the left-hand operand
4379 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004380 infinity) of the two operands is chosen as the result.
4381
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004382 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004383 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004384 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004385 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004386 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004387 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004388 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004389 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004390 """
4391 return a.max(b, context=self)
4392
Facundo Batista353750c2007-09-13 18:13:15 +00004393 def max_mag(self, a, b):
4394 """Compares the values numerically with their sign ignored."""
4395 return a.max_mag(b, context=self)
4396
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004397 def min(self, a,b):
4398 """min compares two values numerically and returns the minimum.
4399
4400 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004401 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004402 operation. If they are numerically equal then the left-hand operand
4403 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004404 infinity) of the two operands is chosen as the result.
4405
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004406 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004407 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004408 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004409 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004410 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004411 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004412 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004413 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004414 """
4415 return a.min(b, context=self)
4416
Facundo Batista353750c2007-09-13 18:13:15 +00004417 def min_mag(self, a, b):
4418 """Compares the values numerically with their sign ignored."""
4419 return a.min_mag(b, context=self)
4420
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004421 def minus(self, a):
4422 """Minus corresponds to unary prefix minus in Python.
4423
4424 The operation is evaluated using the same rules as subtract; the
4425 operation minus(a) is calculated as subtract('0', a) where the '0'
4426 has the same exponent as the operand.
4427
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004428 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004429 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004430 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004431 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004432 """
4433 return a.__neg__(context=self)
4434
4435 def multiply(self, a, b):
4436 """multiply multiplies two operands.
4437
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004438 If either operand is a special value then the general rules apply.
4439 Otherwise, the operands are multiplied together ('long multiplication'),
4440 resulting in a number which may be as long as the sum of the lengths
4441 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004442
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004443 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004444 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004445 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004446 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004447 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004448 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004449 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004450 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004451 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004452 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004453 """
4454 return a.__mul__(b, context=self)
4455
Facundo Batista353750c2007-09-13 18:13:15 +00004456 def next_minus(self, a):
4457 """Returns the largest representable number smaller than a.
4458
4459 >>> c = ExtendedContext.copy()
4460 >>> c.Emin = -999
4461 >>> c.Emax = 999
4462 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004463 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004464 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004465 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004466 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004467 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004468 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004469 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004470 """
4471 return a.next_minus(context=self)
4472
4473 def next_plus(self, a):
4474 """Returns the smallest representable number larger than a.
4475
4476 >>> c = ExtendedContext.copy()
4477 >>> c.Emin = -999
4478 >>> c.Emax = 999
4479 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004481 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004482 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004483 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004484 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004485 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004486 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004487 """
4488 return a.next_plus(context=self)
4489
4490 def next_toward(self, a, b):
4491 """Returns the number closest to a, in direction towards b.
4492
4493 The result is the closest representable number from the first
4494 operand (but not the first operand) that is in the direction
4495 towards the second operand, unless the operands have the same
4496 value.
4497
4498 >>> c = ExtendedContext.copy()
4499 >>> c.Emin = -999
4500 >>> c.Emax = 999
4501 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004502 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004503 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004504 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004505 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004506 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004507 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004508 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004509 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004510 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004511 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004512 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004513 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004514 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004515 """
4516 return a.next_toward(b, context=self)
4517
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004518 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004519 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004520
4521 Essentially a plus operation with all trailing zeros removed from the
4522 result.
4523
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004524 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004525 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004526 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004528 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004529 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004530 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004531 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004532 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004533 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004534 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004535 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004536 """
4537 return a.normalize(context=self)
4538
Facundo Batista353750c2007-09-13 18:13:15 +00004539 def number_class(self, a):
4540 """Returns an indication of the class of the operand.
4541
4542 The class is one of the following strings:
4543 -sNaN
4544 -NaN
4545 -Infinity
4546 -Normal
4547 -Subnormal
4548 -Zero
4549 +Zero
4550 +Subnormal
4551 +Normal
4552 +Infinity
4553
4554 >>> c = Context(ExtendedContext)
4555 >>> c.Emin = -999
4556 >>> c.Emax = 999
4557 >>> c.number_class(Decimal('Infinity'))
4558 '+Infinity'
4559 >>> c.number_class(Decimal('1E-10'))
4560 '+Normal'
4561 >>> c.number_class(Decimal('2.50'))
4562 '+Normal'
4563 >>> c.number_class(Decimal('0.1E-999'))
4564 '+Subnormal'
4565 >>> c.number_class(Decimal('0'))
4566 '+Zero'
4567 >>> c.number_class(Decimal('-0'))
4568 '-Zero'
4569 >>> c.number_class(Decimal('-0.1E-999'))
4570 '-Subnormal'
4571 >>> c.number_class(Decimal('-1E-10'))
4572 '-Normal'
4573 >>> c.number_class(Decimal('-2.50'))
4574 '-Normal'
4575 >>> c.number_class(Decimal('-Infinity'))
4576 '-Infinity'
4577 >>> c.number_class(Decimal('NaN'))
4578 'NaN'
4579 >>> c.number_class(Decimal('-NaN'))
4580 'NaN'
4581 >>> c.number_class(Decimal('sNaN'))
4582 'sNaN'
4583 """
4584 return a.number_class(context=self)
4585
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004586 def plus(self, a):
4587 """Plus corresponds to unary prefix plus in Python.
4588
4589 The operation is evaluated using the same rules as add; the
4590 operation plus(a) is calculated as add('0', a) where the '0'
4591 has the same exponent as the operand.
4592
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004593 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004594 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004595 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004596 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004597 """
4598 return a.__pos__(context=self)
4599
4600 def power(self, a, b, modulo=None):
4601 """Raises a to the power of b, to modulo if given.
4602
Facundo Batista353750c2007-09-13 18:13:15 +00004603 With two arguments, compute a**b. If a is negative then b
4604 must be integral. The result will be inexact unless b is
4605 integral and the result is finite and can be expressed exactly
4606 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004607
Facundo Batista353750c2007-09-13 18:13:15 +00004608 With three arguments, compute (a**b) % modulo. For the
4609 three argument form, the following restrictions on the
4610 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004611
Facundo Batista353750c2007-09-13 18:13:15 +00004612 - all three arguments must be integral
4613 - b must be nonnegative
4614 - at least one of a or b must be nonzero
4615 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004616
Facundo Batista353750c2007-09-13 18:13:15 +00004617 The result of pow(a, b, modulo) is identical to the result
4618 that would be obtained by computing (a**b) % modulo with
4619 unbounded precision, but is computed more efficiently. It is
4620 always exact.
4621
4622 >>> c = ExtendedContext.copy()
4623 >>> c.Emin = -999
4624 >>> c.Emax = 999
4625 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004626 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004627 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004628 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004629 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004630 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004631 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004632 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004633 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004634 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004635 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004636 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004637 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004638 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004639 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004640 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004641 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004642 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004643 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004644 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004645 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004646 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004647 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004648 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004649 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004650 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004651
4652 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004654 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004655 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004656 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004657 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004658 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004659 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004660 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004661 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004662 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004663 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004664 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004665 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004666 """
4667 return a.__pow__(b, modulo, context=self)
4668
4669 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004670 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004671
4672 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004673 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004674 exponent is being increased), multiplied by a positive power of ten (if
4675 the exponent is being decreased), or is unchanged (if the exponent is
4676 already equal to that of the right-hand operand).
4677
4678 Unlike other operations, if the length of the coefficient after the
4679 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004680 operation condition is raised. This guarantees that, unless there is
4681 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004682 equal to that of the right-hand operand.
4683
4684 Also unlike other operations, quantize will never raise Underflow, even
4685 if the result is subnormal and inexact.
4686
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004687 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004688 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004689 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004690 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004691 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004692 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004693 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004694 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004695 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004696 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004697 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004698 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004699 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004700 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004701 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004702 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004703 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004704 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004705 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004706 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004707 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004708 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004709 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004710 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004711 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004712 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004713 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004714 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004715 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004716 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004717 """
4718 return a.quantize(b, context=self)
4719
Facundo Batista353750c2007-09-13 18:13:15 +00004720 def radix(self):
4721 """Just returns 10, as this is Decimal, :)
4722
4723 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004724 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004725 """
4726 return Decimal(10)
4727
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004728 def remainder(self, a, b):
4729 """Returns the remainder from integer division.
4730
4731 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004732 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004733 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004734 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004735
4736 This operation will fail under the same conditions as integer division
4737 (that is, if integer division on the same two operands would fail, the
4738 remainder cannot be calculated).
4739
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004740 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004741 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004742 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004743 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004744 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004745 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004746 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004747 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004748 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004749 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004750 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004751 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004752 """
4753 return a.__mod__(b, context=self)
4754
4755 def remainder_near(self, a, b):
4756 """Returns to be "a - b * n", where n is the integer nearest the exact
4757 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004758 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004759 sign of a.
4760
4761 This operation will fail under the same conditions as integer division
4762 (that is, if integer division on the same two operands would fail, the
4763 remainder cannot be calculated).
4764
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004765 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004766 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004767 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004768 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004769 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004770 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004771 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004773 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004774 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004775 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004776 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004777 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004778 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004779 """
4780 return a.remainder_near(b, context=self)
4781
Facundo Batista353750c2007-09-13 18:13:15 +00004782 def rotate(self, a, b):
4783 """Returns a rotated copy of a, b times.
4784
4785 The coefficient of the result is a rotated copy of the digits in
4786 the coefficient of the first operand. The number of places of
4787 rotation is taken from the absolute value of the second operand,
4788 with the rotation being to the left if the second operand is
4789 positive or to the right otherwise.
4790
4791 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004792 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004793 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004794 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004795 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004796 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004797 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004798 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004799 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004800 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004801 """
4802 return a.rotate(b, context=self)
4803
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004804 def same_quantum(self, a, b):
4805 """Returns True if the two operands have the same exponent.
4806
4807 The result is never affected by either the sign or the coefficient of
4808 either operand.
4809
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004810 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004811 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004812 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004813 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004814 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004815 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004816 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004817 True
4818 """
4819 return a.same_quantum(b)
4820
Facundo Batista353750c2007-09-13 18:13:15 +00004821 def scaleb (self, a, b):
4822 """Returns the first operand after adding the second value its exp.
4823
4824 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004825 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004826 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004827 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004828 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004829 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004830 """
4831 return a.scaleb (b, context=self)
4832
4833 def shift(self, a, b):
4834 """Returns a shifted copy of a, b times.
4835
4836 The coefficient of the result is a shifted copy of the digits
4837 in the coefficient of the first operand. The number of places
4838 to shift is taken from the absolute value of the second operand,
4839 with the shift being to the left if the second operand is
4840 positive or to the right otherwise. Digits shifted into the
4841 coefficient are zeros.
4842
4843 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004844 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004845 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004846 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004847 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004848 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004849 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004850 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004851 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004852 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004853 """
4854 return a.shift(b, context=self)
4855
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004856 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004857 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004858
4859 If the result must be inexact, it is rounded using the round-half-even
4860 algorithm.
4861
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004862 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004863 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004864 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004865 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004866 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004867 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004868 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004869 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004870 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004871 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004872 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004873 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004874 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004875 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004876 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004877 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004878 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004879 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004880 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004881 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004882 """
4883 return a.sqrt(context=self)
4884
4885 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004886 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004887
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004888 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004889 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004890 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004891 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004892 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004893 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004894 """
4895 return a.__sub__(b, context=self)
4896
4897 def to_eng_string(self, a):
4898 """Converts a number to a string, using scientific notation.
4899
4900 The operation is not affected by the context.
4901 """
4902 return a.to_eng_string(context=self)
4903
4904 def to_sci_string(self, a):
4905 """Converts a number to a string, using scientific notation.
4906
4907 The operation is not affected by the context.
4908 """
4909 return a.__str__(context=self)
4910
Facundo Batista353750c2007-09-13 18:13:15 +00004911 def to_integral_exact(self, a):
4912 """Rounds to an integer.
4913
4914 When the operand has a negative exponent, the result is the same
4915 as using the quantize() operation using the given operand as the
4916 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4917 of the operand as the precision setting; Inexact and Rounded flags
4918 are allowed in this operation. The rounding mode is taken from the
4919 context.
4920
4921 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004922 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004923 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004924 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004925 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004926 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004927 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004928 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004929 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004930 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004931 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004932 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004933 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004934 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004935 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004936 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004937 """
4938 return a.to_integral_exact(context=self)
4939
4940 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004941 """Rounds to an integer.
4942
4943 When the operand has a negative exponent, the result is the same
4944 as using the quantize() operation using the given operand as the
4945 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4946 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004947 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004948
Facundo Batista353750c2007-09-13 18:13:15 +00004949 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004950 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004951 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004952 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004953 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004954 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004955 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004956 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004957 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004958 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004959 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004960 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004961 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004962 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004963 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004964 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004965 """
Facundo Batista353750c2007-09-13 18:13:15 +00004966 return a.to_integral_value(context=self)
4967
4968 # the method name changed, but we provide also the old one, for compatibility
4969 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004970
4971class _WorkRep(object):
4972 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004973 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004974 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004975 # exp: None, int, or string
4976
4977 def __init__(self, value=None):
4978 if value is None:
4979 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004980 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004981 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004982 elif isinstance(value, Decimal):
4983 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004984 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004985 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004986 else:
4987 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004988 self.sign = value[0]
4989 self.int = value[1]
4990 self.exp = value[2]
4991
4992 def __repr__(self):
4993 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4994
4995 __str__ = __repr__
4996
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004997
4998
Facundo Batistae64acfa2007-12-17 14:18:42 +00004999def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005000 """Normalizes op1, op2 to have the same exp and length of coefficient.
5001
5002 Done during addition.
5003 """
Facundo Batista353750c2007-09-13 18:13:15 +00005004 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005005 tmp = op2
5006 other = op1
5007 else:
5008 tmp = op1
5009 other = op2
5010
Facundo Batista353750c2007-09-13 18:13:15 +00005011 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5012 # Then adding 10**exp to tmp has the same effect (after rounding)
5013 # as adding any positive quantity smaller than 10**exp; similarly
5014 # for subtraction. So if other is smaller than 10**exp we replace
5015 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005016 tmp_len = len(str(tmp.int))
5017 other_len = len(str(other.int))
5018 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5019 if other_len + other.exp - 1 < exp:
5020 other.int = 1
5021 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005022
Facundo Batista353750c2007-09-13 18:13:15 +00005023 tmp.int *= 10 ** (tmp.exp - other.exp)
5024 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005025 return op1, op2
5026
Facundo Batista353750c2007-09-13 18:13:15 +00005027##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5028
5029# This function from Tim Peters was taken from here:
5030# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5031# The correction being in the function definition is for speed, and
5032# the whole function is not resolved with math.log because of avoiding
5033# the use of floats.
5034def _nbits(n, correction = {
5035 '0': 4, '1': 3, '2': 2, '3': 2,
5036 '4': 1, '5': 1, '6': 1, '7': 1,
5037 '8': 0, '9': 0, 'a': 0, 'b': 0,
5038 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5039 """Number of bits in binary representation of the positive integer n,
5040 or 0 if n == 0.
5041 """
5042 if n < 0:
5043 raise ValueError("The argument to _nbits should be nonnegative.")
5044 hex_n = "%x" % n
5045 return 4*len(hex_n) - correction[hex_n[0]]
5046
5047def _sqrt_nearest(n, a):
5048 """Closest integer to the square root of the positive integer n. a is
5049 an initial approximation to the square root. Any positive integer
5050 will do for a, but the closer a is to the square root of n the
5051 faster convergence will be.
5052
5053 """
5054 if n <= 0 or a <= 0:
5055 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5056
5057 b=0
5058 while a != b:
5059 b, a = a, a--n//a>>1
5060 return a
5061
5062def _rshift_nearest(x, shift):
5063 """Given an integer x and a nonnegative integer shift, return closest
5064 integer to x / 2**shift; use round-to-even in case of a tie.
5065
5066 """
5067 b, q = 1L << shift, x >> shift
5068 return q + (2*(x & (b-1)) + (q&1) > b)
5069
5070def _div_nearest(a, b):
5071 """Closest integer to a/b, a and b positive integers; rounds to even
5072 in the case of a tie.
5073
5074 """
5075 q, r = divmod(a, b)
5076 return q + (2*r + (q&1) > b)
5077
5078def _ilog(x, M, L = 8):
5079 """Integer approximation to M*log(x/M), with absolute error boundable
5080 in terms only of x/M.
5081
5082 Given positive integers x and M, return an integer approximation to
5083 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5084 between the approximation and the exact result is at most 22. For
5085 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5086 both cases these are upper bounds on the error; it will usually be
5087 much smaller."""
5088
5089 # The basic algorithm is the following: let log1p be the function
5090 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5091 # the reduction
5092 #
5093 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5094 #
5095 # repeatedly until the argument to log1p is small (< 2**-L in
5096 # absolute value). For small y we can use the Taylor series
5097 # expansion
5098 #
5099 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5100 #
5101 # truncating at T such that y**T is small enough. The whole
5102 # computation is carried out in a form of fixed-point arithmetic,
5103 # with a real number z being represented by an integer
5104 # approximation to z*M. To avoid loss of precision, the y below
5105 # is actually an integer approximation to 2**R*y*M, where R is the
5106 # number of reductions performed so far.
5107
5108 y = x-M
5109 # argument reduction; R = number of reductions performed
5110 R = 0
5111 while (R <= L and long(abs(y)) << L-R >= M or
5112 R > L and abs(y) >> R-L >= M):
5113 y = _div_nearest(long(M*y) << 1,
5114 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5115 R += 1
5116
5117 # Taylor series with T terms
5118 T = -int(-10*len(str(M))//(3*L))
5119 yshift = _rshift_nearest(y, R)
5120 w = _div_nearest(M, T)
5121 for k in xrange(T-1, 0, -1):
5122 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5123
5124 return _div_nearest(w*y, M)
5125
5126def _dlog10(c, e, p):
5127 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5128 approximation to 10**p * log10(c*10**e), with an absolute error of
5129 at most 1. Assumes that c*10**e is not exactly 1."""
5130
5131 # increase precision by 2; compensate for this by dividing
5132 # final result by 100
5133 p += 2
5134
5135 # write c*10**e as d*10**f with either:
5136 # f >= 0 and 1 <= d <= 10, or
5137 # f <= 0 and 0.1 <= d <= 1.
5138 # Thus for c*10**e close to 1, f = 0
5139 l = len(str(c))
5140 f = e+l - (e+l >= 1)
5141
5142 if p > 0:
5143 M = 10**p
5144 k = e+p-f
5145 if k >= 0:
5146 c *= 10**k
5147 else:
5148 c = _div_nearest(c, 10**-k)
5149
5150 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005151 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005152 log_d = _div_nearest(log_d*M, log_10)
5153 log_tenpower = f*M # exact
5154 else:
5155 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005156 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005157
5158 return _div_nearest(log_tenpower+log_d, 100)
5159
5160def _dlog(c, e, p):
5161 """Given integers c, e and p with c > 0, compute an integer
5162 approximation to 10**p * log(c*10**e), with an absolute error of
5163 at most 1. Assumes that c*10**e is not exactly 1."""
5164
5165 # Increase precision by 2. The precision increase is compensated
5166 # for at the end with a division by 100.
5167 p += 2
5168
5169 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5170 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5171 # as 10**p * log(d) + 10**p*f * log(10).
5172 l = len(str(c))
5173 f = e+l - (e+l >= 1)
5174
5175 # compute approximation to 10**p*log(d), with error < 27
5176 if p > 0:
5177 k = e+p-f
5178 if k >= 0:
5179 c *= 10**k
5180 else:
5181 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5182
5183 # _ilog magnifies existing error in c by a factor of at most 10
5184 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5185 else:
5186 # p <= 0: just approximate the whole thing by 0; error < 2.31
5187 log_d = 0
5188
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005189 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005190 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005191 extra = len(str(abs(f)))-1
5192 if p + extra >= 0:
5193 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5194 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5195 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005196 else:
5197 f_log_ten = 0
5198 else:
5199 f_log_ten = 0
5200
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005201 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005202 return _div_nearest(f_log_ten + log_d, 100)
5203
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005204class _Log10Memoize(object):
5205 """Class to compute, store, and allow retrieval of, digits of the
5206 constant log(10) = 2.302585.... This constant is needed by
5207 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5208 def __init__(self):
5209 self.digits = "23025850929940456840179914546843642076011014886"
5210
5211 def getdigits(self, p):
5212 """Given an integer p >= 0, return floor(10**p)*log(10).
5213
5214 For example, self.getdigits(3) returns 2302.
5215 """
5216 # digits are stored as a string, for quick conversion to
5217 # integer in the case that we've already computed enough
5218 # digits; the stored digits should always be correct
5219 # (truncated, not rounded to nearest).
5220 if p < 0:
5221 raise ValueError("p should be nonnegative")
5222
5223 if p >= len(self.digits):
5224 # compute p+3, p+6, p+9, ... digits; continue until at
5225 # least one of the extra digits is nonzero
5226 extra = 3
5227 while True:
5228 # compute p+extra digits, correct to within 1ulp
5229 M = 10**(p+extra+2)
5230 digits = str(_div_nearest(_ilog(10*M, M), 100))
5231 if digits[-extra:] != '0'*extra:
5232 break
5233 extra += 3
5234 # keep all reliable digits so far; remove trailing zeros
5235 # and next nonzero digit
5236 self.digits = digits.rstrip('0')[:-1]
5237 return int(self.digits[:p+1])
5238
5239_log10_digits = _Log10Memoize().getdigits
5240
Facundo Batista353750c2007-09-13 18:13:15 +00005241def _iexp(x, M, L=8):
5242 """Given integers x and M, M > 0, such that x/M is small in absolute
5243 value, compute an integer approximation to M*exp(x/M). For 0 <=
5244 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5245 is usually much smaller)."""
5246
5247 # Algorithm: to compute exp(z) for a real number z, first divide z
5248 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5249 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5250 # series
5251 #
5252 # expm1(x) = x + x**2/2! + x**3/3! + ...
5253 #
5254 # Now use the identity
5255 #
5256 # expm1(2x) = expm1(x)*(expm1(x)+2)
5257 #
5258 # R times to compute the sequence expm1(z/2**R),
5259 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5260
5261 # Find R such that x/2**R/M <= 2**-L
5262 R = _nbits((long(x)<<L)//M)
5263
5264 # Taylor series. (2**L)**T > M
5265 T = -int(-10*len(str(M))//(3*L))
5266 y = _div_nearest(x, T)
5267 Mshift = long(M)<<R
5268 for i in xrange(T-1, 0, -1):
5269 y = _div_nearest(x*(Mshift + y), Mshift * i)
5270
5271 # Expansion
5272 for k in xrange(R-1, -1, -1):
5273 Mshift = long(M)<<(k+2)
5274 y = _div_nearest(y*(y+Mshift), Mshift)
5275
5276 return M+y
5277
5278def _dexp(c, e, p):
5279 """Compute an approximation to exp(c*10**e), with p decimal places of
5280 precision.
5281
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005282 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005283
5284 10**(p-1) <= d <= 10**p, and
5285 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5286
5287 In other words, d*10**f is an approximation to exp(c*10**e) with p
5288 digits of precision, and with an error in d of at most 1. This is
5289 almost, but not quite, the same as the error being < 1ulp: when d
5290 = 10**(p-1) the error could be up to 10 ulp."""
5291
5292 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5293 p += 2
5294
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005295 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005296 extra = max(0, e + len(str(c)) - 1)
5297 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005298
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005299 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005300 # rounding down
5301 shift = e+q
5302 if shift >= 0:
5303 cshift = c*10**shift
5304 else:
5305 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005306 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005307
5308 # reduce remainder back to original precision
5309 rem = _div_nearest(rem, 10**extra)
5310
5311 # error in result of _iexp < 120; error after division < 0.62
5312 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5313
5314def _dpower(xc, xe, yc, ye, p):
5315 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5316 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5317
5318 10**(p-1) <= c <= 10**p, and
5319 (c-1)*10**e < x**y < (c+1)*10**e
5320
5321 in other words, c*10**e is an approximation to x**y with p digits
5322 of precision, and with an error in c of at most 1. (This is
5323 almost, but not quite, the same as the error being < 1ulp: when c
5324 == 10**(p-1) we can only guarantee error < 10ulp.)
5325
5326 We assume that: x is positive and not equal to 1, and y is nonzero.
5327 """
5328
5329 # Find b such that 10**(b-1) <= |y| <= 10**b
5330 b = len(str(abs(yc))) + ye
5331
5332 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5333 lxc = _dlog(xc, xe, p+b+1)
5334
5335 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5336 shift = ye-b
5337 if shift >= 0:
5338 pc = lxc*yc*10**shift
5339 else:
5340 pc = _div_nearest(lxc*yc, 10**-shift)
5341
5342 if pc == 0:
5343 # we prefer a result that isn't exactly 1; this makes it
5344 # easier to compute a correctly rounded result in __pow__
5345 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5346 coeff, exp = 10**(p-1)+1, 1-p
5347 else:
5348 coeff, exp = 10**p-1, -p
5349 else:
5350 coeff, exp = _dexp(pc, -(p+1), p+1)
5351 coeff = _div_nearest(coeff, 10)
5352 exp += 1
5353
5354 return coeff, exp
5355
5356def _log10_lb(c, correction = {
5357 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5358 '6': 23, '7': 16, '8': 10, '9': 5}):
5359 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5360 if c <= 0:
5361 raise ValueError("The argument to _log10_lb should be nonnegative.")
5362 str_c = str(c)
5363 return 100*len(str_c) - correction[str_c[0]]
5364
Facundo Batista59c58842007-04-10 12:58:45 +00005365##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005366
Facundo Batista353750c2007-09-13 18:13:15 +00005367def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005368 """Convert other to Decimal.
5369
5370 Verifies that it's ok to use in an implicit construction.
5371 """
5372 if isinstance(other, Decimal):
5373 return other
5374 if isinstance(other, (int, long)):
5375 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005376 if raiseit:
5377 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005378 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005379
Facundo Batista59c58842007-04-10 12:58:45 +00005380##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005381
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005382# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005383# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005384
5385DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005386 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005387 traps=[DivisionByZero, Overflow, InvalidOperation],
5388 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005389 Emax=999999999,
5390 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005391 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005392)
5393
5394# Pre-made alternate contexts offered by the specification
5395# Don't change these; the user should be able to select these
5396# contexts and be able to reproduce results from other implementations
5397# of the spec.
5398
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005399BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005400 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005401 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5402 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005403)
5404
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005405ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005406 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005407 traps=[],
5408 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005409)
5410
5411
Facundo Batista72bc54f2007-11-23 17:59:00 +00005412##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005413#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005414# Regular expression used for parsing numeric strings. Additional
5415# comments:
5416#
5417# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5418# whitespace. But note that the specification disallows whitespace in
5419# a numeric string.
5420#
5421# 2. For finite numbers (not infinities and NaNs) the body of the
5422# number between the optional sign and the optional exponent must have
5423# at least one decimal digit, possibly after the decimal point. The
5424# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005425
5426import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005427_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005428# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005429 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005430 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005431 (?=\d|\.\d) # ...a number (with at least one digit)
5432 (?P<int>\d*) # having a (possibly empty) integer part
5433 (\.(?P<frac>\d*))? # followed by an optional fractional part
5434 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005435 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005436 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005437 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005438 (?P<signal>s)? # ...an (optionally signaling)
5439 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005440 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005441 )
5442# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005443 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005444""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005445
Facundo Batista2ec74152007-12-03 17:55:00 +00005446_all_zeros = re.compile('0*$').match
5447_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005448
5449##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005450# The functions in this section have little to do with the Decimal
5451# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005452# Python numeric classes that want to implement __format__
5453#
5454# A format specifier for Decimal looks like:
5455#
Mark Dickinson277859d2009-03-17 23:03:46 +00005456# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005457
5458_parse_format_specifier_regex = re.compile(r"""\A
5459(?:
5460 (?P<fill>.)?
5461 (?P<align>[<>=^])
5462)?
5463(?P<sign>[-+ ])?
5464(?P<zeropad>0)?
5465(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005466(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005467(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005468(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005469\Z
5470""", re.VERBOSE)
5471
Facundo Batista72bc54f2007-11-23 17:59:00 +00005472del re
5473
Mark Dickinson277859d2009-03-17 23:03:46 +00005474# The locale module is only needed for the 'n' format specifier. The
5475# rest of the PEP 3101 code functions quite happily without it, so we
5476# don't care too much if locale isn't present.
5477try:
5478 import locale as _locale
5479except ImportError:
5480 pass
5481
5482def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005483 """Parse and validate a format specifier.
5484
5485 Turns a standard numeric format specifier into a dict, with the
5486 following entries:
5487
5488 fill: fill character to pad field to minimum width
5489 align: alignment type, either '<', '>', '=' or '^'
5490 sign: either '+', '-' or ' '
5491 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005492 zeropad: boolean, indicating whether to pad with zeros
5493 thousands_sep: string to use as thousands separator, or ''
5494 grouping: grouping for thousands separators, in format
5495 used by localeconv
5496 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005497 precision: nonnegative integer giving precision, or None
5498 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005499 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005500
5501 """
5502 m = _parse_format_specifier_regex.match(format_spec)
5503 if m is None:
5504 raise ValueError("Invalid format specifier: " + format_spec)
5505
5506 # get the dictionary
5507 format_dict = m.groupdict()
5508
Mark Dickinson277859d2009-03-17 23:03:46 +00005509 # zeropad; defaults for fill and alignment. If zero padding
5510 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005511 fill = format_dict['fill']
5512 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005513 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5514 if format_dict['zeropad']:
5515 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005516 raise ValueError("Fill character conflicts with '0'"
5517 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005518 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005519 raise ValueError("Alignment conflicts with '0' in "
5520 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005521 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005522 # PEP 3101 originally specified that the default alignment should
5523 # be left; it was later agreed that right-aligned makes more sense
5524 # for numeric types. See http://bugs.python.org/issue6857.
5525 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005526
Mark Dickinson277859d2009-03-17 23:03:46 +00005527 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005528 if format_dict['sign'] is None:
5529 format_dict['sign'] = '-'
5530
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005531 # minimumwidth defaults to 0; precision remains None if not given
5532 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5533 if format_dict['precision'] is not None:
5534 format_dict['precision'] = int(format_dict['precision'])
5535
5536 # if format type is 'g' or 'G' then a precision of 0 makes little
5537 # sense; convert it to 1. Same if format type is unspecified.
5538 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00005539 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005540 format_dict['precision'] = 1
5541
Mark Dickinson277859d2009-03-17 23:03:46 +00005542 # determine thousands separator, grouping, and decimal separator, and
5543 # add appropriate entries to format_dict
5544 if format_dict['type'] == 'n':
5545 # apart from separators, 'n' behaves just like 'g'
5546 format_dict['type'] = 'g'
5547 if _localeconv is None:
5548 _localeconv = _locale.localeconv()
5549 if format_dict['thousands_sep'] is not None:
5550 raise ValueError("Explicit thousands separator conflicts with "
5551 "'n' type in format specifier: " + format_spec)
5552 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5553 format_dict['grouping'] = _localeconv['grouping']
5554 format_dict['decimal_point'] = _localeconv['decimal_point']
5555 else:
5556 if format_dict['thousands_sep'] is None:
5557 format_dict['thousands_sep'] = ''
5558 format_dict['grouping'] = [3, 0]
5559 format_dict['decimal_point'] = '.'
5560
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005561 # record whether return type should be str or unicode
5562 format_dict['unicode'] = isinstance(format_spec, unicode)
5563
5564 return format_dict
5565
Mark Dickinson277859d2009-03-17 23:03:46 +00005566def _format_align(sign, body, spec):
5567 """Given an unpadded, non-aligned numeric string 'body' and sign
5568 string 'sign', add padding and aligment conforming to the given
5569 format specifier dictionary 'spec' (as produced by
5570 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005571
Mark Dickinson277859d2009-03-17 23:03:46 +00005572 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005573
5574 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005575 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00005576 minimumwidth = spec['minimumwidth']
5577 fill = spec['fill']
5578 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005579
Mark Dickinson277859d2009-03-17 23:03:46 +00005580 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005581 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005582 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00005583 elif align == '>':
5584 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005585 elif align == '=':
5586 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00005587 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005588 half = len(padding)//2
5589 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00005590 else:
5591 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005592
5593 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00005594 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005595 result = unicode(result)
5596
5597 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005598
Mark Dickinson277859d2009-03-17 23:03:46 +00005599def _group_lengths(grouping):
5600 """Convert a localeconv-style grouping into a (possibly infinite)
5601 iterable of integers representing group lengths.
5602
5603 """
5604 # The result from localeconv()['grouping'], and the input to this
5605 # function, should be a list of integers in one of the
5606 # following three forms:
5607 #
5608 # (1) an empty list, or
5609 # (2) nonempty list of positive integers + [0]
5610 # (3) list of positive integers + [locale.CHAR_MAX], or
5611
5612 from itertools import chain, repeat
5613 if not grouping:
5614 return []
5615 elif grouping[-1] == 0 and len(grouping) >= 2:
5616 return chain(grouping[:-1], repeat(grouping[-2]))
5617 elif grouping[-1] == _locale.CHAR_MAX:
5618 return grouping[:-1]
5619 else:
5620 raise ValueError('unrecognised format for grouping')
5621
5622def _insert_thousands_sep(digits, spec, min_width=1):
5623 """Insert thousands separators into a digit string.
5624
5625 spec is a dictionary whose keys should include 'thousands_sep' and
5626 'grouping'; typically it's the result of parsing the format
5627 specifier using _parse_format_specifier.
5628
5629 The min_width keyword argument gives the minimum length of the
5630 result, which will be padded on the left with zeros if necessary.
5631
5632 If necessary, the zero padding adds an extra '0' on the left to
5633 avoid a leading thousands separator. For example, inserting
5634 commas every three digits in '123456', with min_width=8, gives
5635 '0,123,456', even though that has length 9.
5636
5637 """
5638
5639 sep = spec['thousands_sep']
5640 grouping = spec['grouping']
5641
5642 groups = []
5643 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00005644 if l <= 0:
5645 raise ValueError("group length should be positive")
5646 # max(..., 1) forces at least 1 digit to the left of a separator
5647 l = min(max(len(digits), min_width, 1), l)
5648 groups.append('0'*(l - len(digits)) + digits[-l:])
5649 digits = digits[:-l]
5650 min_width -= l
5651 if not digits and min_width <= 0:
5652 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00005653 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00005654 else:
5655 l = max(len(digits), min_width, 1)
5656 groups.append('0'*(l - len(digits)) + digits[-l:])
5657 return sep.join(reversed(groups))
5658
5659def _format_sign(is_negative, spec):
5660 """Determine sign character."""
5661
5662 if is_negative:
5663 return '-'
5664 elif spec['sign'] in ' +':
5665 return spec['sign']
5666 else:
5667 return ''
5668
5669def _format_number(is_negative, intpart, fracpart, exp, spec):
5670 """Format a number, given the following data:
5671
5672 is_negative: true if the number is negative, else false
5673 intpart: string of digits that must appear before the decimal point
5674 fracpart: string of digits that must come after the point
5675 exp: exponent, as an integer
5676 spec: dictionary resulting from parsing the format specifier
5677
5678 This function uses the information in spec to:
5679 insert separators (decimal separator and thousands separators)
5680 format the sign
5681 format the exponent
5682 add trailing '%' for the '%' type
5683 zero-pad if necessary
5684 fill and align if necessary
5685 """
5686
5687 sign = _format_sign(is_negative, spec)
5688
5689 if fracpart:
5690 fracpart = spec['decimal_point'] + fracpart
5691
5692 if exp != 0 or spec['type'] in 'eE':
5693 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
5694 fracpart += "{0}{1:+}".format(echar, exp)
5695 if spec['type'] == '%':
5696 fracpart += '%'
5697
5698 if spec['zeropad']:
5699 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
5700 else:
5701 min_width = 0
5702 intpart = _insert_thousands_sep(intpart, spec, min_width)
5703
5704 return _format_align(sign, intpart+fracpart, spec)
5705
5706
Facundo Batista59c58842007-04-10 12:58:45 +00005707##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005708
Facundo Batista59c58842007-04-10 12:58:45 +00005709# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005710_Infinity = Decimal('Inf')
5711_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00005712_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005713_Zero = Decimal(0)
5714_One = Decimal(1)
5715_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005716
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005717# _SignedInfinity[sign] is infinity w/ that sign
5718_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005719
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005720
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005721
5722if __name__ == '__main__':
5723 import doctest, sys
5724 doctest.testmod(sys.modules[__name__])