blob: 814ef642b48bf7a7e658ee5d36f99839d1f1f8d7 [file] [log] [blame]
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001/* Long (arbitrary precision) integer object implementation */
2
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003/* XXX The functional organization of this file is terrible */
4
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005#include "Python.h"
Guido van Rossumedcc38a1991-05-05 20:09:44 +00006#include "longintrepr.h"
Mark Dickinsonbd792642009-03-18 20:06:12 +00007#include "structseq.h"
Guido van Rossumc0b618a1997-05-02 03:12:38 +00008
Mark Dickinsonc6300392009-04-20 21:38:00 +00009#include <float.h>
Guido van Rossumeb1fafc1994-08-29 12:47:19 +000010#include <ctype.h>
Mark Dickinson5a74bf62009-02-15 11:04:38 +000011#include <stddef.h>
Guido van Rossumedcc38a1991-05-05 20:09:44 +000012
Guido van Rossumddefaf32007-01-14 03:31:43 +000013#ifndef NSMALLPOSINTS
14#define NSMALLPOSINTS 257
15#endif
16#ifndef NSMALLNEGINTS
17#define NSMALLNEGINTS 5
18#endif
Facundo Batista6e6f59b2008-07-24 18:57:11 +000019
Mark Dickinsone4416742009-02-15 15:14:57 +000020/* convert a PyLong of size 1, 0 or -1 to an sdigit */
21#define MEDIUM_VALUE(x) (Py_SIZE(x) < 0 ? -(sdigit)(x)->ob_digit[0] : \
22 (Py_SIZE(x) == 0 ? (sdigit)0 : \
23 (sdigit)(x)->ob_digit[0]))
Facundo Batista6e6f59b2008-07-24 18:57:11 +000024#define ABS(x) ((x) < 0 ? -(x) : (x))
25
Guido van Rossumddefaf32007-01-14 03:31:43 +000026#if NSMALLNEGINTS + NSMALLPOSINTS > 0
27/* Small integers are preallocated in this array so that they
28 can be shared.
29 The integers that are preallocated are those in the range
30 -NSMALLNEGINTS (inclusive) to NSMALLPOSINTS (not inclusive).
31*/
32static PyLongObject small_ints[NSMALLNEGINTS + NSMALLPOSINTS];
33#ifdef COUNT_ALLOCS
34int quick_int_allocs, quick_neg_int_allocs;
35#endif
36
Guido van Rossum7eaf8222007-06-18 17:58:50 +000037static PyObject *
Mark Dickinsone4416742009-02-15 15:14:57 +000038get_small_int(sdigit ival)
Guido van Rossumddefaf32007-01-14 03:31:43 +000039{
40 PyObject *v = (PyObject*)(small_ints + ival + NSMALLNEGINTS);
41 Py_INCREF(v);
42#ifdef COUNT_ALLOCS
43 if (ival >= 0)
44 quick_int_allocs++;
45 else
46 quick_neg_int_allocs++;
47#endif
48 return v;
49}
50#define CHECK_SMALL_INT(ival) \
51 do if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) { \
Mark Dickinson0d4785b2009-02-15 17:27:41 +000052 return get_small_int((sdigit)ival); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000053 } while(0)
54
Facundo Batista6e6f59b2008-07-24 18:57:11 +000055static PyLongObject *
56maybe_small_long(PyLongObject *v)
57{
58 if (v && ABS(Py_SIZE(v)) <= 1) {
Mark Dickinsone4416742009-02-15 15:14:57 +000059 sdigit ival = MEDIUM_VALUE(v);
Facundo Batista6e6f59b2008-07-24 18:57:11 +000060 if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
61 Py_DECREF(v);
62 return (PyLongObject *)get_small_int(ival);
63 }
64 }
65 return v;
66}
Guido van Rossumddefaf32007-01-14 03:31:43 +000067#else
68#define CHECK_SMALL_INT(ival)
Facundo Batista6e6f59b2008-07-24 18:57:11 +000069#define maybe_small_long(val) (val)
Guido van Rossumddefaf32007-01-14 03:31:43 +000070#endif
71
Guido van Rossumddefaf32007-01-14 03:31:43 +000072/* If a freshly-allocated long is already shared, it must
73 be a small integer, so negating it must go to PyLong_FromLong */
74#define NEGATE(x) \
Christian Heimes90aa7642007-12-19 02:45:37 +000075 do if (Py_REFCNT(x) == 1) Py_SIZE(x) = -Py_SIZE(x); \
Christian Heimes217cfd12007-12-02 14:31:20 +000076 else { PyObject* tmp=PyLong_FromLong(-MEDIUM_VALUE(x)); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000077 Py_DECREF(x); (x) = (PyLongObject*)tmp; } \
78 while(0)
Tim Peters5af4e6c2002-08-12 02:31:19 +000079/* For long multiplication, use the O(N**2) school algorithm unless
80 * both operands contain more than KARATSUBA_CUTOFF digits (this
81 * being an internal Python long digit, in base BASE).
82 */
Tim Peters0973b992004-08-29 22:16:50 +000083#define KARATSUBA_CUTOFF 70
84#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000085
Tim Peters47e52ee2004-08-30 02:44:38 +000086/* For exponentiation, use the binary left-to-right algorithm
87 * unless the exponent contains more than FIVEARY_CUTOFF digits.
88 * In that case, do 5 bits at a time. The potential drawback is that
89 * a table of 2**5 intermediate results is computed.
90 */
91#define FIVEARY_CUTOFF 8
92
Tim Peters5af4e6c2002-08-12 02:31:19 +000093#undef MIN
94#undef MAX
95#define MAX(x, y) ((x) < (y) ? (y) : (x))
96#define MIN(x, y) ((x) > (y) ? (y) : (x))
97
Guido van Rossumc0b618a1997-05-02 03:12:38 +000098#define SIGCHECK(PyTryBlock) \
Skip Montanarod581d772002-09-03 20:10:45 +000099 if (--_Py_Ticker < 0) { \
100 _Py_Ticker = _Py_CheckInterval; \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000101 if (PyErr_CheckSignals()) PyTryBlock \
Guido van Rossum23d6f0e1991-05-14 12:06:49 +0000102 }
103
Mark Dickinsonc6300392009-04-20 21:38:00 +0000104/* forward declaration */
105static int bits_in_digit(digit d);
106
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000107/* Normalize (remove leading zeros from) a long int object.
108 Doesn't attempt to free the storage--in most cases, due to the nature
109 of the algorithms used, this could save at most be one word anyway. */
110
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000111static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000112long_normalize(register PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000113{
Christian Heimes90aa7642007-12-19 02:45:37 +0000114 Py_ssize_t j = ABS(Py_SIZE(v));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000115 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000116
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000117 while (i > 0 && v->ob_digit[i-1] == 0)
118 --i;
119 if (i != j)
Christian Heimes90aa7642007-12-19 02:45:37 +0000120 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000121 return v;
122}
123
124/* Allocate a new long int object with size digits.
125 Return NULL and set exception if we run out of memory. */
126
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000127#define MAX_LONG_DIGITS \
128 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
129
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000130PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000132{
Guido van Rossumddefaf32007-01-14 03:31:43 +0000133 PyLongObject *result;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000134 /* Number of bytes needed is: offsetof(PyLongObject, ob_digit) +
135 sizeof(digit)*size. Previous incarnations of this code used
136 sizeof(PyVarObject) instead of the offsetof, but this risks being
137 incorrect in the presence of padding between the PyVarObject header
138 and the digits. */
Mark Dickinsone4416742009-02-15 15:14:57 +0000139 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000140 PyErr_SetString(PyExc_OverflowError,
141 "too many digits in integer");
142 return NULL;
143 }
144 result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) +
Guido van Rossumddefaf32007-01-14 03:31:43 +0000145 size*sizeof(digit));
146 if (!result) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000147 PyErr_NoMemory();
148 return NULL;
149 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000150 return (PyLongObject*)PyObject_INIT_VAR(result, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000151}
152
Tim Peters64b5ce32001-09-10 20:52:51 +0000153PyObject *
154_PyLong_Copy(PyLongObject *src)
155{
156 PyLongObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000157 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +0000158
159 assert(src != NULL);
Christian Heimes90aa7642007-12-19 02:45:37 +0000160 i = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000161 if (i < 0)
162 i = -(i);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000163 if (i < 2) {
Mark Dickinsone4416742009-02-15 15:14:57 +0000164 sdigit ival = src->ob_digit[0];
Christian Heimes90aa7642007-12-19 02:45:37 +0000165 if (Py_SIZE(src) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000166 ival = -ival;
167 CHECK_SMALL_INT(ival);
168 }
Tim Peters64b5ce32001-09-10 20:52:51 +0000169 result = _PyLong_New(i);
170 if (result != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000171 Py_SIZE(result) = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000172 while (--i >= 0)
173 result->ob_digit[i] = src->ob_digit[i];
174 }
175 return (PyObject *)result;
176}
177
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000178/* Create a new long int object from a C long int */
179
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000180PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000181PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000182{
Tim Petersce9de2f2001-06-14 04:56:19 +0000183 PyLongObject *v;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000184 unsigned long abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000185 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
186 int ndigits = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000187 int sign = 1;
188
189 CHECK_SMALL_INT(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000190
191 if (ival < 0) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000192 /* negate: can't write this as abs_ival = -ival since that
193 invokes undefined behaviour when ival is LONG_MIN */
194 abs_ival = 0U-(unsigned long)ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000195 sign = -1;
Tim Petersce9de2f2001-06-14 04:56:19 +0000196 }
Christian Heimesdae2a892008-04-19 00:55:37 +0000197 else {
198 abs_ival = (unsigned long)ival;
199 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000200
Mark Dickinsond4624c32009-01-24 15:02:35 +0000201 /* Fast path for single-digit ints */
202 if (!(abs_ival >> PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000203 v = _PyLong_New(1);
204 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000205 Py_SIZE(v) = sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000206 v->ob_digit[0] = Py_SAFE_DOWNCAST(
207 abs_ival, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000208 }
209 return (PyObject*)v;
210 }
211
Mark Dickinson249b8982009-04-27 19:41:00 +0000212#if PyLong_SHIFT==15
Guido van Rossumddefaf32007-01-14 03:31:43 +0000213 /* 2 digits */
Mark Dickinsond4624c32009-01-24 15:02:35 +0000214 if (!(abs_ival >> 2*PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000215 v = _PyLong_New(2);
216 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_SIZE(v) = 2*sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000218 v->ob_digit[0] = Py_SAFE_DOWNCAST(
219 abs_ival & PyLong_MASK, unsigned long, digit);
220 v->ob_digit[1] = Py_SAFE_DOWNCAST(
221 abs_ival >> PyLong_SHIFT, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000222 }
223 return (PyObject*)v;
224 }
Mark Dickinsonbd792642009-03-18 20:06:12 +0000225#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +0000226
227 /* Larger numbers: loop to determine number of digits */
Christian Heimesdae2a892008-04-19 00:55:37 +0000228 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000229 while (t) {
230 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000231 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000232 }
233 v = _PyLong_New(ndigits);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000234 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000235 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000236 Py_SIZE(v) = ndigits*sign;
Christian Heimesdae2a892008-04-19 00:55:37 +0000237 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000238 while (t) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000239 *p++ = Py_SAFE_DOWNCAST(
240 t & PyLong_MASK, unsigned long, digit);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000241 t >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000242 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000243 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000245}
246
Guido van Rossum53756b11997-01-03 17:14:46 +0000247/* Create a new long int object from a C unsigned long int */
248
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000250PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000251{
Tim Petersce9de2f2001-06-14 04:56:19 +0000252 PyLongObject *v;
253 unsigned long t;
254 int ndigits = 0;
255
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000256 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000257 return PyLong_FromLong(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000258 /* Count the number of Python digits. */
259 t = (unsigned long)ival;
260 while (t) {
261 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000262 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000263 }
264 v = _PyLong_New(ndigits);
Guido van Rossum53756b11997-01-03 17:14:46 +0000265 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000266 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000267 Py_SIZE(v) = ndigits;
Tim Petersce9de2f2001-06-14 04:56:19 +0000268 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000269 *p++ = (digit)(ival & PyLong_MASK);
270 ival >>= PyLong_SHIFT;
Guido van Rossum53756b11997-01-03 17:14:46 +0000271 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000272 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000273 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000274}
275
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000276/* Create a new long int object from a C double */
277
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000278PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000279PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000280{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000281 PyLongObject *v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000282 double frac;
283 int i, ndig, expo, neg;
284 neg = 0;
Tim Peters39dce292000-08-15 03:34:48 +0000285 if (Py_IS_INFINITY(dval)) {
Guido van Rossum1a23c241999-09-27 17:11:52 +0000286 PyErr_SetString(PyExc_OverflowError,
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000287 "cannot convert float infinity to integer");
Guido van Rossum1a23c241999-09-27 17:11:52 +0000288 return NULL;
289 }
Christian Heimesa34706f2008-01-04 03:06:10 +0000290 if (Py_IS_NAN(dval)) {
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000291 PyErr_SetString(PyExc_ValueError,
292 "cannot convert float NaN to integer");
Christian Heimes386cd1e2008-01-15 02:01:20 +0000293 return NULL;
Christian Heimesa34706f2008-01-04 03:06:10 +0000294 }
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000295 if (dval < 0.0) {
296 neg = 1;
297 dval = -dval;
298 }
299 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
300 if (expo <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 return PyLong_FromLong(0L);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000302 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000303 v = _PyLong_New(ndig);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000304 if (v == NULL)
305 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000306 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000307 for (i = ndig; --i >= 0; ) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000308 digit bits = (digit)frac;
309 v->ob_digit[i] = bits;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000310 frac = frac - (double)bits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000311 frac = ldexp(frac, PyLong_SHIFT);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000312 }
313 if (neg)
Christian Heimes90aa7642007-12-19 02:45:37 +0000314 Py_SIZE(v) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000316}
317
Thomas Wouters89f507f2006-12-13 04:49:30 +0000318/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
319 * anything about what happens when a signed integer operation overflows,
320 * and some compilers think they're doing you a favor by being "clever"
321 * then. The bit pattern for the largest postive signed long is
322 * (unsigned long)LONG_MAX, and for the smallest negative signed long
323 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
324 * However, some other compilers warn about applying unary minus to an
325 * unsigned operand. Hence the weird "0-".
326 */
327#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
328#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
329
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000330/* Get a C long int from a long int object.
331 Returns -1 and sets an error condition if overflow occurs. */
332
333long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000334PyLong_AsLongAndOverflow(PyObject *vv, int *overflow)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000335{
Guido van Rossumf7531811998-05-26 14:33:37 +0000336 /* This version by Tim Peters */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000337 register PyLongObject *v;
Guido van Rossumf7531811998-05-26 14:33:37 +0000338 unsigned long x, prev;
Georg Brandl61c31b02007-02-26 14:46:30 +0000339 long res;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000340 Py_ssize_t i;
341 int sign;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000342 int do_decref = 0; /* if nb_int was called */
Guido van Rossumf7531811998-05-26 14:33:37 +0000343
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000344 *overflow = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000345 if (vv == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000346 PyErr_BadInternalCall();
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000347 return -1;
348 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000349
350 if (!PyLong_Check(vv)) {
351 PyNumberMethods *nb;
352 if ((nb = vv->ob_type->tp_as_number) == NULL ||
353 nb->nb_int == NULL) {
354 PyErr_SetString(PyExc_TypeError, "an integer is required");
355 return -1;
356 }
357 vv = (*nb->nb_int) (vv);
358 if (vv == NULL)
359 return -1;
360 do_decref = 1;
361 if (!PyLong_Check(vv)) {
362 Py_DECREF(vv);
363 PyErr_SetString(PyExc_TypeError,
364 "nb_int should return int object");
365 return -1;
366 }
367 }
368
Georg Brandl61c31b02007-02-26 14:46:30 +0000369 res = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000370 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000371 i = Py_SIZE(v);
Guido van Rossumf7531811998-05-26 14:33:37 +0000372
Georg Brandl61c31b02007-02-26 14:46:30 +0000373 switch (i) {
374 case -1:
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000375 res = -(sdigit)v->ob_digit[0];
Georg Brandl61c31b02007-02-26 14:46:30 +0000376 break;
377 case 0:
378 res = 0;
379 break;
380 case 1:
381 res = v->ob_digit[0];
382 break;
383 default:
384 sign = 1;
385 x = 0;
386 if (i < 0) {
387 sign = -1;
388 i = -(i);
389 }
390 while (--i >= 0) {
391 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000392 x = (x << PyLong_SHIFT) + v->ob_digit[i];
393 if ((x >> PyLong_SHIFT) != prev) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000394 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Georg Brandl61c31b02007-02-26 14:46:30 +0000395 goto exit;
396 }
397 }
398 /* Haven't lost any bits, but casting to long requires extra care
399 * (see comment above).
400 */
401 if (x <= (unsigned long)LONG_MAX) {
402 res = (long)x * sign;
403 }
404 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
405 res = LONG_MIN;
406 }
407 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000408 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000409 /* res is already set to -1 */
Georg Brandl61c31b02007-02-26 14:46:30 +0000410 }
411 }
412 exit:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000413 if (do_decref) {
414 Py_DECREF(vv);
415 }
Georg Brandl61c31b02007-02-26 14:46:30 +0000416 return res;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000417}
418
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000419long
420PyLong_AsLong(PyObject *obj)
421{
422 int overflow;
423 long result = PyLong_AsLongAndOverflow(obj, &overflow);
424 if (overflow) {
425 /* XXX: could be cute and give a different
426 message for overflow == -1 */
427 PyErr_SetString(PyExc_OverflowError,
428 "Python int too large to convert to C long");
429 }
430 return result;
431}
432
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000433/* Get a Py_ssize_t from a long int object.
434 Returns -1 and sets an error condition if overflow occurs. */
435
436Py_ssize_t
Guido van Rossumddefaf32007-01-14 03:31:43 +0000437PyLong_AsSsize_t(PyObject *vv) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000438 register PyLongObject *v;
439 size_t x, prev;
440 Py_ssize_t i;
441 int sign;
442
443 if (vv == NULL || !PyLong_Check(vv)) {
444 PyErr_BadInternalCall();
445 return -1;
446 }
447 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000448 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000449 switch (i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000450 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +0000451 case 0: return 0;
452 case 1: return v->ob_digit[0];
453 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000454 sign = 1;
455 x = 0;
456 if (i < 0) {
457 sign = -1;
458 i = -(i);
459 }
460 while (--i >= 0) {
461 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000462 x = (x << PyLong_SHIFT) + v->ob_digit[i];
463 if ((x >> PyLong_SHIFT) != prev)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000464 goto overflow;
465 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000466 /* Haven't lost any bits, but casting to a signed type requires
467 * extra care (see comment above).
Martin v. Löwis18e16552006-02-15 17:27:45 +0000468 */
Thomas Wouters89f507f2006-12-13 04:49:30 +0000469 if (x <= (size_t)PY_SSIZE_T_MAX) {
470 return (Py_ssize_t)x * sign;
471 }
472 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
473 return PY_SSIZE_T_MIN;
474 }
475 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000476
477 overflow:
478 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000479 "Python int too large to convert to C ssize_t");
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000480 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000481}
482
Guido van Rossumd8c80482002-08-13 00:24:58 +0000483/* Get a C unsigned long int from a long int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000484 Returns -1 and sets an error condition if overflow occurs. */
485
486unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000487PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000488{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000489 register PyLongObject *v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000490 unsigned long x, prev;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000491 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000492
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000493 if (vv == NULL || !PyLong_Check(vv)) {
494 PyErr_BadInternalCall();
Guido van Rossum53756b11997-01-03 17:14:46 +0000495 return (unsigned long) -1;
496 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000498 i = Py_SIZE(v);
Guido van Rossum53756b11997-01-03 17:14:46 +0000499 x = 0;
500 if (i < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000501 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000502 "can't convert negative value to unsigned int");
Guido van Rossum53756b11997-01-03 17:14:46 +0000503 return (unsigned long) -1;
504 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000505 switch (i) {
506 case 0: return 0;
507 case 1: return v->ob_digit[0];
508 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000509 while (--i >= 0) {
510 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000511 x = (x << PyLong_SHIFT) + v->ob_digit[i];
512 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000513 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000514 "python int too large to convert to C unsigned long");
Guido van Rossumddefaf32007-01-14 03:31:43 +0000515 return (unsigned long) -1;
516 }
517 }
518 return x;
519}
520
521/* Get a C unsigned long int from a long int object.
522 Returns -1 and sets an error condition if overflow occurs. */
523
524size_t
525PyLong_AsSize_t(PyObject *vv)
526{
527 register PyLongObject *v;
528 size_t x, prev;
529 Py_ssize_t i;
530
531 if (vv == NULL || !PyLong_Check(vv)) {
532 PyErr_BadInternalCall();
533 return (unsigned long) -1;
534 }
535 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000536 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000537 x = 0;
538 if (i < 0) {
539 PyErr_SetString(PyExc_OverflowError,
540 "can't convert negative value to size_t");
541 return (size_t) -1;
542 }
543 switch (i) {
544 case 0: return 0;
545 case 1: return v->ob_digit[0];
546 }
547 while (--i >= 0) {
548 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000549 x = (x << PyLong_SHIFT) + v->ob_digit[i];
550 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000551 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000552 "Python int too large to convert to C size_t");
Guido van Rossum53756b11997-01-03 17:14:46 +0000553 return (unsigned long) -1;
554 }
555 }
556 return x;
557}
558
Thomas Hellera4ea6032003-04-17 18:55:45 +0000559/* Get a C unsigned long int from a long int object, ignoring the high bits.
560 Returns -1 and sets an error condition if an error occurs. */
561
Guido van Rossumddefaf32007-01-14 03:31:43 +0000562static unsigned long
563_PyLong_AsUnsignedLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +0000564{
565 register PyLongObject *v;
566 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000567 Py_ssize_t i;
568 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000569
570 if (vv == NULL || !PyLong_Check(vv)) {
571 PyErr_BadInternalCall();
572 return (unsigned long) -1;
573 }
574 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000575 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000576 switch (i) {
577 case 0: return 0;
578 case 1: return v->ob_digit[0];
579 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000580 sign = 1;
581 x = 0;
582 if (i < 0) {
583 sign = -1;
584 i = -i;
585 }
586 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000587 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +0000588 }
589 return x * sign;
590}
591
Guido van Rossumddefaf32007-01-14 03:31:43 +0000592unsigned long
593PyLong_AsUnsignedLongMask(register PyObject *op)
594{
595 PyNumberMethods *nb;
596 PyLongObject *lo;
597 unsigned long val;
598
599 if (op && PyLong_Check(op))
600 return _PyLong_AsUnsignedLongMask(op);
601
602 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
603 nb->nb_int == NULL) {
604 PyErr_SetString(PyExc_TypeError, "an integer is required");
605 return (unsigned long)-1;
606 }
607
608 lo = (PyLongObject*) (*nb->nb_int) (op);
609 if (lo == NULL)
610 return (unsigned long)-1;
611 if (PyLong_Check(lo)) {
612 val = _PyLong_AsUnsignedLongMask((PyObject *)lo);
613 Py_DECREF(lo);
614 if (PyErr_Occurred())
615 return (unsigned long)-1;
616 return val;
617 }
618 else
619 {
620 Py_DECREF(lo);
621 PyErr_SetString(PyExc_TypeError,
622 "nb_int should return int object");
623 return (unsigned long)-1;
624 }
625}
626
Tim Peters5b8132f2003-01-31 15:52:05 +0000627int
628_PyLong_Sign(PyObject *vv)
629{
630 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000631
632 assert(v != NULL);
633 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000634
Christian Heimes90aa7642007-12-19 02:45:37 +0000635 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000636}
637
Tim Petersbaefd9e2003-01-28 20:37:45 +0000638size_t
639_PyLong_NumBits(PyObject *vv)
640{
641 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000642 size_t result = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000643 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000644
645 assert(v != NULL);
646 assert(PyLong_Check(v));
Christian Heimes90aa7642007-12-19 02:45:37 +0000647 ndigits = ABS(Py_SIZE(v));
Tim Petersbaefd9e2003-01-28 20:37:45 +0000648 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
649 if (ndigits > 0) {
Tim Petersbaefd9e2003-01-28 20:37:45 +0000650 digit msd = v->ob_digit[ndigits - 1];
651
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000652 result = (ndigits - 1) * PyLong_SHIFT;
653 if (result / PyLong_SHIFT != (size_t)(ndigits - 1))
Tim Petersbaefd9e2003-01-28 20:37:45 +0000654 goto Overflow;
655 do {
656 ++result;
657 if (result == 0)
658 goto Overflow;
659 msd >>= 1;
660 } while (msd);
661 }
662 return result;
663
664Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000665 PyErr_SetString(PyExc_OverflowError, "int has too many bits "
Tim Petersbaefd9e2003-01-28 20:37:45 +0000666 "to express in a platform size_t");
667 return (size_t)-1;
668}
669
Tim Peters2a9b3672001-06-11 21:23:58 +0000670PyObject *
671_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
672 int little_endian, int is_signed)
673{
674 const unsigned char* pstartbyte;/* LSB of bytes */
675 int incr; /* direction to move pstartbyte */
676 const unsigned char* pendbyte; /* MSB of bytes */
677 size_t numsignificantbytes; /* number of bytes that matter */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000678 Py_ssize_t ndigits; /* number of Python long digits */
Tim Peters2a9b3672001-06-11 21:23:58 +0000679 PyLongObject* v; /* result */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000680 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000681
682 if (n == 0)
683 return PyLong_FromLong(0L);
684
685 if (little_endian) {
686 pstartbyte = bytes;
687 pendbyte = bytes + n - 1;
688 incr = 1;
689 }
690 else {
691 pstartbyte = bytes + n - 1;
692 pendbyte = bytes;
693 incr = -1;
694 }
695
696 if (is_signed)
697 is_signed = *pendbyte >= 0x80;
698
699 /* Compute numsignificantbytes. This consists of finding the most
700 significant byte. Leading 0 bytes are insignficant if the number
701 is positive, and leading 0xff bytes if negative. */
702 {
703 size_t i;
704 const unsigned char* p = pendbyte;
705 const int pincr = -incr; /* search MSB to LSB */
706 const unsigned char insignficant = is_signed ? 0xff : 0x00;
707
708 for (i = 0; i < n; ++i, p += pincr) {
709 if (*p != insignficant)
710 break;
711 }
712 numsignificantbytes = n - i;
713 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
714 actually has 2 significant bytes. OTOH, 0xff0001 ==
715 -0x00ffff, so we wouldn't *need* to bump it there; but we
716 do for 0xffff = -0x0001. To be safe without bothering to
717 check every case, bump it regardless. */
718 if (is_signed && numsignificantbytes < n)
719 ++numsignificantbytes;
720 }
721
722 /* How many Python long digits do we need? We have
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000723 8*numsignificantbytes bits, and each Python long digit has
724 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
725 /* catch overflow before it happens */
726 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
727 PyErr_SetString(PyExc_OverflowError,
728 "byte array too long to convert to int");
729 return NULL;
730 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000731 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000732 v = _PyLong_New(ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000733 if (v == NULL)
734 return NULL;
735
736 /* Copy the bits over. The tricky parts are computing 2's-comp on
737 the fly for signed numbers, and dealing with the mismatch between
738 8-bit bytes and (probably) 15-bit Python digits.*/
739 {
740 size_t i;
Tim Petersf251d062001-06-13 21:09:15 +0000741 twodigits carry = 1; /* for 2's-comp calculation */
Tim Peters2a9b3672001-06-11 21:23:58 +0000742 twodigits accum = 0; /* sliding register */
743 unsigned int accumbits = 0; /* number of bits in accum */
744 const unsigned char* p = pstartbyte;
745
746 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
Tim Peters8bc84b42001-06-12 19:17:03 +0000747 twodigits thisbyte = *p;
Tim Peters2a9b3672001-06-11 21:23:58 +0000748 /* Compute correction for 2's comp, if needed. */
749 if (is_signed) {
750 thisbyte = (0xff ^ thisbyte) + carry;
751 carry = thisbyte >> 8;
752 thisbyte &= 0xff;
753 }
754 /* Because we're going LSB to MSB, thisbyte is
755 more significant than what's already in accum,
756 so needs to be prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000757 accum |= (twodigits)thisbyte << accumbits;
Tim Peters2a9b3672001-06-11 21:23:58 +0000758 accumbits += 8;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000759 if (accumbits >= PyLong_SHIFT) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000760 /* There's enough to fill a Python digit. */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000761 assert(idigit < ndigits);
762 v->ob_digit[idigit] = (digit)(accum &
763 PyLong_MASK);
Tim Peters2a9b3672001-06-11 21:23:58 +0000764 ++idigit;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000765 accum >>= PyLong_SHIFT;
766 accumbits -= PyLong_SHIFT;
767 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000768 }
769 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000770 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000771 if (accumbits) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000772 assert(idigit < ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000773 v->ob_digit[idigit] = (digit)accum;
774 ++idigit;
775 }
776 }
777
Christian Heimes90aa7642007-12-19 02:45:37 +0000778 Py_SIZE(v) = is_signed ? -idigit : idigit;
Tim Peters2a9b3672001-06-11 21:23:58 +0000779 return (PyObject *)long_normalize(v);
780}
781
782int
783_PyLong_AsByteArray(PyLongObject* v,
784 unsigned char* bytes, size_t n,
785 int little_endian, int is_signed)
786{
Mark Dickinson17e55872009-01-24 15:56:57 +0000787 Py_ssize_t i; /* index into v->ob_digit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000788 Py_ssize_t ndigits; /* |v->ob_size| */
Tim Peters2a9b3672001-06-11 21:23:58 +0000789 twodigits accum; /* sliding register */
790 unsigned int accumbits; /* # bits in accum */
791 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
Mark Dickinson1e2d8702009-01-25 22:25:06 +0000792 digit carry; /* for computing 2's-comp */
Tim Peters2a9b3672001-06-11 21:23:58 +0000793 size_t j; /* # bytes filled */
794 unsigned char* p; /* pointer to next byte in bytes */
795 int pincr; /* direction to move p */
796
797 assert(v != NULL && PyLong_Check(v));
798
Christian Heimes90aa7642007-12-19 02:45:37 +0000799 if (Py_SIZE(v) < 0) {
800 ndigits = -(Py_SIZE(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000801 if (!is_signed) {
Mark Dickinson21776072009-02-10 16:13:25 +0000802 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000803 "can't convert negative int to unsigned");
Tim Peters2a9b3672001-06-11 21:23:58 +0000804 return -1;
805 }
806 do_twos_comp = 1;
807 }
808 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000809 ndigits = Py_SIZE(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000810 do_twos_comp = 0;
811 }
812
813 if (little_endian) {
814 p = bytes;
815 pincr = 1;
816 }
817 else {
818 p = bytes + n - 1;
819 pincr = -1;
820 }
821
Tim Peters898cf852001-06-13 20:50:08 +0000822 /* Copy over all the Python digits.
823 It's crucial that every Python digit except for the MSD contribute
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000824 exactly PyLong_SHIFT bits to the total, so first assert that the long is
Tim Peters898cf852001-06-13 20:50:08 +0000825 normalized. */
826 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
Tim Peters2a9b3672001-06-11 21:23:58 +0000827 j = 0;
828 accum = 0;
829 accumbits = 0;
830 carry = do_twos_comp ? 1 : 0;
831 for (i = 0; i < ndigits; ++i) {
Mark Dickinson17e55872009-01-24 15:56:57 +0000832 digit thisdigit = v->ob_digit[i];
Tim Peters2a9b3672001-06-11 21:23:58 +0000833 if (do_twos_comp) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000834 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
835 carry = thisdigit >> PyLong_SHIFT;
836 thisdigit &= PyLong_MASK;
Tim Peters2a9b3672001-06-11 21:23:58 +0000837 }
Tim Peters8bc84b42001-06-12 19:17:03 +0000838 /* Because we're going LSB to MSB, thisdigit is more
839 significant than what's already in accum, so needs to be
840 prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000841 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000842
Tim Petersede05092001-06-14 08:53:38 +0000843 /* The most-significant digit may be (probably is) at least
844 partly empty. */
Tim Peters8bc84b42001-06-12 19:17:03 +0000845 if (i == ndigits - 1) {
Tim Petersede05092001-06-14 08:53:38 +0000846 /* Count # of sign bits -- they needn't be stored,
847 * although for signed conversion we need later to
Mark Dickinson17e55872009-01-24 15:56:57 +0000848 * make sure at least one sign bit gets stored. */
849 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK :
850 thisdigit;
851 while (s != 0) {
852 s >>= 1;
853 accumbits++;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000854 }
Tim Peters7a3bfc32001-06-12 01:22:22 +0000855 }
Mark Dickinson17e55872009-01-24 15:56:57 +0000856 else
857 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000858
Tim Peters2a9b3672001-06-11 21:23:58 +0000859 /* Store as many bytes as possible. */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000860 while (accumbits >= 8) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000861 if (j >= n)
862 goto Overflow;
863 ++j;
864 *p = (unsigned char)(accum & 0xff);
865 p += pincr;
866 accumbits -= 8;
867 accum >>= 8;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000868 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000869 }
870
871 /* Store the straggler (if any). */
872 assert(accumbits < 8);
873 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000874 if (accumbits > 0) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000875 if (j >= n)
876 goto Overflow;
877 ++j;
878 if (do_twos_comp) {
879 /* Fill leading bits of the byte with sign bits
880 (appropriately pretending that the long had an
881 infinite supply of sign bits). */
882 accum |= (~(twodigits)0) << accumbits;
883 }
884 *p = (unsigned char)(accum & 0xff);
885 p += pincr;
886 }
Tim Peters05607ad2001-06-13 21:01:27 +0000887 else if (j == n && n > 0 && is_signed) {
888 /* The main loop filled the byte array exactly, so the code
889 just above didn't get to ensure there's a sign bit, and the
890 loop below wouldn't add one either. Make sure a sign bit
891 exists. */
Tim Peters2a9b3672001-06-11 21:23:58 +0000892 unsigned char msb = *(p - pincr);
Tim Peters05607ad2001-06-13 21:01:27 +0000893 int sign_bit_set = msb >= 0x80;
894 assert(accumbits == 0);
895 if (sign_bit_set == do_twos_comp)
896 return 0;
897 else
Tim Peters2a9b3672001-06-11 21:23:58 +0000898 goto Overflow;
899 }
Tim Peters05607ad2001-06-13 21:01:27 +0000900
901 /* Fill remaining bytes with copies of the sign bit. */
902 {
903 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
904 for ( ; j < n; ++j, p += pincr)
905 *p = signbyte;
906 }
907
Tim Peters2a9b3672001-06-11 21:23:58 +0000908 return 0;
909
910Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000911 PyErr_SetString(PyExc_OverflowError, "int too big to convert");
Tim Peters2a9b3672001-06-11 21:23:58 +0000912 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000913
Tim Peters2a9b3672001-06-11 21:23:58 +0000914}
915
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000916double
917_PyLong_AsScaledDouble(PyObject *vv, int *exponent)
918{
919/* NBITS_WANTED should be > the number of bits in a double's precision,
920 but small enough so that 2**NBITS_WANTED is within the normal double
921 range. nbitsneeded is set to 1 less than that because the most-significant
922 Python digit contains at least 1 significant bit, but we don't want to
923 bother counting them (catering to the worst case cheaply).
924
925 57 is one more than VAX-D double precision; I (Tim) don't know of a double
926 format with more precision than that; it's 1 larger so that we add in at
927 least one round bit to stand in for the ignored least-significant bits.
928*/
929#define NBITS_WANTED 57
930 PyLongObject *v;
931 double x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000932 const double multiplier = (double)(1L << PyLong_SHIFT);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000933 Py_ssize_t i;
934 int sign;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000935 int nbitsneeded;
936
937 if (vv == NULL || !PyLong_Check(vv)) {
938 PyErr_BadInternalCall();
939 return -1;
940 }
941 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000942 i = Py_SIZE(v);
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000943 sign = 1;
944 if (i < 0) {
945 sign = -1;
946 i = -(i);
947 }
948 else if (i == 0) {
949 *exponent = 0;
950 return 0.0;
951 }
952 --i;
953 x = (double)v->ob_digit[i];
954 nbitsneeded = NBITS_WANTED - 1;
955 /* Invariant: i Python digits remain unaccounted for. */
956 while (i > 0 && nbitsneeded > 0) {
957 --i;
958 x = x * multiplier + (double)v->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000959 nbitsneeded -= PyLong_SHIFT;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000960 }
961 /* There are i digits we didn't shift in. Pretending they're all
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000962 zeroes, the true value is x * 2**(i*PyLong_SHIFT). */
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000963 *exponent = i;
964 assert(x > 0.0);
965 return x * sign;
966#undef NBITS_WANTED
967}
968
Mark Dickinsonc6300392009-04-20 21:38:00 +0000969/* Get a C double from a long int object. Rounds to the nearest double,
970 using the round-half-to-even rule in the case of a tie. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000971
972double
Tim Peters9f688bf2000-07-07 15:53:28 +0000973PyLong_AsDouble(PyObject *vv)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000974{
Mark Dickinsonc6300392009-04-20 21:38:00 +0000975 PyLongObject *v = (PyLongObject *)vv;
976 Py_ssize_t rnd_digit, rnd_bit, m, n;
977 digit lsb, *d;
978 int round_up = 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000979 double x;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000980
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000981 if (vv == NULL || !PyLong_Check(vv)) {
982 PyErr_BadInternalCall();
Tim Peters9fffa3e2001-09-04 05:14:19 +0000983 return -1.0;
Mark Dickinsonc6300392009-04-20 21:38:00 +0000984 }
Tim Peters9fffa3e2001-09-04 05:14:19 +0000985
Mark Dickinsonc6300392009-04-20 21:38:00 +0000986 /* Notes on the method: for simplicity, assume v is positive and >=
987 2**DBL_MANT_DIG. (For negative v we just ignore the sign until the
988 end; for small v no rounding is necessary.) Write n for the number
989 of bits in v, so that 2**(n-1) <= v < 2**n, and n > DBL_MANT_DIG.
990
991 Some terminology: the *rounding bit* of v is the 1st bit of v that
992 will be rounded away (bit n - DBL_MANT_DIG - 1); the *parity bit*
993 is the bit immediately above. The round-half-to-even rule says
994 that we round up if the rounding bit is set, unless v is exactly
995 halfway between two floats and the parity bit is zero.
996
997 Write d[0] ... d[m] for the digits of v, least to most significant.
998 Let rnd_bit be the index of the rounding bit, and rnd_digit the
999 index of the PyLong digit containing the rounding bit. Then the
1000 bits of the digit d[rnd_digit] look something like:
1001
1002 rounding bit
1003 |
1004 v
1005 msb -> sssssrttttttttt <- lsb
1006 ^
1007 |
1008 parity bit
1009
1010 where 's' represents a 'significant bit' that will be included in
1011 the mantissa of the result, 'r' is the rounding bit, and 't'
1012 represents a 'trailing bit' following the rounding bit. Note that
1013 if the rounding bit is at the top of d[rnd_digit] then the parity
1014 bit will be the lsb of d[rnd_digit+1]. If we set
1015
1016 lsb = 1 << (rnd_bit % PyLong_SHIFT)
1017
1018 then d[rnd_digit] & (PyLong_BASE - 2*lsb) selects just the
1019 significant bits of d[rnd_digit], d[rnd_digit] & (lsb-1) gets the
1020 trailing bits, and d[rnd_digit] & lsb gives the rounding bit.
1021
1022 We initialize the double x to the integer given by digits
1023 d[rnd_digit:m-1], but with the rounding bit and trailing bits of
1024 d[rnd_digit] masked out. So the value of x comes from the top
1025 DBL_MANT_DIG bits of v, multiplied by 2*lsb. Note that in the loop
1026 that produces x, all floating-point operations are exact (assuming
1027 that FLT_RADIX==2). Now if we're rounding down, the value we want
1028 to return is simply
1029
1030 x * 2**(PyLong_SHIFT * rnd_digit).
1031
1032 and if we're rounding up, it's
1033
1034 (x + 2*lsb) * 2**(PyLong_SHIFT * rnd_digit).
1035
1036 Under the round-half-to-even rule, we round up if, and only
1037 if, the rounding bit is set *and* at least one of the
1038 following three conditions is satisfied:
1039
1040 (1) the parity bit is set, or
1041 (2) at least one of the trailing bits of d[rnd_digit] is set, or
1042 (3) at least one of the digits d[i], 0 <= i < rnd_digit
1043 is nonzero.
1044
1045 Finally, we have to worry about overflow. If v >= 2**DBL_MAX_EXP,
1046 or equivalently n > DBL_MAX_EXP, then overflow occurs. If v <
1047 2**DBL_MAX_EXP then we're usually safe, but there's a corner case
1048 to consider: if v is very close to 2**DBL_MAX_EXP then it's
1049 possible that v is rounded up to exactly 2**DBL_MAX_EXP, and then
1050 again overflow occurs.
1051 */
1052
1053 if (Py_SIZE(v) == 0)
1054 return 0.0;
1055 m = ABS(Py_SIZE(v)) - 1;
1056 d = v->ob_digit;
1057 assert(d[m]); /* v should be normalized */
1058
1059 /* fast path for case where 0 < abs(v) < 2**DBL_MANT_DIG */
1060 if (m < DBL_MANT_DIG / PyLong_SHIFT ||
1061 (m == DBL_MANT_DIG / PyLong_SHIFT &&
1062 d[m] < (digit)1 << DBL_MANT_DIG%PyLong_SHIFT)) {
1063 x = d[m];
1064 while (--m >= 0)
1065 x = x*PyLong_BASE + d[m];
1066 return Py_SIZE(v) < 0 ? -x : x;
1067 }
1068
1069 /* if m is huge then overflow immediately; otherwise, compute the
1070 number of bits n in v. The condition below implies n (= #bits) >=
1071 m * PyLong_SHIFT + 1 > DBL_MAX_EXP, hence v >= 2**DBL_MAX_EXP. */
1072 if (m > (DBL_MAX_EXP-1)/PyLong_SHIFT)
1073 goto overflow;
1074 n = m * PyLong_SHIFT + bits_in_digit(d[m]);
1075 if (n > DBL_MAX_EXP)
1076 goto overflow;
1077
1078 /* find location of rounding bit */
1079 assert(n > DBL_MANT_DIG); /* dealt with |v| < 2**DBL_MANT_DIG above */
1080 rnd_bit = n - DBL_MANT_DIG - 1;
1081 rnd_digit = rnd_bit/PyLong_SHIFT;
1082 lsb = (digit)1 << (rnd_bit%PyLong_SHIFT);
1083
1084 /* Get top DBL_MANT_DIG bits of v. Assumes PyLong_SHIFT <
1085 DBL_MANT_DIG, so we'll need bits from at least 2 digits of v. */
1086 x = d[m];
1087 assert(m > rnd_digit);
1088 while (--m > rnd_digit)
1089 x = x*PyLong_BASE + d[m];
1090 x = x*PyLong_BASE + (d[m] & (PyLong_BASE-2*lsb));
1091
1092 /* decide whether to round up, using round-half-to-even */
1093 assert(m == rnd_digit);
1094 if (d[m] & lsb) { /* if (rounding bit is set) */
1095 digit parity_bit;
1096 if (lsb == PyLong_BASE/2)
1097 parity_bit = d[m+1] & 1;
1098 else
1099 parity_bit = d[m] & 2*lsb;
1100 if (parity_bit)
1101 round_up = 1;
1102 else if (d[m] & (lsb-1))
1103 round_up = 1;
1104 else {
1105 while (--m >= 0) {
1106 if (d[m]) {
1107 round_up = 1;
1108 break;
1109 }
1110 }
1111 }
1112 }
1113
1114 /* and round up if necessary */
1115 if (round_up) {
1116 x += 2*lsb;
1117 if (n == DBL_MAX_EXP &&
1118 x == ldexp((double)(2*lsb), DBL_MANT_DIG)) {
1119 /* overflow corner case */
1120 goto overflow;
1121 }
1122 }
1123
1124 /* shift, adjust for sign, and return */
1125 x = ldexp(x, rnd_digit*PyLong_SHIFT);
1126 return Py_SIZE(v) < 0 ? -x : x;
1127
1128 overflow:
Tim Peters9fffa3e2001-09-04 05:14:19 +00001129 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +00001130 "Python int too large to convert to C double");
Tim Peters9fffa3e2001-09-04 05:14:19 +00001131 return -1.0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001132}
1133
Guido van Rossum78694d91998-09-18 14:14:13 +00001134/* Create a new long (or int) object from a C pointer */
1135
1136PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001137PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +00001138{
Tim Peters70128a12001-06-16 08:48:40 +00001139#ifndef HAVE_LONG_LONG
1140# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1141#endif
1142#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001143# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001144#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +00001145 /* special-case null pointer */
1146 if (!p)
Christian Heimes217cfd12007-12-02 14:31:20 +00001147 return PyLong_FromLong(0);
Guido van Rossumddefaf32007-01-14 03:31:43 +00001148 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)(Py_uintptr_t)p);
Tim Peters70128a12001-06-16 08:48:40 +00001149
Guido van Rossum78694d91998-09-18 14:14:13 +00001150}
1151
1152/* Get a C pointer from a long object (or an int object in some cases) */
1153
1154void *
Tim Peters9f688bf2000-07-07 15:53:28 +00001155PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +00001156{
1157 /* This function will allow int or long objects. If vv is neither,
1158 then the PyLong_AsLong*() functions will raise the exception:
1159 PyExc_SystemError, "bad argument to internal function"
1160 */
Tim Peters70128a12001-06-16 08:48:40 +00001161#if SIZEOF_VOID_P <= SIZEOF_LONG
Guido van Rossum78694d91998-09-18 14:14:13 +00001162 long x;
1163
Guido van Rossumddefaf32007-01-14 03:31:43 +00001164 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001165 x = PyLong_AsLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001166 else
1167 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +00001168#else
Tim Peters70128a12001-06-16 08:48:40 +00001169
1170#ifndef HAVE_LONG_LONG
1171# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1172#endif
1173#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001174# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001175#endif
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001176 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001177
Guido van Rossumddefaf32007-01-14 03:31:43 +00001178 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001179 x = PyLong_AsLongLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001180 else
1181 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +00001182
1183#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +00001184
1185 if (x == -1 && PyErr_Occurred())
1186 return NULL;
1187 return (void *)x;
1188}
1189
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001190#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +00001191
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001192/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +00001193 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001194 */
1195
Tim Peterscf37dfc2001-06-14 18:42:50 +00001196#define IS_LITTLE_ENDIAN (int)*(unsigned char*)&one
Tim Petersd1a7da62001-06-13 00:35:57 +00001197
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001198/* Create a new long int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001199
1200PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001201PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001202{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001203 PyLongObject *v;
Christian Heimesdae2a892008-04-19 00:55:37 +00001204 unsigned PY_LONG_LONG abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
1206 int ndigits = 0;
1207 int negative = 0;
1208
Guido van Rossumddefaf32007-01-14 03:31:43 +00001209 CHECK_SMALL_INT(ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001210 if (ival < 0) {
Christian Heimesdae2a892008-04-19 00:55:37 +00001211 /* avoid signed overflow on negation; see comments
1212 in PyLong_FromLong above. */
1213 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001214 negative = 1;
1215 }
Christian Heimesdae2a892008-04-19 00:55:37 +00001216 else {
1217 abs_ival = (unsigned PY_LONG_LONG)ival;
1218 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001219
1220 /* Count the number of Python digits.
1221 We used to pick 5 ("big enough for anything"), but that's a
1222 waste of time and space given that 5*15 = 75 bits are rarely
1223 needed. */
Christian Heimesdae2a892008-04-19 00:55:37 +00001224 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001225 while (t) {
1226 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001227 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 }
1229 v = _PyLong_New(ndigits);
1230 if (v != NULL) {
1231 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001232 Py_SIZE(v) = negative ? -ndigits : ndigits;
Christian Heimesdae2a892008-04-19 00:55:37 +00001233 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 while (t) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001235 *p++ = (digit)(t & PyLong_MASK);
1236 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001237 }
1238 }
1239 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001240}
1241
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001242/* Create a new long int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001243
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001244PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001245PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001246{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001247 PyLongObject *v;
1248 unsigned PY_LONG_LONG t;
1249 int ndigits = 0;
1250
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001251 if (ival < PyLong_BASE)
Mark Dickinson50b2b6e2008-12-05 17:14:29 +00001252 return PyLong_FromLong((long)ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001253 /* Count the number of Python digits. */
1254 t = (unsigned PY_LONG_LONG)ival;
1255 while (t) {
1256 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001257 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001258 }
1259 v = _PyLong_New(ndigits);
1260 if (v != NULL) {
1261 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001262 Py_SIZE(v) = ndigits;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001263 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001264 *p++ = (digit)(ival & PyLong_MASK);
1265 ival >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 }
1267 }
1268 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001269}
1270
Martin v. Löwis18e16552006-02-15 17:27:45 +00001271/* Create a new long int object from a C Py_ssize_t. */
1272
1273PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001274PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001275{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001276 PyLongObject *v;
1277 size_t abs_ival;
1278 size_t t; /* unsigned so >> doesn't propagate sign bit */
1279 int ndigits = 0;
1280 int negative = 0;
1281
1282 CHECK_SMALL_INT(ival);
1283 if (ival < 0) {
1284 /* avoid signed overflow when ival = SIZE_T_MIN */
1285 abs_ival = (size_t)(-1-ival)+1;
1286 negative = 1;
1287 }
1288 else {
1289 abs_ival = (size_t)ival;
1290 }
1291
1292 /* Count the number of Python digits. */
1293 t = abs_ival;
1294 while (t) {
1295 ++ndigits;
1296 t >>= PyLong_SHIFT;
1297 }
1298 v = _PyLong_New(ndigits);
1299 if (v != NULL) {
1300 digit *p = v->ob_digit;
1301 Py_SIZE(v) = negative ? -ndigits : ndigits;
1302 t = abs_ival;
1303 while (t) {
1304 *p++ = (digit)(t & PyLong_MASK);
1305 t >>= PyLong_SHIFT;
1306 }
1307 }
1308 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001309}
1310
1311/* Create a new long int object from a C size_t. */
1312
1313PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001314PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001315{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001316 PyLongObject *v;
1317 size_t t;
1318 int ndigits = 0;
1319
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001320 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +00001321 return PyLong_FromLong(ival);
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001322 /* Count the number of Python digits. */
1323 t = ival;
1324 while (t) {
1325 ++ndigits;
1326 t >>= PyLong_SHIFT;
1327 }
1328 v = _PyLong_New(ndigits);
1329 if (v != NULL) {
1330 digit *p = v->ob_digit;
1331 Py_SIZE(v) = ndigits;
1332 while (ival) {
1333 *p++ = (digit)(ival & PyLong_MASK);
1334 ival >>= PyLong_SHIFT;
1335 }
1336 }
1337 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001338}
1339
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001340/* Get a C PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001341 Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001342
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001343PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001344PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001345{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001346 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001347 PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001348 int one = 1;
1349 int res;
1350
Tim Petersd38b1c72001-09-30 05:09:37 +00001351 if (vv == NULL) {
1352 PyErr_BadInternalCall();
1353 return -1;
1354 }
1355 if (!PyLong_Check(vv)) {
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001356 PyNumberMethods *nb;
1357 PyObject *io;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001358 if ((nb = vv->ob_type->tp_as_number) == NULL ||
1359 nb->nb_int == NULL) {
1360 PyErr_SetString(PyExc_TypeError, "an integer is required");
1361 return -1;
1362 }
1363 io = (*nb->nb_int) (vv);
1364 if (io == NULL)
1365 return -1;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001366 if (PyLong_Check(io)) {
1367 bytes = PyLong_AsLongLong(io);
1368 Py_DECREF(io);
1369 return bytes;
1370 }
1371 Py_DECREF(io);
1372 PyErr_SetString(PyExc_TypeError, "integer conversion failed");
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001373 return -1;
1374 }
1375
Guido van Rossumddefaf32007-01-14 03:31:43 +00001376 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001377 switch(Py_SIZE(v)) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00001378 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00001379 case 0: return 0;
1380 case 1: return v->ob_digit[0];
1381 }
Tim Petersd1a7da62001-06-13 00:35:57 +00001382 res = _PyLong_AsByteArray(
1383 (PyLongObject *)vv, (unsigned char *)&bytes,
1384 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 1);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001385
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001386 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001387 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001388 return (PY_LONG_LONG)-1;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001389 else
1390 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001391}
1392
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001393/* Get a C unsigned PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001394 Return -1 and set an error if overflow occurs. */
1395
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001396unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001397PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001398{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001399 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001400 unsigned PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001401 int one = 1;
1402 int res;
1403
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001404 if (vv == NULL || !PyLong_Check(vv)) {
1405 PyErr_BadInternalCall();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001406 return (unsigned PY_LONG_LONG)-1;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001407 }
1408
Guido van Rossumddefaf32007-01-14 03:31:43 +00001409 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001410 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001411 case 0: return 0;
1412 case 1: return v->ob_digit[0];
1413 }
1414
Tim Petersd1a7da62001-06-13 00:35:57 +00001415 res = _PyLong_AsByteArray(
1416 (PyLongObject *)vv, (unsigned char *)&bytes,
1417 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001418
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001419 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001420 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001421 return (unsigned PY_LONG_LONG)res;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001422 else
1423 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001424}
Tim Petersd1a7da62001-06-13 00:35:57 +00001425
Thomas Hellera4ea6032003-04-17 18:55:45 +00001426/* Get a C unsigned long int from a long int object, ignoring the high bits.
1427 Returns -1 and sets an error condition if an error occurs. */
1428
Guido van Rossumddefaf32007-01-14 03:31:43 +00001429static unsigned PY_LONG_LONG
1430_PyLong_AsUnsignedLongLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +00001431{
1432 register PyLongObject *v;
1433 unsigned PY_LONG_LONG x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001434 Py_ssize_t i;
1435 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001436
1437 if (vv == NULL || !PyLong_Check(vv)) {
1438 PyErr_BadInternalCall();
1439 return (unsigned long) -1;
1440 }
1441 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001442 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001443 case 0: return 0;
1444 case 1: return v->ob_digit[0];
1445 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001446 i = Py_SIZE(v);
Thomas Hellera4ea6032003-04-17 18:55:45 +00001447 sign = 1;
1448 x = 0;
1449 if (i < 0) {
1450 sign = -1;
1451 i = -i;
1452 }
1453 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001454 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +00001455 }
1456 return x * sign;
1457}
Guido van Rossumddefaf32007-01-14 03:31:43 +00001458
1459unsigned PY_LONG_LONG
1460PyLong_AsUnsignedLongLongMask(register PyObject *op)
1461{
1462 PyNumberMethods *nb;
1463 PyLongObject *lo;
1464 unsigned PY_LONG_LONG val;
1465
1466 if (op && PyLong_Check(op))
1467 return _PyLong_AsUnsignedLongLongMask(op);
1468
1469 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
1470 nb->nb_int == NULL) {
1471 PyErr_SetString(PyExc_TypeError, "an integer is required");
1472 return (unsigned PY_LONG_LONG)-1;
1473 }
1474
1475 lo = (PyLongObject*) (*nb->nb_int) (op);
1476 if (lo == NULL)
1477 return (unsigned PY_LONG_LONG)-1;
1478 if (PyLong_Check(lo)) {
1479 val = _PyLong_AsUnsignedLongLongMask((PyObject *)lo);
1480 Py_DECREF(lo);
1481 if (PyErr_Occurred())
1482 return (unsigned PY_LONG_LONG)-1;
1483 return val;
1484 }
1485 else
1486 {
1487 Py_DECREF(lo);
1488 PyErr_SetString(PyExc_TypeError,
1489 "nb_int should return int object");
1490 return (unsigned PY_LONG_LONG)-1;
1491 }
1492}
Tim Petersd1a7da62001-06-13 00:35:57 +00001493#undef IS_LITTLE_ENDIAN
1494
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001495#endif /* HAVE_LONG_LONG */
1496
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00001497#define CHECK_BINOP(v,w) \
1498 if (!PyLong_Check(v) || !PyLong_Check(w)) { \
Neil Schemenauerba872e22001-01-04 01:46:03 +00001499 Py_INCREF(Py_NotImplemented); \
1500 return Py_NotImplemented; \
1501 }
1502
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001503/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1504 2**k if d is nonzero, else 0. */
1505
1506static const unsigned char BitLengthTable[32] = {
1507 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1508 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
1509};
1510
1511static int
1512bits_in_digit(digit d)
1513{
1514 int d_bits = 0;
1515 while (d >= 32) {
1516 d_bits += 6;
1517 d >>= 6;
1518 }
1519 d_bits += (int)BitLengthTable[d];
1520 return d_bits;
1521}
1522
Tim Peters877a2122002-08-12 05:09:36 +00001523/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1524 * is modified in place, by adding y to it. Carries are propagated as far as
1525 * x[m-1], and the remaining carry (0 or 1) is returned.
1526 */
1527static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001528v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001529{
Mark Dickinson17e55872009-01-24 15:56:57 +00001530 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001531 digit carry = 0;
1532
1533 assert(m >= n);
1534 for (i = 0; i < n; ++i) {
1535 carry += x[i] + y[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001536 x[i] = carry & PyLong_MASK;
1537 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001538 assert((carry & 1) == carry);
1539 }
1540 for (; carry && i < m; ++i) {
1541 carry += x[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001542 x[i] = carry & PyLong_MASK;
1543 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001544 assert((carry & 1) == carry);
1545 }
1546 return carry;
1547}
1548
1549/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1550 * is modified in place, by subtracting y from it. Borrows are propagated as
1551 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1552 */
1553static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001555{
Mark Dickinson17e55872009-01-24 15:56:57 +00001556 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001557 digit borrow = 0;
1558
1559 assert(m >= n);
1560 for (i = 0; i < n; ++i) {
1561 borrow = x[i] - y[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001562 x[i] = borrow & PyLong_MASK;
1563 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001564 borrow &= 1; /* keep only 1 sign bit */
1565 }
1566 for (; borrow && i < m; ++i) {
1567 borrow = x[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001568 x[i] = borrow & PyLong_MASK;
1569 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001570 borrow &= 1;
1571 }
1572 return borrow;
1573}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001574
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001575/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1576 * result in z[0:m], and return the d bits shifted out of the top.
1577 */
1578static digit
1579v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001580{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581 Py_ssize_t i;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001582 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001583
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001584 assert(0 <= d && d < PyLong_SHIFT);
1585 for (i=0; i < m; i++) {
1586 twodigits acc = (twodigits)a[i] << d | carry;
1587 z[i] = (digit)acc & PyLong_MASK;
1588 carry = (digit)(acc >> PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001589 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001590 return carry;
1591}
1592
1593/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1594 * result in z[0:m], and return the d bits shifted out of the bottom.
1595 */
1596static digit
1597v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1598{
1599 Py_ssize_t i;
1600 digit carry = 0;
1601 digit mask = ((digit)1 << d) - 1U;
1602
1603 assert(0 <= d && d < PyLong_SHIFT);
1604 for (i=m; i-- > 0;) {
1605 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1606 carry = (digit)acc & mask;
1607 z[i] = (digit)(acc >> d);
1608 }
1609 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001610}
1611
Tim Peters212e6142001-07-14 12:23:19 +00001612/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1613 in pout, and returning the remainder. pin and pout point at the LSD.
1614 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001615 _PyLong_Format, but that should be done with great care since longs are
Tim Peters212e6142001-07-14 12:23:19 +00001616 immutable. */
1617
1618static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001619inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001620{
1621 twodigits rem = 0;
1622
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001623 assert(n > 0 && n <= PyLong_MASK);
Tim Peters212e6142001-07-14 12:23:19 +00001624 pin += size;
1625 pout += size;
1626 while (--size >= 0) {
1627 digit hi;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001628 rem = (rem << PyLong_SHIFT) + *--pin;
Tim Peters212e6142001-07-14 12:23:19 +00001629 *--pout = hi = (digit)(rem / n);
Mark Dickinson17e55872009-01-24 15:56:57 +00001630 rem -= (twodigits)hi * n;
Tim Peters212e6142001-07-14 12:23:19 +00001631 }
1632 return (digit)rem;
1633}
1634
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001635/* Divide a long integer by a digit, returning both the quotient
1636 (as function result) and the remainder (through *prem).
1637 The sign of a is ignored; n should not be zero. */
1638
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001640divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001641{
Christian Heimes90aa7642007-12-19 02:45:37 +00001642 const Py_ssize_t size = ABS(Py_SIZE(a));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001644
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001645 assert(n > 0 && n <= PyLong_MASK);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 z = _PyLong_New(size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001647 if (z == NULL)
1648 return NULL;
Tim Peters212e6142001-07-14 12:23:19 +00001649 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001650 return long_normalize(z);
1651}
1652
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001653/* Convert a long integer to a base 10 string. Returns a new non-shared
1654 string. (Return value is non-shared so that callers can modify the
1655 returned value if necessary.) */
1656
1657static PyObject *
1658long_to_decimal_string(PyObject *aa)
1659{
1660 PyLongObject *scratch, *a;
1661 PyObject *str;
1662 Py_ssize_t size, strlen, size_a, i, j;
1663 digit *pout, *pin, rem, tenpow;
1664 Py_UNICODE *p;
1665 int negative;
1666
1667 a = (PyLongObject *)aa;
1668 if (a == NULL || !PyLong_Check(a)) {
1669 PyErr_BadInternalCall();
1670 return NULL;
1671 }
1672 size_a = ABS(Py_SIZE(a));
1673 negative = Py_SIZE(a) < 0;
1674
1675 /* quick and dirty upper bound for the number of digits
1676 required to express a in base _PyLong_DECIMAL_BASE:
1677
1678 #digits = 1 + floor(log2(a) / log2(_PyLong_DECIMAL_BASE))
1679
1680 But log2(a) < size_a * PyLong_SHIFT, and
1681 log2(_PyLong_DECIMAL_BASE) = log2(10) * _PyLong_DECIMAL_SHIFT
1682 > 3 * _PyLong_DECIMAL_SHIFT
1683 */
1684 if (size_a > PY_SSIZE_T_MAX / PyLong_SHIFT) {
1685 PyErr_SetString(PyExc_OverflowError,
1686 "long is too large to format");
1687 return NULL;
1688 }
1689 /* the expression size_a * PyLong_SHIFT is now safe from overflow */
1690 size = 1 + size_a * PyLong_SHIFT / (3 * _PyLong_DECIMAL_SHIFT);
1691 scratch = _PyLong_New(size);
1692 if (scratch == NULL)
1693 return NULL;
1694
1695 /* convert array of base _PyLong_BASE digits in pin to an array of
1696 base _PyLong_DECIMAL_BASE digits in pout, following Knuth (TAOCP,
1697 Volume 2 (3rd edn), section 4.4, Method 1b). */
1698 pin = a->ob_digit;
1699 pout = scratch->ob_digit;
1700 size = 0;
1701 for (i = size_a; --i >= 0; ) {
1702 digit hi = pin[i];
1703 for (j = 0; j < size; j++) {
1704 twodigits z = (twodigits)pout[j] << PyLong_SHIFT | hi;
1705 hi = z / _PyLong_DECIMAL_BASE;
1706 pout[j] = z - (twodigits)hi * _PyLong_DECIMAL_BASE;
1707 }
1708 while (hi) {
1709 pout[size++] = hi % _PyLong_DECIMAL_BASE;
1710 hi /= _PyLong_DECIMAL_BASE;
1711 }
1712 /* check for keyboard interrupt */
1713 SIGCHECK({
1714 Py_DECREF(scratch);
1715 return NULL;
1716 })
1717 }
1718 /* pout should have at least one digit, so that the case when a = 0
1719 works correctly */
1720 if (size == 0)
1721 pout[size++] = 0;
1722
1723 /* calculate exact length of output string, and allocate */
1724 strlen = negative + 1 + (size - 1) * _PyLong_DECIMAL_SHIFT;
1725 tenpow = 10;
1726 rem = pout[size-1];
1727 while (rem >= tenpow) {
1728 tenpow *= 10;
1729 strlen++;
1730 }
1731 str = PyUnicode_FromUnicode(NULL, strlen);
1732 if (str == NULL) {
1733 Py_DECREF(scratch);
1734 return NULL;
1735 }
1736
1737 /* fill the string right-to-left */
1738 p = PyUnicode_AS_UNICODE(str) + strlen;
1739 *p = '\0';
1740 /* pout[0] through pout[size-2] contribute exactly
1741 _PyLong_DECIMAL_SHIFT digits each */
1742 for (i=0; i < size - 1; i++) {
1743 rem = pout[i];
1744 for (j = 0; j < _PyLong_DECIMAL_SHIFT; j++) {
1745 *--p = '0' + rem % 10;
1746 rem /= 10;
1747 }
1748 }
1749 /* pout[size-1]: always produce at least one decimal digit */
1750 rem = pout[i];
1751 do {
1752 *--p = '0' + rem % 10;
1753 rem /= 10;
1754 } while (rem != 0);
1755
1756 /* and sign */
1757 if (negative)
1758 *--p = '-';
1759
1760 /* check we've counted correctly */
1761 assert(p == PyUnicode_AS_UNICODE(str));
1762 Py_DECREF(scratch);
1763 return (PyObject *)str;
1764}
1765
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001766/* Convert a long int object to a string, using a given conversion base.
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001767 Return a string object.
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001768 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001769
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001770PyObject *
1771_PyLong_Format(PyObject *aa, int base)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001772{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001773 register PyLongObject *a = (PyLongObject *)aa;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001774 PyObject *str;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001775 Py_ssize_t i, sz;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001776 Py_ssize_t size_a;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001777 Py_UNICODE *p;
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001778 int bits, negative;
Guido van Rossume32e0141992-01-19 16:31:05 +00001779
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001780 assert(base == 2 || base == 8 || base == 10 || base == 16);
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001781 if (base == 10)
1782 return long_to_decimal_string((PyObject *)a);
1783
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001784 if (a == NULL || !PyLong_Check(a)) {
1785 PyErr_BadInternalCall();
Guido van Rossume32e0141992-01-19 16:31:05 +00001786 return NULL;
1787 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001788 size_a = ABS(Py_SIZE(a));
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001789 negative = Py_SIZE(a) < 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001790
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001791 /* Compute a rough upper bound for the length of the string */
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001792 switch (base) {
1793 case 2:
1794 bits = 1;
1795 break;
1796 case 8:
1797 bits = 3;
1798 break;
1799 case 16:
1800 bits = 4;
1801 break;
1802 default:
1803 assert(0); /* never get here */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001804 }
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001805
1806 /* length of string required: +1 for negative sign, +2 for prefix */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001807 i = 5;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001808 /* ensure we don't get signed overflow in sz calculation */
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001809 if (size_a > (PY_SSIZE_T_MAX - 4) / PyLong_SHIFT) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001810 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001811 "int is too large to format");
Thomas Wouters89f507f2006-12-13 04:49:30 +00001812 return NULL;
1813 }
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001814 sz = 3 + negative + (size_a * PyLong_SHIFT - 1) / bits;
1815
Mark Dickinson659c7b12009-09-13 12:06:08 +00001816 sz = i + 1 + (size_a * PyLong_SHIFT - 1) / bits;
1817 assert(sz >= 0);
Walter Dörwald1ab83302007-05-18 17:15:44 +00001818 str = PyUnicode_FromUnicode(NULL, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001819 if (str == NULL)
1820 return NULL;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001821 p = PyUnicode_AS_UNICODE(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001822 *p = '\0';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001823
Christian Heimes90aa7642007-12-19 02:45:37 +00001824 if (Py_SIZE(a) == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001825 *--p = '0';
1826 }
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001827 assert((base & (base-1)) = 0);
1828 /* JRH: special case for power-of-2 bases */
1829 twodigits accum = 0;
1830 int accumbits = 0; /* # of bits in accum */
1831 int basebits = 1; /* # of bits in base-1 */
1832 i = base;
1833 while ((i >>= 1) > 1)
1834 ++basebits;
Tim Peters586b2e32001-07-15 09:11:14 +00001835
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001836 for (i = 0; i < size_a; ++i) {
1837 accum |= (twodigits)a->ob_digit[i] << accumbits;
1838 accumbits += PyLong_SHIFT;
1839 assert(accumbits >= basebits);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001840 do {
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001841 char cdigit = (char)(accum & (base - 1));
1842 cdigit += (cdigit < 10) ? '0' : 'a'-10;
1843 assert(p > PyUnicode_AS_UNICODE(str));
1844 *--p = cdigit;
1845 accumbits -= basebits;
1846 accum >>= basebits;
1847 } while (i < size_a-1 ? accumbits >= basebits :
1848 accum > 0);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001849 }
1850
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001851 if (base == 16)
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001852 *--p = 'x';
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001853 else if (base == 8)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001854 *--p = 'o';
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001855 else /* base == 2 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001856 *--p = 'b';
Mark Dickinson2e72b0d2009-09-17 19:37:28 +00001857 *--p = '0';
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001858 if (sign)
1859 *--p = sign;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001860 if (p != PyUnicode_AS_UNICODE(str)) {
1861 Py_UNICODE *q = PyUnicode_AS_UNICODE(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001862 assert(p > q);
1863 do {
1864 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001865 q--;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001866 if (PyUnicode_Resize(&str,(Py_ssize_t) (q -
1867 PyUnicode_AS_UNICODE(str)))) {
Walter Dörwald1ab83302007-05-18 17:15:44 +00001868 Py_DECREF(str);
1869 return NULL;
1870 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001871 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001872 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001873}
1874
Thomas Wouters477c8d52006-05-27 19:21:47 +00001875/* Table of digit values for 8-bit string -> integer conversion.
1876 * '0' maps to 0, ..., '9' maps to 9.
1877 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1878 * All other indices map to 37.
1879 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001880 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001881 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001882unsigned char _PyLong_DigitValue[256] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001883 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1884 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1885 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1886 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1887 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1888 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1889 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1890 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1891 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1892 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1893 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1894 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1895 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1896 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1897 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1898 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1899};
1900
1901/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001902 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1903 * non-digit (which may be *str!). A normalized long is returned.
1904 * The point to this routine is that it takes time linear in the number of
1905 * string characters.
1906 */
1907static PyLongObject *
1908long_from_binary_base(char **str, int base)
1909{
1910 char *p = *str;
1911 char *start = p;
1912 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001913 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001914 PyLongObject *z;
1915 twodigits accum;
1916 int bits_in_accum;
1917 digit *pdigit;
1918
1919 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1920 n = base;
1921 for (bits_per_char = -1; n; ++bits_per_char)
1922 n >>= 1;
1923 /* n <- total # of bits needed, while setting p to end-of-string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00001924 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001925 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001926 *str = p;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001927 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1928 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001929 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001930 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001931 "int string too large to convert");
Tim Peters1a3b19a2003-02-02 17:33:53 +00001932 return NULL;
1933 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001934 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001935 z = _PyLong_New(n);
1936 if (z == NULL)
1937 return NULL;
1938 /* Read string from right, and fill in long from left; i.e.,
1939 * from least to most significant in both.
1940 */
1941 accum = 0;
1942 bits_in_accum = 0;
1943 pdigit = z->ob_digit;
1944 while (--p >= start) {
Raymond Hettinger35631532009-01-09 03:58:09 +00001945 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001946 assert(k >= 0 && k < base);
Mark Dickinson17e55872009-01-24 15:56:57 +00001947 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001948 bits_in_accum += bits_per_char;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001949 if (bits_in_accum >= PyLong_SHIFT) {
1950 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinson17e55872009-01-24 15:56:57 +00001951 assert(pdigit - z->ob_digit <= n);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001952 accum >>= PyLong_SHIFT;
1953 bits_in_accum -= PyLong_SHIFT;
1954 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001955 }
1956 }
1957 if (bits_in_accum) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001958 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001959 *pdigit++ = (digit)accum;
Mark Dickinson17e55872009-01-24 15:56:57 +00001960 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001961 }
1962 while (pdigit - z->ob_digit < n)
1963 *pdigit++ = 0;
1964 return long_normalize(z);
1965}
1966
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001967PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001968PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001969{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001970 int sign = 1, error_if_nonzero = 0;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001971 char *start, *orig_str = str;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001972 PyLongObject *z = NULL;
Guido van Rossum25236212007-08-22 23:28:23 +00001973 PyObject *strobj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001974 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001975
Guido van Rossum472c04f1996-12-05 21:57:21 +00001976 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001977 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001978 "int() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001979 return NULL;
1980 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001981 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001982 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001983 if (*str == '+')
1984 ++str;
1985 else if (*str == '-') {
1986 ++str;
1987 sign = -1;
1988 }
1989 if (base == 0) {
1990 if (str[0] != '0')
1991 base = 10;
1992 else if (str[1] == 'x' || str[1] == 'X')
1993 base = 16;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001994 else if (str[1] == 'o' || str[1] == 'O')
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001995 base = 8;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001996 else if (str[1] == 'b' || str[1] == 'B')
1997 base = 2;
1998 else {
1999 /* "old" (C-style) octal literal, now invalid.
2000 it might still be zero though */
2001 error_if_nonzero = 1;
2002 base = 10;
2003 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002004 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002005 if (str[0] == '0' &&
2006 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
2007 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
2008 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002009 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002010
Guido van Rossume6762971998-06-22 03:54:46 +00002011 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00002012 if ((base & (base - 1)) == 0)
2013 z = long_from_binary_base(&str, base);
2014 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00002015/***
2016Binary bases can be converted in time linear in the number of digits, because
2017Python's representation base is binary. Other bases (including decimal!) use
2018the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00002019
Thomas Wouters477c8d52006-05-27 19:21:47 +00002020First some math: the largest integer that can be expressed in N base-B digits
2021is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
2022case number of Python digits needed to hold it is the smallest integer n s.t.
2023
2024 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
2025 BASE**n >= B**N [taking logs to base BASE]
2026 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
2027
2028The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
2029this quickly. A Python long with that much space is reserved near the start,
2030and the result is computed into it.
2031
2032The input string is actually treated as being in base base**i (i.e., i digits
2033are processed at a time), where two more static arrays hold:
2034
2035 convwidth_base[base] = the largest integer i such that base**i <= BASE
2036 convmultmax_base[base] = base ** convwidth_base[base]
2037
2038The first of these is the largest i such that i consecutive input digits
2039must fit in a single Python digit. The second is effectively the input
2040base we're really using.
2041
2042Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
2043convmultmax_base[base], the result is "simply"
2044
2045 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
2046
2047where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002048
2049Error analysis: as above, the number of Python digits `n` needed is worst-
2050case
2051
2052 n >= N * log(B)/log(BASE)
2053
2054where `N` is the number of input digits in base `B`. This is computed via
2055
2056 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2057
2058below. Two numeric concerns are how much space this can waste, and whether
2059the computed result can be too small. To be concrete, assume BASE = 2**15,
2060which is the default (and it's unlikely anyone changes that).
2061
2062Waste isn't a problem: provided the first input digit isn't 0, the difference
2063between the worst-case input with N digits and the smallest input with N
2064digits is about a factor of B, but B is small compared to BASE so at most
2065one allocated Python digit can remain unused on that count. If
2066N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
2067and adding 1 returns a result 1 larger than necessary. However, that can't
2068happen: whenever B is a power of 2, long_from_binary_base() is called
2069instead, and it's impossible for B**i to be an integer power of 2**15 when
2070B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
2071an exact integer when B is not a power of 2, since B**i has a prime factor
2072other than 2 in that case, but (2**15)**j's only prime factor is 2).
2073
2074The computed result can be too small if the true value of N*log(B)/log(BASE)
2075is a little bit larger than an exact integer, but due to roundoff errors (in
2076computing log(B), log(BASE), their quotient, and/or multiplying that by N)
2077yields a numeric result a little less than that integer. Unfortunately, "how
2078close can a transcendental function get to an integer over some range?"
2079questions are generally theoretically intractable. Computer analysis via
2080continued fractions is practical: expand log(B)/log(BASE) via continued
2081fractions, giving a sequence i/j of "the best" rational approximations. Then
2082j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
2083we can get very close to being in trouble, but very rarely. For example,
208476573 is a denominator in one of the continued-fraction approximations to
2085log(10)/log(2**15), and indeed:
2086
2087 >>> log(10)/log(2**15)*76573
2088 16958.000000654003
2089
2090is very close to an integer. If we were working with IEEE single-precision,
2091rounding errors could kill us. Finding worst cases in IEEE double-precision
2092requires better-than-double-precision log() functions, and Tim didn't bother.
2093Instead the code checks to see whether the allocated space is enough as each
2094new Python digit is added, and copies the whole thing to a larger long if not.
2095This should happen extremely rarely, and in fact I don't have a test case
2096that triggers it(!). Instead the code was tested by artificially allocating
2097just 1 digit at the start, so that the copying code was exercised for every
2098digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002099***/
2100 register twodigits c; /* current input character */
2101 Py_ssize_t size_z;
2102 int i;
2103 int convwidth;
2104 twodigits convmultmax, convmult;
2105 digit *pz, *pzstop;
2106 char* scan;
2107
2108 static double log_base_BASE[37] = {0.0e0,};
2109 static int convwidth_base[37] = {0,};
2110 static twodigits convmultmax_base[37] = {0,};
2111
2112 if (log_base_BASE[base] == 0.0) {
2113 twodigits convmax = base;
2114 int i = 1;
2115
2116 log_base_BASE[base] = log((double)base) /
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002117 log((double)PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002118 for (;;) {
2119 twodigits next = convmax * base;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002120 if (next > PyLong_BASE)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002121 break;
2122 convmax = next;
2123 ++i;
2124 }
2125 convmultmax_base[base] = convmax;
2126 assert(i > 0);
2127 convwidth_base[base] = i;
2128 }
2129
2130 /* Find length of the string of numeric characters. */
2131 scan = str;
Christian Heimesbbe741d2008-03-28 10:53:29 +00002132 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002133 ++scan;
2134
2135 /* Create a long object that can contain the largest possible
2136 * integer with this base and length. Note that there's no
2137 * need to initialize z->ob_digit -- no slot is read up before
2138 * being stored into.
2139 */
2140 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002141 /* Uncomment next line to test exceedingly rare copy code */
2142 /* size_z = 1; */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002143 assert(size_z > 0);
2144 z = _PyLong_New(size_z);
2145 if (z == NULL)
2146 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002147 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002148
2149 /* `convwidth` consecutive input digits are treated as a single
2150 * digit in base `convmultmax`.
2151 */
2152 convwidth = convwidth_base[base];
2153 convmultmax = convmultmax_base[base];
2154
2155 /* Work ;-) */
2156 while (str < scan) {
2157 /* grab up to convwidth digits from the input string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00002158 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002159 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2160 c = (twodigits)(c * base +
Raymond Hettinger35631532009-01-09 03:58:09 +00002161 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002162 assert(c < PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002163 }
2164
2165 convmult = convmultmax;
2166 /* Calculate the shift only if we couldn't get
2167 * convwidth digits.
2168 */
2169 if (i != convwidth) {
2170 convmult = base;
2171 for ( ; i > 1; --i)
2172 convmult *= base;
2173 }
2174
2175 /* Multiply z by convmult, and add c. */
2176 pz = z->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00002177 pzstop = pz + Py_SIZE(z);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002178 for (; pz < pzstop; ++pz) {
2179 c += (twodigits)*pz * convmult;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002180 *pz = (digit)(c & PyLong_MASK);
2181 c >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002182 }
2183 /* carry off the current end? */
2184 if (c) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002185 assert(c < PyLong_BASE);
Christian Heimes90aa7642007-12-19 02:45:37 +00002186 if (Py_SIZE(z) < size_z) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002187 *pz = (digit)c;
Christian Heimes90aa7642007-12-19 02:45:37 +00002188 ++Py_SIZE(z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002189 }
2190 else {
2191 PyLongObject *tmp;
2192 /* Extremely rare. Get more space. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002193 assert(Py_SIZE(z) == size_z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002194 tmp = _PyLong_New(size_z + 1);
2195 if (tmp == NULL) {
2196 Py_DECREF(z);
2197 return NULL;
2198 }
2199 memcpy(tmp->ob_digit,
2200 z->ob_digit,
2201 sizeof(digit) * size_z);
2202 Py_DECREF(z);
2203 z = tmp;
2204 z->ob_digit[size_z] = (digit)c;
2205 ++size_z;
2206 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002207 }
Tim Petersbf2674b2003-02-02 07:51:32 +00002208 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002209 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00002210 if (z == NULL)
2211 return NULL;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002212 if (error_if_nonzero) {
2213 /* reset the base to 0, else the exception message
2214 doesn't make too much sense */
2215 base = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +00002216 if (Py_SIZE(z) != 0)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002217 goto onError;
2218 /* there might still be other problems, therefore base
2219 remains zero here for the same reason */
2220 }
Guido van Rossum9e896b32000-04-05 20:11:21 +00002221 if (str == start)
2222 goto onError;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002223 if (sign < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00002224 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00002225 while (*str && isspace(Py_CHARMASK(*str)))
2226 str++;
2227 if (*str != '\0')
2228 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002229 if (pend)
2230 *pend = str;
Martin v. Löwis029656f2008-06-30 04:06:08 +00002231 long_normalize(z);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002232 return (PyObject *) maybe_small_long(z);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002233
2234 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00002235 Py_XDECREF(z);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002236 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Guido van Rossum25236212007-08-22 23:28:23 +00002237 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002238 if (strobj == NULL)
2239 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002240 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00002241 "invalid literal for int() with base %d: %R",
2242 base, strobj);
2243 Py_DECREF(strobj);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002244 return NULL;
2245}
2246
2247PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002248PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002249{
Walter Dörwald07e14762002-11-06 16:15:14 +00002250 PyObject *result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002251 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002252
Walter Dörwald07e14762002-11-06 16:15:14 +00002253 if (buffer == NULL)
2254 return NULL;
2255
2256 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
2257 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002258 return NULL;
2259 }
Walter Dörwald07e14762002-11-06 16:15:14 +00002260 result = PyLong_FromString(buffer, NULL, base);
2261 PyMem_FREE(buffer);
2262 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002263}
2264
Tim Peters9f688bf2000-07-07 15:53:28 +00002265/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002266static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00002267 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002268static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002269
2270/* Long division with remainder, top-level routine */
2271
Guido van Rossume32e0141992-01-19 16:31:05 +00002272static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002273long_divrem(PyLongObject *a, PyLongObject *b,
2274 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002275{
Christian Heimes90aa7642007-12-19 02:45:37 +00002276 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002277 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002278
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002279 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00002280 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00002281 "integer division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00002282 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002283 }
2284 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00002285 (size_a == size_b &&
2286 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002287 /* |a| < |b|. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00002288 *pdiv = (PyLongObject*)PyLong_FromLong(0);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002289 if (*pdiv == NULL)
2290 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002291 Py_INCREF(a);
2292 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00002293 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002294 }
2295 if (size_b == 1) {
2296 digit rem = 0;
2297 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002298 if (z == NULL)
2299 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002300 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002301 if (*prem == NULL) {
2302 Py_DECREF(z);
2303 return -1;
2304 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002305 }
Guido van Rossume32e0141992-01-19 16:31:05 +00002306 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002307 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002308 if (z == NULL)
2309 return -1;
2310 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002311 /* Set the signs.
2312 The quotient z has the sign of a*b;
2313 the remainder r has the sign of a,
2314 so a = b*z + r. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002315 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0))
Guido van Rossumddefaf32007-01-14 03:31:43 +00002316 NEGATE(z);
Christian Heimes90aa7642007-12-19 02:45:37 +00002317 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002318 NEGATE(*prem);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002319 *pdiv = maybe_small_long(z);
Guido van Rossume32e0141992-01-19 16:31:05 +00002320 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002321}
2322
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002323/* Unsigned long division with remainder -- the algorithm. The arguments v1
2324 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002325
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002326static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002327x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002328{
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002329 PyLongObject *v, *w, *a;
2330 Py_ssize_t i, k, size_v, size_w;
2331 int d;
2332 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2333 twodigits vv;
2334 sdigit zhi;
2335 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002336
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002337 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2338 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2339 handle the special case when the initial estimate q for a quotient
2340 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2341 that won't overflow a digit. */
2342
2343 /* allocate space; w will also be used to hold the final remainder */
2344 size_v = ABS(Py_SIZE(v1));
2345 size_w = ABS(Py_SIZE(w1));
2346 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2347 v = _PyLong_New(size_v+1);
2348 if (v == NULL) {
2349 *prem = NULL;
2350 return NULL;
2351 }
2352 w = _PyLong_New(size_w);
2353 if (w == NULL) {
2354 Py_DECREF(v);
2355 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002356 return NULL;
2357 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002358
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002359 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2360 shift v1 left by the same amount. Results go into w and v. */
2361 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2362 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2363 assert(carry == 0);
2364 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2365 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2366 v->ob_digit[size_v] = carry;
2367 size_v++;
2368 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002369
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002370 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2371 at most (and usually exactly) k = size_v - size_w digits. */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002372 k = size_v - size_w;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002373 assert(k >= 0);
2374 a = _PyLong_New(k);
2375 if (a == NULL) {
2376 Py_DECREF(w);
2377 Py_DECREF(v);
2378 *prem = NULL;
2379 return NULL;
2380 }
2381 v0 = v->ob_digit;
2382 w0 = w->ob_digit;
2383 wm1 = w0[size_w-1];
2384 wm2 = w0[size_w-2];
2385 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2386 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2387 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002388
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002389 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002390 Py_DECREF(a);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002391 Py_DECREF(w);
2392 Py_DECREF(v);
2393 *prem = NULL;
2394 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002395 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002396
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002397 /* estimate quotient digit q; may overestimate by 1 (rare) */
2398 vtop = vk[size_w];
2399 assert(vtop <= wm1);
2400 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2401 q = (digit)(vv / wm1);
2402 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2403 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2404 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002405 --q;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002406 r += wm1;
2407 if (r >= PyLong_BASE)
2408 break;
2409 }
2410 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002411
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002412 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2413 zhi = 0;
2414 for (i = 0; i < size_w; ++i) {
2415 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2416 -PyLong_BASE * q <= z < PyLong_BASE */
2417 z = (sdigit)vk[i] + zhi -
2418 (stwodigits)q * (stwodigits)w0[i];
2419 vk[i] = (digit)z & PyLong_MASK;
2420 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2421 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002422 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002423
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002424 /* add w back if q was too large (this branch taken rarely) */
2425 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2426 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002427 carry = 0;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002428 for (i = 0; i < size_w; ++i) {
2429 carry += vk[i] + w0[i];
2430 vk[i] = carry & PyLong_MASK;
2431 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002432 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002433 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002434 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002435
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002436 /* store quotient digit */
2437 assert(q < PyLong_BASE);
2438 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002439 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002440
2441 /* unshift remainder; we reuse w to store the result */
2442 carry = v_rshift(w0, v0, size_w, d);
2443 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002444 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002445
2446 *prem = long_normalize(w);
2447 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002448}
2449
2450/* Methods */
2451
2452static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002453long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002454{
Christian Heimes90aa7642007-12-19 02:45:37 +00002455 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002456}
2457
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002458static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002459long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002460{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002461 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002462
Christian Heimes90aa7642007-12-19 02:45:37 +00002463 if (Py_SIZE(a) != Py_SIZE(b)) {
2464 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002465 sign = 0;
2466 else
Christian Heimes90aa7642007-12-19 02:45:37 +00002467 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002468 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002469 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002470 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002471 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2472 ;
2473 if (i < 0)
2474 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002475 else {
Mark Dickinsone4416742009-02-15 15:14:57 +00002476 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimes90aa7642007-12-19 02:45:37 +00002477 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002478 sign = -sign;
2479 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002480 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002481 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002482}
2483
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002484#define TEST_COND(cond) \
2485 ((cond) ? Py_True : Py_False)
2486
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002487static PyObject *
2488long_richcompare(PyObject *self, PyObject *other, int op)
2489{
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002490 int result;
2491 PyObject *v;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002492 CHECK_BINOP(self, other);
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002493 if (self == other)
2494 result = 0;
2495 else
2496 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2497 /* Convert the return value to a Boolean */
2498 switch (op) {
2499 case Py_EQ:
2500 v = TEST_COND(result == 0);
2501 break;
2502 case Py_NE:
2503 v = TEST_COND(result != 0);
2504 break;
2505 case Py_LE:
2506 v = TEST_COND(result <= 0);
2507 break;
2508 case Py_GE:
2509 v = TEST_COND(result >= 0);
2510 break;
2511 case Py_LT:
2512 v = TEST_COND(result == -1);
2513 break;
2514 case Py_GT:
2515 v = TEST_COND(result == 1);
2516 break;
2517 default:
2518 PyErr_BadArgument();
2519 return NULL;
2520 }
2521 Py_INCREF(v);
2522 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002523}
2524
Guido van Rossum9bfef441993-03-29 10:43:31 +00002525static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002526long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002527{
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002528 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002529 Py_ssize_t i;
2530 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002531
2532 /* This is designed so that Python ints and longs with the
2533 same value hash to the same value, otherwise comparisons
2534 of mapping keys will turn out weird */
Christian Heimes90aa7642007-12-19 02:45:37 +00002535 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +00002536 switch(i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00002537 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00002538 case 0: return 0;
2539 case 1: return v->ob_digit[0];
2540 }
Guido van Rossum9bfef441993-03-29 10:43:31 +00002541 sign = 1;
2542 x = 0;
2543 if (i < 0) {
2544 sign = -1;
2545 i = -(i);
2546 }
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002547 /* The following loop produces a C unsigned long x such that x is
2548 congruent to the absolute value of v modulo ULONG_MAX. The
Thomas Woutersce272b62007-09-19 21:19:28 +00002549 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002550 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002551 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002552 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002553 x += v->ob_digit[i];
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002554 /* If the addition above overflowed we compensate by
2555 incrementing. This preserves the value modulo
2556 ULONG_MAX. */
2557 if (x < v->ob_digit[i])
Thomas Woutersce272b62007-09-19 21:19:28 +00002558 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002559 }
2560 x = x * sign;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002561 if (x == (unsigned long)-1)
2562 x = (unsigned long)-2;
2563 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002564}
2565
2566
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002567/* Add the absolute values of two long integers. */
2568
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002569static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002570x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002571{
Christian Heimes90aa7642007-12-19 02:45:37 +00002572 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002573 PyLongObject *z;
Mark Dickinson17e55872009-01-24 15:56:57 +00002574 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002575 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002576
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002577 /* Ensure a is the larger of the two: */
2578 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002579 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002580 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002581 size_a = size_b;
2582 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002583 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002584 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002585 if (z == NULL)
2586 return NULL;
2587 for (i = 0; i < size_b; ++i) {
2588 carry += a->ob_digit[i] + b->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002589 z->ob_digit[i] = carry & PyLong_MASK;
2590 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002591 }
2592 for (; i < size_a; ++i) {
2593 carry += a->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002594 z->ob_digit[i] = carry & PyLong_MASK;
2595 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002596 }
2597 z->ob_digit[i] = carry;
2598 return long_normalize(z);
2599}
2600
2601/* Subtract the absolute values of two integers. */
2602
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002603static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002604x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002605{
Christian Heimes90aa7642007-12-19 02:45:37 +00002606 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002607 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002608 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002609 int sign = 1;
2610 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002611
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002612 /* Ensure a is the larger of the two: */
2613 if (size_a < size_b) {
2614 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002615 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002616 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002617 size_a = size_b;
2618 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002619 }
2620 else if (size_a == size_b) {
2621 /* Find highest digit where a and b differ: */
2622 i = size_a;
2623 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2624 ;
2625 if (i < 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002626 return (PyLongObject *)PyLong_FromLong(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002627 if (a->ob_digit[i] < b->ob_digit[i]) {
2628 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002629 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002630 }
2631 size_a = size_b = i+1;
2632 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002633 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002634 if (z == NULL)
2635 return NULL;
2636 for (i = 0; i < size_b; ++i) {
2637 /* The following assumes unsigned arithmetic
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002638 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002639 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002640 z->ob_digit[i] = borrow & PyLong_MASK;
2641 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002642 borrow &= 1; /* Keep only one sign bit */
2643 }
2644 for (; i < size_a; ++i) {
2645 borrow = a->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002646 z->ob_digit[i] = borrow & PyLong_MASK;
2647 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002648 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002649 }
2650 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002651 if (sign < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002652 NEGATE(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002653 return long_normalize(z);
2654}
2655
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002656static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002657long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002658{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002659 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002660
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002661 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002662
Christian Heimes90aa7642007-12-19 02:45:37 +00002663 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Christian Heimes217cfd12007-12-02 14:31:20 +00002664 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002665 MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002666 return result;
2667 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002668 if (Py_SIZE(a) < 0) {
2669 if (Py_SIZE(b) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002670 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002671 if (z != NULL && Py_SIZE(z) != 0)
2672 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002673 }
2674 else
2675 z = x_sub(b, a);
2676 }
2677 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002678 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002679 z = x_sub(a, b);
2680 else
2681 z = x_add(a, b);
2682 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002683 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002684}
2685
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002686static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002687long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002688{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002689 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002690
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002691 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002692
Christian Heimes90aa7642007-12-19 02:45:37 +00002693 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002694 PyObject* r;
2695 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002696 return r;
2697 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002698 if (Py_SIZE(a) < 0) {
2699 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002700 z = x_sub(a, b);
2701 else
2702 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002703 if (z != NULL && Py_SIZE(z) != 0)
2704 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002705 }
2706 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002707 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002708 z = x_add(a, b);
2709 else
2710 z = x_sub(a, b);
2711 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002712 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002713}
2714
Tim Peters5af4e6c2002-08-12 02:31:19 +00002715/* Grade school multiplication, ignoring the signs.
2716 * Returns the absolute value of the product, or NULL if error.
2717 */
2718static PyLongObject *
2719x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002720{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002721 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00002722 Py_ssize_t size_a = ABS(Py_SIZE(a));
2723 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002724 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002725
Tim Peters5af4e6c2002-08-12 02:31:19 +00002726 z = _PyLong_New(size_a + size_b);
2727 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002728 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002729
Christian Heimes90aa7642007-12-19 02:45:37 +00002730 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002731 if (a == b) {
2732 /* Efficient squaring per HAC, Algorithm 14.16:
2733 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2734 * Gives slightly less than a 2x speedup when a == b,
2735 * via exploiting that each entry in the multiplication
2736 * pyramid appears twice (except for the size_a squares).
2737 */
2738 for (i = 0; i < size_a; ++i) {
2739 twodigits carry;
2740 twodigits f = a->ob_digit[i];
2741 digit *pz = z->ob_digit + (i << 1);
2742 digit *pa = a->ob_digit + i + 1;
2743 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002744
Tim Peters0973b992004-08-29 22:16:50 +00002745 SIGCHECK({
2746 Py_DECREF(z);
2747 return NULL;
2748 })
2749
2750 carry = *pz + f * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002751 *pz++ = (digit)(carry & PyLong_MASK);
2752 carry >>= PyLong_SHIFT;
2753 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002754
2755 /* Now f is added in twice in each column of the
2756 * pyramid it appears. Same as adding f<<1 once.
2757 */
2758 f <<= 1;
2759 while (pa < paend) {
2760 carry += *pz + *pa++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002761 *pz++ = (digit)(carry & PyLong_MASK);
2762 carry >>= PyLong_SHIFT;
2763 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002764 }
2765 if (carry) {
2766 carry += *pz;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002767 *pz++ = (digit)(carry & PyLong_MASK);
2768 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002769 }
2770 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002771 *pz += (digit)(carry & PyLong_MASK);
2772 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002773 }
Tim Peters0973b992004-08-29 22:16:50 +00002774 }
2775 else { /* a is not the same as b -- gradeschool long mult */
2776 for (i = 0; i < size_a; ++i) {
2777 twodigits carry = 0;
2778 twodigits f = a->ob_digit[i];
2779 digit *pz = z->ob_digit + i;
2780 digit *pb = b->ob_digit;
2781 digit *pbend = b->ob_digit + size_b;
2782
2783 SIGCHECK({
2784 Py_DECREF(z);
2785 return NULL;
2786 })
2787
2788 while (pb < pbend) {
2789 carry += *pz + *pb++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002790 *pz++ = (digit)(carry & PyLong_MASK);
2791 carry >>= PyLong_SHIFT;
2792 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002793 }
2794 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002795 *pz += (digit)(carry & PyLong_MASK);
2796 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002797 }
2798 }
Tim Peters44121a62002-08-12 06:17:58 +00002799 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002800}
2801
2802/* A helper for Karatsuba multiplication (k_mul).
2803 Takes a long "n" and an integer "size" representing the place to
2804 split, and sets low and high such that abs(n) == (high << size) + low,
2805 viewing the shift as being by digits. The sign bit is ignored, and
2806 the return values are >= 0.
2807 Returns 0 on success, -1 on failure.
2808*/
2809static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002810kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002811{
2812 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002813 Py_ssize_t size_lo, size_hi;
Christian Heimes90aa7642007-12-19 02:45:37 +00002814 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002815
2816 size_lo = MIN(size_n, size);
2817 size_hi = size_n - size_lo;
2818
2819 if ((hi = _PyLong_New(size_hi)) == NULL)
2820 return -1;
2821 if ((lo = _PyLong_New(size_lo)) == NULL) {
2822 Py_DECREF(hi);
2823 return -1;
2824 }
2825
2826 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2827 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2828
2829 *high = long_normalize(hi);
2830 *low = long_normalize(lo);
2831 return 0;
2832}
2833
Tim Peters60004642002-08-12 22:01:34 +00002834static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2835
Tim Peters5af4e6c2002-08-12 02:31:19 +00002836/* Karatsuba multiplication. Ignores the input signs, and returns the
2837 * absolute value of the product (or NULL if error).
2838 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2839 */
2840static PyLongObject *
2841k_mul(PyLongObject *a, PyLongObject *b)
2842{
Christian Heimes90aa7642007-12-19 02:45:37 +00002843 Py_ssize_t asize = ABS(Py_SIZE(a));
2844 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002845 PyLongObject *ah = NULL;
2846 PyLongObject *al = NULL;
2847 PyLongObject *bh = NULL;
2848 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002849 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002850 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002851 Py_ssize_t shift; /* the number of digits we split off */
2852 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002853
Tim Peters5af4e6c2002-08-12 02:31:19 +00002854 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2855 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2856 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002857 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002858 * By picking X to be a power of 2, "*X" is just shifting, and it's
2859 * been reduced to 3 multiplies on numbers half the size.
2860 */
2861
Tim Petersfc07e562002-08-12 02:54:10 +00002862 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002863 * is largest.
2864 */
Tim Peters738eda72002-08-12 15:08:20 +00002865 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002866 t1 = a;
2867 a = b;
2868 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002869
2870 i = asize;
2871 asize = bsize;
2872 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002873 }
2874
2875 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002876 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2877 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002878 if (asize == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002879 return (PyLongObject *)PyLong_FromLong(0);
Tim Peters44121a62002-08-12 06:17:58 +00002880 else
2881 return x_mul(a, b);
2882 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002883
Tim Peters60004642002-08-12 22:01:34 +00002884 /* If a is small compared to b, splitting on b gives a degenerate
2885 * case with ah==0, and Karatsuba may be (even much) less efficient
2886 * than "grade school" then. However, we can still win, by viewing
2887 * b as a string of "big digits", each of width a->ob_size. That
2888 * leads to a sequence of balanced calls to k_mul.
2889 */
2890 if (2 * asize <= bsize)
2891 return k_lopsided_mul(a, b);
2892
Tim Petersd6974a52002-08-13 20:37:51 +00002893 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002894 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002895 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002896 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002897
Tim Peters0973b992004-08-29 22:16:50 +00002898 if (a == b) {
2899 bh = ah;
2900 bl = al;
2901 Py_INCREF(bh);
2902 Py_INCREF(bl);
2903 }
2904 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002905
Tim Petersd64c1de2002-08-12 17:36:03 +00002906 /* The plan:
2907 * 1. Allocate result space (asize + bsize digits: that's always
2908 * enough).
2909 * 2. Compute ah*bh, and copy into result at 2*shift.
2910 * 3. Compute al*bl, and copy into result at 0. Note that this
2911 * can't overlap with #2.
2912 * 4. Subtract al*bl from the result, starting at shift. This may
2913 * underflow (borrow out of the high digit), but we don't care:
2914 * we're effectively doing unsigned arithmetic mod
2915 * BASE**(sizea + sizeb), and so long as the *final* result fits,
2916 * borrows and carries out of the high digit can be ignored.
2917 * 5. Subtract ah*bh from the result, starting at shift.
2918 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2919 * at shift.
2920 */
2921
2922 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002923 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002924 if (ret == NULL) goto fail;
2925#ifdef Py_DEBUG
2926 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002927 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002928#endif
Tim Peters44121a62002-08-12 06:17:58 +00002929
Tim Petersd64c1de2002-08-12 17:36:03 +00002930 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002931 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002932 assert(Py_SIZE(t1) >= 0);
2933 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002934 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimes90aa7642007-12-19 02:45:37 +00002935 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002936
2937 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002938 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002939 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002940 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002941 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002942
Tim Petersd64c1de2002-08-12 17:36:03 +00002943 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002944 if ((t2 = k_mul(al, bl)) == NULL) {
2945 Py_DECREF(t1);
2946 goto fail;
2947 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002948 assert(Py_SIZE(t2) >= 0);
2949 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2950 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002951
2952 /* Zero out remaining digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002953 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002954 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002955 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002956
Tim Petersd64c1de2002-08-12 17:36:03 +00002957 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2958 * because it's fresher in cache.
2959 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002960 i = Py_SIZE(ret) - shift; /* # digits after shift */
2961 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002962 Py_DECREF(t2);
2963
Christian Heimes90aa7642007-12-19 02:45:37 +00002964 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002965 Py_DECREF(t1);
2966
Tim Petersd64c1de2002-08-12 17:36:03 +00002967 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002968 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2969 Py_DECREF(ah);
2970 Py_DECREF(al);
2971 ah = al = NULL;
2972
Tim Peters0973b992004-08-29 22:16:50 +00002973 if (a == b) {
2974 t2 = t1;
2975 Py_INCREF(t2);
2976 }
2977 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002978 Py_DECREF(t1);
2979 goto fail;
2980 }
2981 Py_DECREF(bh);
2982 Py_DECREF(bl);
2983 bh = bl = NULL;
2984
Tim Peters738eda72002-08-12 15:08:20 +00002985 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002986 Py_DECREF(t1);
2987 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002988 if (t3 == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002989 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002990
Tim Petersd6974a52002-08-13 20:37:51 +00002991 /* Add t3. It's not obvious why we can't run out of room here.
2992 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002993 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002994 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002995 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002996
Tim Peters5af4e6c2002-08-12 02:31:19 +00002997 return long_normalize(ret);
2998
2999 fail:
3000 Py_XDECREF(ret);
3001 Py_XDECREF(ah);
3002 Py_XDECREF(al);
3003 Py_XDECREF(bh);
3004 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003005 return NULL;
3006}
3007
Tim Petersd6974a52002-08-13 20:37:51 +00003008/* (*) Why adding t3 can't "run out of room" above.
3009
Tim Petersab86c2b2002-08-15 20:06:00 +00003010Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
3011to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00003012
Tim Petersab86c2b2002-08-15 20:06:00 +000030131. For any integer i, i = c(i/2) + f(i/2). In particular,
3014 bsize = c(bsize/2) + f(bsize/2).
30152. shift = f(bsize/2)
30163. asize <= bsize
30174. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
3018 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00003019
Tim Petersab86c2b2002-08-15 20:06:00 +00003020We allocated asize + bsize result digits, and add t3 into them at an offset
3021of shift. This leaves asize+bsize-shift allocated digit positions for t3
3022to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
3023asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00003024
Tim Petersab86c2b2002-08-15 20:06:00 +00003025bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
3026at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003027
Tim Petersab86c2b2002-08-15 20:06:00 +00003028If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
3029digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
3030most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003031
Tim Petersab86c2b2002-08-15 20:06:00 +00003032The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00003033
Tim Petersab86c2b2002-08-15 20:06:00 +00003034 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00003035
Tim Petersab86c2b2002-08-15 20:06:00 +00003036and we have asize + c(bsize/2) available digit positions. We need to show
3037this is always enough. An instance of c(bsize/2) cancels out in both, so
3038the question reduces to whether asize digits is enough to hold
3039(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
3040then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
3041asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003042digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00003043asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00003044c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
3045is enough to hold 2 bits. This is so if bsize >= 2, which holds because
3046bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00003047
Tim Peters48d52c02002-08-14 17:07:32 +00003048Note that since there's always enough room for (ah+al)*(bh+bl), and that's
3049clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3050ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003051*/
3052
Tim Peters60004642002-08-12 22:01:34 +00003053/* b has at least twice the digits of a, and a is big enough that Karatsuba
3054 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3055 * of slices, each with a->ob_size digits, and multiply the slices by a,
3056 * one at a time. This gives k_mul balanced inputs to work with, and is
3057 * also cache-friendly (we compute one double-width slice of the result
3058 * at a time, then move on, never bactracking except for the helpful
3059 * single-width slice overlap between successive partial sums).
3060 */
3061static PyLongObject *
3062k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3063{
Christian Heimes90aa7642007-12-19 02:45:37 +00003064 const Py_ssize_t asize = ABS(Py_SIZE(a));
3065 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00003066 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00003067 PyLongObject *ret;
3068 PyLongObject *bslice = NULL;
3069
3070 assert(asize > KARATSUBA_CUTOFF);
3071 assert(2 * asize <= bsize);
3072
3073 /* Allocate result space, and zero it out. */
3074 ret = _PyLong_New(asize + bsize);
3075 if (ret == NULL)
3076 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003077 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003078
3079 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00003080 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00003081 if (bslice == NULL)
3082 goto fail;
3083
3084 nbdone = 0;
3085 while (bsize > 0) {
3086 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003087 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003088
3089 /* Multiply the next slice of b by a. */
3090 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3091 nbtouse * sizeof(digit));
Christian Heimes90aa7642007-12-19 02:45:37 +00003092 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00003093 product = k_mul(a, bslice);
3094 if (product == NULL)
3095 goto fail;
3096
3097 /* Add into result. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003098 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3099 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00003100 Py_DECREF(product);
3101
3102 bsize -= nbtouse;
3103 nbdone += nbtouse;
3104 }
3105
3106 Py_DECREF(bslice);
3107 return long_normalize(ret);
3108
3109 fail:
3110 Py_DECREF(ret);
3111 Py_XDECREF(bslice);
3112 return NULL;
3113}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003114
3115static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003116long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003117{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003118 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003119
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003120 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003121
Mark Dickinsonbd792642009-03-18 20:06:12 +00003122 /* fast path for single-digit multiplication */
Christian Heimes90aa7642007-12-19 02:45:37 +00003123 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Mark Dickinsonbd792642009-03-18 20:06:12 +00003124 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
3125#ifdef HAVE_LONG_LONG
3126 return PyLong_FromLongLong((PY_LONG_LONG)v);
3127#else
3128 /* if we don't have long long then we're almost certainly
3129 using 15-bit digits, so v will fit in a long. In the
3130 unlikely event that we're using 30-bit digits on a platform
3131 without long long, a large v will just cause us to fall
3132 through to the general multiplication code below. */
3133 if (v >= LONG_MIN && v <= LONG_MAX)
3134 return PyLong_FromLong((long)v);
3135#endif
Martin v. Löwis14b6d922007-02-06 21:05:30 +00003136 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003137
Tim Petersd64c1de2002-08-12 17:36:03 +00003138 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00003139 /* Negate if exactly one of the inputs is negative. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003140 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003141 NEGATE(z);
Tim Peters9973d742002-08-15 19:41:06 +00003142 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003143}
3144
Guido van Rossume32e0141992-01-19 16:31:05 +00003145/* The / and % operators are now defined in terms of divmod().
3146 The expression a mod b has the value a - b*floor(a/b).
3147 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003148 |a| by |b|, with the sign of a. This is also expressed
3149 as a - b*trunc(a/b), if trunc truncates towards zero.
3150 Some examples:
3151 a b a rem b a mod b
3152 13 10 3 3
3153 -13 10 -3 7
3154 13 -10 3 -7
3155 -13 -10 -3 -3
3156 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003157 have different signs. We then subtract one from the 'div'
3158 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003159
Tim Peters47e52ee2004-08-30 02:44:38 +00003160/* Compute
3161 * *pdiv, *pmod = divmod(v, w)
3162 * NULL can be passed for pdiv or pmod, in which case that part of
3163 * the result is simply thrown away. The caller owns a reference to
3164 * each of these it requests (does not pass NULL for).
3165 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003166static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003167l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00003168 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003169{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003170 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003171
Guido van Rossume32e0141992-01-19 16:31:05 +00003172 if (long_divrem(v, w, &div, &mod) < 0)
3173 return -1;
Christian Heimes90aa7642007-12-19 02:45:37 +00003174 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3175 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003176 PyLongObject *temp;
3177 PyLongObject *one;
3178 temp = (PyLongObject *) long_add(mod, w);
3179 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00003180 mod = temp;
3181 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003182 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003183 return -1;
3184 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003185 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00003186 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003187 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3188 Py_DECREF(mod);
3189 Py_DECREF(div);
3190 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00003191 return -1;
3192 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003193 Py_DECREF(one);
3194 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003195 div = temp;
3196 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003197 if (pdiv != NULL)
3198 *pdiv = div;
3199 else
3200 Py_DECREF(div);
3201
3202 if (pmod != NULL)
3203 *pmod = mod;
3204 else
3205 Py_DECREF(mod);
3206
Guido van Rossume32e0141992-01-19 16:31:05 +00003207 return 0;
3208}
3209
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003210static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003211long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003212{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003213 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003214
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003215 CHECK_BINOP(a, b);
3216 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003217 div = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003218 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003219}
3220
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003221static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003222long_true_divide(PyObject *a, PyObject *b)
Tim Peters20dab9f2001-09-04 05:31:47 +00003223{
Tim Peterse2a60002001-09-04 06:17:36 +00003224 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00003225 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00003226
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003227 CHECK_BINOP(a, b);
Tim Peterse2a60002001-09-04 06:17:36 +00003228 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
3229 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00003230 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
Tim Peters6f97e492001-11-04 23:09:40 +00003231 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00003232 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00003233 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
3234 but should really be set correctly after sucessful calls to
3235 _PyLong_AsScaledDouble() */
3236 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00003237
3238 if (bd == 0.0) {
3239 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003240 "int division or modulo by zero");
Tim Peterse2a60002001-09-04 06:17:36 +00003241 return NULL;
3242 }
3243
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003244 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00003245 ad /= bd; /* overflow/underflow impossible here */
3246 aexp -= bexp;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003247 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00003248 goto overflow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003249 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00003250 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003251 errno = 0;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003252 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00003253 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003254 goto overflow;
3255 return PyFloat_FromDouble(ad);
3256
3257overflow:
3258 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003259 "int/int too large for a float");
Tim Peterse2a60002001-09-04 06:17:36 +00003260 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003261
Tim Peters20dab9f2001-09-04 05:31:47 +00003262}
3263
3264static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003265long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003266{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003267 PyLongObject *mod;
3268
3269 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003270
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003271 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003272 mod = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003273 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003274}
3275
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003276static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003277long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003278{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003279 PyLongObject *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003280 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003281
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003282 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003283
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003284 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003285 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003286 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003287 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003288 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003289 PyTuple_SetItem(z, 0, (PyObject *) div);
3290 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003291 }
3292 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003293 Py_DECREF(div);
3294 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003295 }
3296 return z;
3297}
3298
Tim Peters47e52ee2004-08-30 02:44:38 +00003299/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003300static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003301long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003302{
Tim Peters47e52ee2004-08-30 02:44:38 +00003303 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3304 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003305
Tim Peters47e52ee2004-08-30 02:44:38 +00003306 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00003307 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00003308 PyLongObject *temp = NULL;
3309
3310 /* 5-ary values. If the exponent is large enough, table is
3311 * precomputed so that table[i] == a**i % c for i in range(32).
3312 */
3313 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3314 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
3315
3316 /* a, b, c = v, w, x */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003317 CHECK_BINOP(v, w);
3318 a = (PyLongObject*)v; Py_INCREF(a);
3319 b = (PyLongObject*)w; Py_INCREF(b);
Tim Peters47e52ee2004-08-30 02:44:38 +00003320 if (PyLong_Check(x)) {
3321 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003322 Py_INCREF(x);
3323 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003324 else if (x == Py_None)
3325 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003326 else {
3327 Py_DECREF(a);
3328 Py_DECREF(b);
3329 Py_INCREF(Py_NotImplemented);
3330 return Py_NotImplemented;
3331 }
Tim Peters4c483c42001-09-05 06:24:58 +00003332
Christian Heimes90aa7642007-12-19 02:45:37 +00003333 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00003334 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00003335 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00003336 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00003337 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00003338 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003339 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00003340 /* else return a float. This works because we know
3341 that this calls float_pow() which converts its
3342 arguments to double. */
3343 Py_DECREF(a);
3344 Py_DECREF(b);
3345 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003346 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003347 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003348
3349 if (c) {
3350 /* if modulus == 0:
3351 raise ValueError() */
Christian Heimes90aa7642007-12-19 02:45:37 +00003352 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003353 PyErr_SetString(PyExc_ValueError,
3354 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00003355 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003356 }
3357
3358 /* if modulus < 0:
3359 negativeOutput = True
3360 modulus = -modulus */
Christian Heimes90aa7642007-12-19 02:45:37 +00003361 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003362 negativeOutput = 1;
3363 temp = (PyLongObject *)_PyLong_Copy(c);
3364 if (temp == NULL)
3365 goto Error;
3366 Py_DECREF(c);
3367 c = temp;
3368 temp = NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003369 NEGATE(c);
Tim Peters47e52ee2004-08-30 02:44:38 +00003370 }
3371
3372 /* if modulus == 1:
3373 return 0 */
Christian Heimes90aa7642007-12-19 02:45:37 +00003374 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003375 z = (PyLongObject *)PyLong_FromLong(0L);
3376 goto Done;
3377 }
3378
3379 /* if base < 0:
3380 base = base % modulus
3381 Having the base positive just makes things easier. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003382 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003383 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003384 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003385 Py_DECREF(a);
3386 a = temp;
3387 temp = NULL;
3388 }
3389 }
3390
3391 /* At this point a, b, and c are guaranteed non-negative UNLESS
3392 c is NULL, in which case a may be negative. */
3393
3394 z = (PyLongObject *)PyLong_FromLong(1L);
3395 if (z == NULL)
3396 goto Error;
3397
3398 /* Perform a modular reduction, X = X % c, but leave X alone if c
3399 * is NULL.
3400 */
3401#define REDUCE(X) \
3402 if (c != NULL) { \
3403 if (l_divmod(X, c, NULL, &temp) < 0) \
3404 goto Error; \
3405 Py_XDECREF(X); \
3406 X = temp; \
3407 temp = NULL; \
3408 }
3409
3410 /* Multiply two values, then reduce the result:
3411 result = X*Y % c. If c is NULL, skip the mod. */
3412#define MULT(X, Y, result) \
3413{ \
3414 temp = (PyLongObject *)long_mul(X, Y); \
3415 if (temp == NULL) \
3416 goto Error; \
3417 Py_XDECREF(result); \
3418 result = temp; \
3419 temp = NULL; \
3420 REDUCE(result) \
3421}
3422
Christian Heimes90aa7642007-12-19 02:45:37 +00003423 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003424 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3425 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimes90aa7642007-12-19 02:45:37 +00003426 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003427 digit bi = b->ob_digit[i];
3428
Mark Dickinsone4416742009-02-15 15:14:57 +00003429 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003430 MULT(z, z, z)
3431 if (bi & j)
3432 MULT(z, a, z)
3433 }
3434 }
3435 }
3436 else {
3437 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3438 Py_INCREF(z); /* still holds 1L */
3439 table[0] = z;
3440 for (i = 1; i < 32; ++i)
3441 MULT(table[i-1], a, table[i])
3442
Christian Heimes90aa7642007-12-19 02:45:37 +00003443 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003444 const digit bi = b->ob_digit[i];
3445
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003446 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003447 const int index = (bi >> j) & 0x1f;
3448 for (k = 0; k < 5; ++k)
3449 MULT(z, z, z)
3450 if (index)
3451 MULT(z, table[index], z)
3452 }
3453 }
3454 }
3455
Christian Heimes90aa7642007-12-19 02:45:37 +00003456 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003457 temp = (PyLongObject *)long_sub(z, c);
3458 if (temp == NULL)
3459 goto Error;
3460 Py_DECREF(z);
3461 z = temp;
3462 temp = NULL;
3463 }
3464 goto Done;
3465
3466 Error:
3467 if (z != NULL) {
3468 Py_DECREF(z);
3469 z = NULL;
3470 }
3471 /* fall through */
3472 Done:
Christian Heimes90aa7642007-12-19 02:45:37 +00003473 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003474 for (i = 0; i < 32; ++i)
3475 Py_XDECREF(table[i]);
3476 }
Tim Petersde7990b2005-07-17 23:45:23 +00003477 Py_DECREF(a);
3478 Py_DECREF(b);
3479 Py_XDECREF(c);
3480 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003481 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003482}
3483
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003484static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003485long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003486{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003487 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003488 PyLongObject *x;
3489 PyLongObject *w;
Christian Heimes90aa7642007-12-19 02:45:37 +00003490 if (ABS(Py_SIZE(v)) <=1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003491 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003492 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003493 if (w == NULL)
3494 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003495 x = (PyLongObject *) long_add(v, w);
3496 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003497 if (x == NULL)
3498 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003499 Py_SIZE(x) = -(Py_SIZE(x));
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003500 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003501}
3502
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003503static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003504long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003505{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003506 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00003507 if (ABS(Py_SIZE(v)) <= 1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003508 return PyLong_FromLong(-MEDIUM_VALUE(v));
Tim Peters69c2de32001-09-11 22:31:33 +00003509 z = (PyLongObject *)_PyLong_Copy(v);
3510 if (z != NULL)
Christian Heimes90aa7642007-12-19 02:45:37 +00003511 Py_SIZE(z) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003512 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003513}
3514
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003515static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003516long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003517{
Christian Heimes90aa7642007-12-19 02:45:37 +00003518 if (Py_SIZE(v) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003519 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003520 else
Guido van Rossumb43daf72007-08-01 18:08:08 +00003521 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003522}
3523
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003524static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003525long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003526{
Christian Heimes90aa7642007-12-19 02:45:37 +00003527 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003528}
3529
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003530static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003531long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003532{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003533 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003534 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003535 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003536 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003537
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003538 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003539
Christian Heimes90aa7642007-12-19 02:45:37 +00003540 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003541 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003542 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003543 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003544 if (a1 == NULL)
3545 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003546 a2 = (PyLongObject *) long_rshift(a1, b);
3547 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003548 if (a2 == NULL)
3549 goto rshift_error;
3550 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003551 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003552 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003553 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003554
Neil Schemenauerba872e22001-01-04 01:46:03 +00003555 shiftby = PyLong_AsLong((PyObject *)b);
3556 if (shiftby == -1L && PyErr_Occurred())
3557 goto rshift_error;
3558 if (shiftby < 0) {
3559 PyErr_SetString(PyExc_ValueError,
3560 "negative shift count");
3561 goto rshift_error;
3562 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003563 wordshift = shiftby / PyLong_SHIFT;
Christian Heimes90aa7642007-12-19 02:45:37 +00003564 newsize = ABS(Py_SIZE(a)) - wordshift;
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003565 if (newsize <= 0)
3566 return PyLong_FromLong(0);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003567 loshift = shiftby % PyLong_SHIFT;
3568 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003569 lomask = ((digit)1 << hishift) - 1;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003570 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003571 z = _PyLong_New(newsize);
3572 if (z == NULL)
3573 goto rshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003574 if (Py_SIZE(a) < 0)
3575 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003576 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3577 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3578 if (i+1 < newsize)
3579 z->ob_digit[i] |=
3580 (a->ob_digit[j+1] << hishift) & himask;
3581 }
3582 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003583 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003584rshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003585 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003586
Guido van Rossumc6913e71991-11-19 20:26:46 +00003587}
3588
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003589static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003590long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003591{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003592 /* This version due to Tim Peters */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003593 PyLongObject *a = (PyLongObject*)v;
3594 PyLongObject *b = (PyLongObject*)w;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003595 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003596 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003597 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003598 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003599
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003600 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003601
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003602 shiftby = PyLong_AsLong((PyObject *)b);
3603 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003604 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003605 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003606 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003607 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003608 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003609 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003610 PyErr_SetString(PyExc_ValueError,
3611 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003612 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003613 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003614 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3615 wordshift = (int)shiftby / PyLong_SHIFT;
3616 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003617
Christian Heimes90aa7642007-12-19 02:45:37 +00003618 oldsize = ABS(Py_SIZE(a));
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003619 newsize = oldsize + wordshift;
3620 if (remshift)
3621 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003622 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003623 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003624 goto lshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003625 if (Py_SIZE(a) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003626 NEGATE(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003627 for (i = 0; i < wordshift; i++)
3628 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003629 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003630 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003631 accum |= (twodigits)a->ob_digit[j] << remshift;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003632 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3633 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003634 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003635 if (remshift)
3636 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003637 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003638 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003639 z = long_normalize(z);
3640lshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003641 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003642}
3643
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003644
3645/* Bitwise and/xor/or operations */
3646
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003647static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003648long_bitwise(PyLongObject *a,
3649 int op, /* '&', '|', '^' */
3650 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003651{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003652 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003653 int negz;
Mark Dickinsone4416742009-02-15 15:14:57 +00003654 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003655 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003656 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003657 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003658
Christian Heimes90aa7642007-12-19 02:45:37 +00003659 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003660 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003661 if (a == NULL)
3662 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003663 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003664 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003665 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003666 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003667 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003668 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003669 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003670 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003671 if (b == NULL) {
3672 Py_DECREF(a);
3673 return NULL;
3674 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003675 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003676 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003677 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003678 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003679 maskb = 0;
3680 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003681
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003682 negz = 0;
3683 switch (op) {
3684 case '^':
3685 if (maska != maskb) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003686 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003687 negz = -1;
3688 }
3689 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003690 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003691 if (maska && maskb) {
3692 op = '|';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003693 maska ^= PyLong_MASK;
3694 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003695 negz = -1;
3696 }
3697 break;
3698 case '|':
3699 if (maska || maskb) {
3700 op = '&';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003701 maska ^= PyLong_MASK;
3702 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003703 negz = -1;
3704 }
3705 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003706 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003707
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003708 /* JRH: The original logic here was to allocate the result value (z)
3709 as the longer of the two operands. However, there are some cases
3710 where the result is guaranteed to be shorter than that: AND of two
3711 positives, OR of two negatives: use the shorter number. AND with
3712 mixed signs: use the positive number. OR with mixed signs: use the
3713 negative number. After the transformations above, op will be '&'
3714 iff one of these cases applies, and mask will be non-0 for operands
3715 whose length should be ignored.
3716 */
3717
Christian Heimes90aa7642007-12-19 02:45:37 +00003718 size_a = Py_SIZE(a);
3719 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003720 size_z = op == '&'
3721 ? (maska
3722 ? size_b
3723 : (maskb ? size_a : MIN(size_a, size_b)))
3724 : MAX(size_a, size_b);
3725 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003726 if (z == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003727 Py_DECREF(a);
3728 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003729 return NULL;
3730 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003731
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003732 for (i = 0; i < size_z; ++i) {
3733 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3734 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3735 switch (op) {
3736 case '&': z->ob_digit[i] = diga & digb; break;
3737 case '|': z->ob_digit[i] = diga | digb; break;
3738 case '^': z->ob_digit[i] = diga ^ digb; break;
3739 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003740 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003741
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003742 Py_DECREF(a);
3743 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003744 z = long_normalize(z);
3745 if (negz == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003746 return (PyObject *) maybe_small_long(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003747 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003748 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003749 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003750}
3751
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003752static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003753long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003754{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003755 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003756 CHECK_BINOP(a, b);
3757 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003758 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003759}
3760
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003761static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003762long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003763{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003764 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003765 CHECK_BINOP(a, b);
3766 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003767 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003768}
3769
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003770static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003771long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003772{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003773 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003774 CHECK_BINOP(a, b);
3775 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003776 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003777}
3778
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003779static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003780long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003781{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003782 if (PyLong_CheckExact(v))
3783 Py_INCREF(v);
3784 else
3785 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003786 return v;
3787}
3788
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003789static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003790long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003791{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003792 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003793 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003794 if (result == -1.0 && PyErr_Occurred())
3795 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003796 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003797}
3798
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003799static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003800long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003801
Tim Peters6d6c1a32001-08-02 04:15:00 +00003802static PyObject *
3803long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3804{
3805 PyObject *x = NULL;
3806 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003807 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003808
Guido van Rossumbef14172001-08-29 15:47:46 +00003809 if (type != &PyLong_Type)
3810 return long_subtype_new(type, args, kwds); /* Wimp out */
Guido van Rossumddefaf32007-01-14 03:31:43 +00003811 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:int", kwlist,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003812 &x, &base))
3813 return NULL;
3814 if (x == NULL)
3815 return PyLong_FromLong(0L);
3816 if (base == -909)
3817 return PyNumber_Long(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003818 else if (PyUnicode_Check(x))
3819 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3820 PyUnicode_GET_SIZE(x),
3821 base);
Christian Heimes72b710a2008-05-26 13:28:38 +00003822 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Guido van Rossumd8faa362007-04-27 19:54:29 +00003823 /* Since PyLong_FromString doesn't have a length parameter,
3824 * check here for possible NULs in the string. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00003825 char *string;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003826 Py_ssize_t size = Py_SIZE(x);
Christian Heimes9c4756e2008-05-26 13:22:05 +00003827 if (PyByteArray_Check(x))
3828 string = PyByteArray_AS_STRING(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003829 else
Christian Heimes72b710a2008-05-26 13:28:38 +00003830 string = PyBytes_AS_STRING(x);
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003831 if (strlen(string) != (size_t)size) {
Guido van Rossum25236212007-08-22 23:28:23 +00003832 /* We only see this if there's a null byte in x,
Guido van Rossum98297ee2007-11-06 21:34:58 +00003833 x is a bytes or buffer, *and* a base is given. */
Guido van Rossumd8faa362007-04-27 19:54:29 +00003834 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00003835 "invalid literal for int() with base %d: %R",
3836 base, x);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003837 return NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003838 }
Guido van Rossum4581ae52007-05-22 21:56:47 +00003839 return PyLong_FromString(string, NULL, base);
Guido van Rossumddefaf32007-01-14 03:31:43 +00003840 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003841 else {
3842 PyErr_SetString(PyExc_TypeError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003843 "int() can't convert non-string with explicit base");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003844 return NULL;
3845 }
3846}
3847
Guido van Rossumbef14172001-08-29 15:47:46 +00003848/* Wimpy, slow approach to tp_new calls for subtypes of long:
3849 first create a regular long from whatever arguments we got,
3850 then allocate a subtype instance and initialize it from
3851 the regular long. The regular long is then thrown away.
3852*/
3853static PyObject *
3854long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3855{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003856 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003857 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003858
3859 assert(PyType_IsSubtype(type, &PyLong_Type));
3860 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3861 if (tmp == NULL)
3862 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003863 assert(PyLong_CheckExact(tmp));
Christian Heimes90aa7642007-12-19 02:45:37 +00003864 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003865 if (n < 0)
3866 n = -n;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003867 newobj = (PyLongObject *)type->tp_alloc(type, n);
3868 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003869 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003870 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003871 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003872 assert(PyLong_Check(newobj));
Christian Heimes90aa7642007-12-19 02:45:37 +00003873 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003874 for (i = 0; i < n; i++)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003875 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003876 Py_DECREF(tmp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003877 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003878}
3879
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003880static PyObject *
3881long_getnewargs(PyLongObject *v)
3882{
3883 return Py_BuildValue("(N)", _PyLong_Copy(v));
3884}
3885
Guido van Rossumb43daf72007-08-01 18:08:08 +00003886static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00003887long_get0(PyLongObject *v, void *context) {
3888 return PyLong_FromLong(0L);
3889}
3890
3891static PyObject *
3892long_get1(PyLongObject *v, void *context) {
3893 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00003894}
3895
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003896static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00003897long__format__(PyObject *self, PyObject *args)
3898{
Eric Smith4a7d76d2008-05-30 18:10:19 +00003899 PyObject *format_spec;
3900
3901 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
3902 return NULL;
3903 return _PyLong_FormatAdvanced(self,
3904 PyUnicode_AS_UNICODE(format_spec),
3905 PyUnicode_GET_SIZE(format_spec));
Eric Smith8c663262007-08-25 02:26:07 +00003906}
3907
Eric Smith8c663262007-08-25 02:26:07 +00003908static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003909long_round(PyObject *self, PyObject *args)
3910{
Mark Dickinson1124e712009-01-28 21:25:58 +00003911 PyObject *o_ndigits=NULL, *temp;
3912 PyLongObject *pow=NULL, *q=NULL, *r=NULL, *ndigits=NULL, *one;
3913 int errcode;
3914 digit q_mod_4;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003915
Mark Dickinson1124e712009-01-28 21:25:58 +00003916 /* Notes on the algorithm: to round to the nearest 10**n (n positive),
3917 the straightforward method is:
3918
3919 (1) divide by 10**n
3920 (2) round to nearest integer (round to even in case of tie)
3921 (3) multiply result by 10**n.
3922
3923 But the rounding step involves examining the fractional part of the
3924 quotient to see whether it's greater than 0.5 or not. Since we
3925 want to do the whole calculation in integer arithmetic, it's
3926 simpler to do:
3927
3928 (1) divide by (10**n)/2
3929 (2) round to nearest multiple of 2 (multiple of 4 in case of tie)
3930 (3) multiply result by (10**n)/2.
3931
3932 Then all we need to know about the fractional part of the quotient
3933 arising in step (2) is whether it's zero or not.
3934
3935 Doing both a multiplication and division is wasteful, and is easily
3936 avoided if we just figure out how much to adjust the original input
3937 by to do the rounding.
3938
3939 Here's the whole algorithm expressed in Python.
3940
3941 def round(self, ndigits = None):
3942 """round(int, int) -> int"""
3943 if ndigits is None or ndigits >= 0:
3944 return self
3945 pow = 10**-ndigits >> 1
3946 q, r = divmod(self, pow)
3947 self -= r
3948 if (q & 1 != 0):
3949 if (q & 2 == r == 0):
3950 self -= pow
3951 else:
3952 self += pow
3953 return self
3954
3955 */
3956 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
3957 return NULL;
3958 if (o_ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003959 return long_long(self);
3960
Mark Dickinson1124e712009-01-28 21:25:58 +00003961 ndigits = (PyLongObject *)PyNumber_Index(o_ndigits);
3962 if (ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003963 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00003964
3965 if (Py_SIZE(ndigits) >= 0) {
3966 Py_DECREF(ndigits);
3967 return long_long(self);
3968 }
3969
3970 Py_INCREF(self); /* to keep refcounting simple */
3971 /* we now own references to self, ndigits */
3972
3973 /* pow = 10 ** -ndigits >> 1 */
3974 pow = (PyLongObject *)PyLong_FromLong(10L);
3975 if (pow == NULL)
3976 goto error;
3977 temp = long_neg(ndigits);
3978 Py_DECREF(ndigits);
3979 ndigits = (PyLongObject *)temp;
3980 if (ndigits == NULL)
3981 goto error;
3982 temp = long_pow((PyObject *)pow, (PyObject *)ndigits, Py_None);
3983 Py_DECREF(pow);
3984 pow = (PyLongObject *)temp;
3985 if (pow == NULL)
3986 goto error;
3987 assert(PyLong_Check(pow)); /* check long_pow returned a long */
3988 one = (PyLongObject *)PyLong_FromLong(1L);
3989 if (one == NULL)
3990 goto error;
3991 temp = long_rshift(pow, one);
3992 Py_DECREF(one);
3993 Py_DECREF(pow);
3994 pow = (PyLongObject *)temp;
3995 if (pow == NULL)
3996 goto error;
3997
3998 /* q, r = divmod(self, pow) */
3999 errcode = l_divmod((PyLongObject *)self, pow, &q, &r);
4000 if (errcode == -1)
4001 goto error;
4002
4003 /* self -= r */
4004 temp = long_sub((PyLongObject *)self, r);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004005 Py_DECREF(self);
Mark Dickinson1124e712009-01-28 21:25:58 +00004006 self = temp;
4007 if (self == NULL)
4008 goto error;
4009
4010 /* get value of quotient modulo 4 */
4011 if (Py_SIZE(q) == 0)
4012 q_mod_4 = 0;
4013 else if (Py_SIZE(q) > 0)
4014 q_mod_4 = q->ob_digit[0] & 3;
4015 else
4016 q_mod_4 = (PyLong_BASE-q->ob_digit[0]) & 3;
4017
4018 if ((q_mod_4 & 1) == 1) {
4019 /* q is odd; round self up or down by adding or subtracting pow */
4020 if (q_mod_4 == 1 && Py_SIZE(r) == 0)
4021 temp = (PyObject *)long_sub((PyLongObject *)self, pow);
4022 else
4023 temp = (PyObject *)long_add((PyLongObject *)self, pow);
4024 Py_DECREF(self);
4025 self = temp;
4026 if (self == NULL)
4027 goto error;
4028 }
4029 Py_DECREF(q);
4030 Py_DECREF(r);
4031 Py_DECREF(pow);
4032 Py_DECREF(ndigits);
4033 return self;
4034
4035 error:
4036 Py_XDECREF(q);
4037 Py_XDECREF(r);
4038 Py_XDECREF(pow);
4039 Py_XDECREF(self);
4040 Py_XDECREF(ndigits);
4041 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004042}
4043
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004044static PyObject *
4045long_sizeof(PyLongObject *v)
4046{
4047 Py_ssize_t res;
4048
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004049 res = offsetof(PyLongObject, ob_digit) + ABS(Py_SIZE(v))*sizeof(digit);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004050 return PyLong_FromSsize_t(res);
4051}
4052
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004053static PyObject *
4054long_bit_length(PyLongObject *v)
4055{
4056 PyLongObject *result, *x, *y;
4057 Py_ssize_t ndigits, msd_bits = 0;
4058 digit msd;
4059
4060 assert(v != NULL);
4061 assert(PyLong_Check(v));
4062
4063 ndigits = ABS(Py_SIZE(v));
4064 if (ndigits == 0)
4065 return PyLong_FromLong(0);
4066
4067 msd = v->ob_digit[ndigits-1];
4068 while (msd >= 32) {
4069 msd_bits += 6;
4070 msd >>= 6;
4071 }
4072 msd_bits += (long)(BitLengthTable[msd]);
4073
4074 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4075 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
4076
4077 /* expression above may overflow; use Python integers instead */
4078 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4079 if (result == NULL)
4080 return NULL;
4081 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4082 if (x == NULL)
4083 goto error;
4084 y = (PyLongObject *)long_mul(result, x);
4085 Py_DECREF(x);
4086 if (y == NULL)
4087 goto error;
4088 Py_DECREF(result);
4089 result = y;
4090
4091 x = (PyLongObject *)PyLong_FromLong(msd_bits);
4092 if (x == NULL)
4093 goto error;
4094 y = (PyLongObject *)long_add(result, x);
4095 Py_DECREF(x);
4096 if (y == NULL)
4097 goto error;
4098 Py_DECREF(result);
4099 result = y;
4100
4101 return (PyObject *)result;
4102
4103error:
4104 Py_DECREF(result);
4105 return NULL;
4106}
4107
4108PyDoc_STRVAR(long_bit_length_doc,
4109"int.bit_length() -> int\n\
4110\n\
4111Number of bits necessary to represent self in binary.\n\
4112>>> bin(37)\n\
4113'0b100101'\n\
4114>>> (37).bit_length()\n\
41156");
4116
Christian Heimes53876d92008-04-19 00:31:39 +00004117#if 0
4118static PyObject *
4119long_is_finite(PyObject *v)
4120{
4121 Py_RETURN_TRUE;
4122}
4123#endif
4124
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004125static PyMethodDef long_methods[] = {
Guido van Rossumb43daf72007-08-01 18:08:08 +00004126 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
4127 "Returns self, the complex conjugate of any int."},
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004128 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
4129 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00004130#if 0
4131 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
4132 "Returns always True."},
4133#endif
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004134 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
4135 "Truncating an Integral returns itself."},
4136 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
4137 "Flooring an Integral returns itself."},
4138 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
4139 "Ceiling of an Integral returns itself."},
4140 {"__round__", (PyCFunction)long_round, METH_VARARGS,
Mark Dickinson1124e712009-01-28 21:25:58 +00004141 "Rounding an Integral returns itself.\n"
4142 "Rounding with an ndigits argument also returns an integer."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004143 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smith8c663262007-08-25 02:26:07 +00004144 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004145 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
4146 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004147 {NULL, NULL} /* sentinel */
4148};
4149
Guido van Rossumb43daf72007-08-01 18:08:08 +00004150static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00004151 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004152 (getter)long_long, (setter)NULL,
4153 "the real part of a complex number",
4154 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004155 {"imag",
4156 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004157 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004158 NULL},
4159 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004160 (getter)long_long, (setter)NULL,
4161 "the numerator of a rational number in lowest terms",
4162 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004163 {"denominator",
4164 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004165 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004166 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00004167 {NULL} /* Sentinel */
4168};
4169
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004170PyDoc_STRVAR(long_doc,
Guido van Rossumddefaf32007-01-14 03:31:43 +00004171"int(x[, base]) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004172\n\
Guido van Rossumddefaf32007-01-14 03:31:43 +00004173Convert a string or number to an integer, if possible. A floating\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004174point argument will be truncated towards zero (this does not include a\n\
4175string representation of a floating point number!) When converting a\n\
4176string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004177converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004178
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004179static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00004180 (binaryfunc) long_add, /*nb_add*/
4181 (binaryfunc) long_sub, /*nb_subtract*/
4182 (binaryfunc) long_mul, /*nb_multiply*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004183 long_mod, /*nb_remainder*/
4184 long_divmod, /*nb_divmod*/
4185 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004186 (unaryfunc) long_neg, /*nb_negative*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004187 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004188 (unaryfunc) long_abs, /*tp_absolute*/
Jack Diederich4dafcc42006-11-28 19:15:13 +00004189 (inquiry) long_bool, /*tp_bool*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004190 (unaryfunc) long_invert, /*nb_invert*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004191 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004192 (binaryfunc) long_rshift, /*nb_rshift*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004193 long_and, /*nb_and*/
4194 long_xor, /*nb_xor*/
4195 long_or, /*nb_or*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004196 long_long, /*nb_int*/
Mark Dickinson8055afd2009-01-17 10:04:45 +00004197 0, /*nb_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004198 long_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00004199 0, /* nb_inplace_add */
4200 0, /* nb_inplace_subtract */
4201 0, /* nb_inplace_multiply */
Guido van Rossum4668b002001-08-08 05:00:18 +00004202 0, /* nb_inplace_remainder */
4203 0, /* nb_inplace_power */
4204 0, /* nb_inplace_lshift */
4205 0, /* nb_inplace_rshift */
4206 0, /* nb_inplace_and */
4207 0, /* nb_inplace_xor */
4208 0, /* nb_inplace_or */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004209 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00004210 long_true_divide, /* nb_true_divide */
4211 0, /* nb_inplace_floor_divide */
4212 0, /* nb_inplace_true_divide */
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00004213 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004214};
4215
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004216PyTypeObject PyLong_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004217 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00004218 "int", /* tp_name */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004219 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004220 sizeof(digit), /* tp_itemsize */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004221 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004222 0, /* tp_print */
4223 0, /* tp_getattr */
4224 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00004225 0, /* tp_reserved */
Mark Dickinson2031d132009-09-17 00:17:48 +00004226 long_to_decimal_string, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004227 &long_as_number, /* tp_as_number */
4228 0, /* tp_as_sequence */
4229 0, /* tp_as_mapping */
4230 (hashfunc)long_hash, /* tp_hash */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004231 0, /* tp_call */
Mark Dickinson2031d132009-09-17 00:17:48 +00004232 long_to_decimal_string, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004233 PyObject_GenericGetAttr, /* tp_getattro */
4234 0, /* tp_setattro */
4235 0, /* tp_as_buffer */
Thomas Wouters27d517b2007-02-25 20:39:11 +00004236 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
4237 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004238 long_doc, /* tp_doc */
4239 0, /* tp_traverse */
4240 0, /* tp_clear */
Guido van Rossum47b9ff62006-08-24 00:41:19 +00004241 long_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004242 0, /* tp_weaklistoffset */
4243 0, /* tp_iter */
4244 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004245 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004246 0, /* tp_members */
Guido van Rossumb43daf72007-08-01 18:08:08 +00004247 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004248 0, /* tp_base */
4249 0, /* tp_dict */
4250 0, /* tp_descr_get */
4251 0, /* tp_descr_set */
4252 0, /* tp_dictoffset */
4253 0, /* tp_init */
4254 0, /* tp_alloc */
4255 long_new, /* tp_new */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004256 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004257};
Guido van Rossumddefaf32007-01-14 03:31:43 +00004258
Mark Dickinsonbd792642009-03-18 20:06:12 +00004259static PyTypeObject Int_InfoType;
4260
4261PyDoc_STRVAR(int_info__doc__,
4262"sys.int_info\n\
4263\n\
4264A struct sequence that holds information about Python's\n\
4265internal representation of integers. The attributes are read only.");
4266
4267static PyStructSequence_Field int_info_fields[] = {
4268 {"bits_per_digit", "size of a digit in bits"},
4269 {"sizeof_digit", "size in bytes of the C type used to "
4270 "represent a digit"},
4271 {NULL, NULL}
4272};
4273
4274static PyStructSequence_Desc int_info_desc = {
4275 "sys.int_info", /* name */
4276 int_info__doc__, /* doc */
4277 int_info_fields, /* fields */
4278 2 /* number of fields */
4279};
4280
4281PyObject *
4282PyLong_GetInfo(void)
4283{
4284 PyObject* int_info;
4285 int field = 0;
4286 int_info = PyStructSequence_New(&Int_InfoType);
4287 if (int_info == NULL)
4288 return NULL;
Mark Dickinson0bdab682009-04-02 18:41:40 +00004289 PyStructSequence_SET_ITEM(int_info, field++,
4290 PyLong_FromLong(PyLong_SHIFT));
4291 PyStructSequence_SET_ITEM(int_info, field++,
4292 PyLong_FromLong(sizeof(digit)));
Mark Dickinsonbd792642009-03-18 20:06:12 +00004293 if (PyErr_Occurred()) {
4294 Py_CLEAR(int_info);
4295 return NULL;
4296 }
4297 return int_info;
4298}
4299
Guido van Rossumddefaf32007-01-14 03:31:43 +00004300int
4301_PyLong_Init(void)
4302{
4303#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004304 int ival, size;
Guido van Rossumddefaf32007-01-14 03:31:43 +00004305 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004306
4307 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
4308 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
4309 if (Py_TYPE(v) == &PyLong_Type) {
4310 /* The element is already initialized, most likely
4311 * the Python interpreter was initialized before.
4312 */
Christian Heimes48aa4b12008-02-01 16:56:30 +00004313 Py_ssize_t refcnt;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004314 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004315
Christian Heimes48aa4b12008-02-01 16:56:30 +00004316 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
4317 _Py_NewReference(op);
4318 /* _Py_NewReference sets the ref count to 1 but
4319 * the ref count might be larger. Set the refcnt
4320 * to the original refcnt + 1 */
4321 Py_REFCNT(op) = refcnt + 1;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004322 assert(Py_SIZE(op) == size);
4323 assert(v->ob_digit[0] == abs(ival));
4324 }
4325 else {
4326 PyObject_INIT(v, &PyLong_Type);
4327 }
4328 Py_SIZE(v) = size;
4329 v->ob_digit[0] = abs(ival);
Guido van Rossumddefaf32007-01-14 03:31:43 +00004330 }
4331#endif
Mark Dickinsonbd792642009-03-18 20:06:12 +00004332 /* initialize int_info */
4333 if (Int_InfoType.tp_name == 0)
4334 PyStructSequence_InitType(&Int_InfoType, &int_info_desc);
4335
Guido van Rossumddefaf32007-01-14 03:31:43 +00004336 return 1;
4337}
4338
4339void
4340PyLong_Fini(void)
4341{
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004342 /* Integers are currently statically allocated. Py_DECREF is not
4343 needed, but Python must forget about the reference or multiple
4344 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00004345#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004346 int i;
4347 PyLongObject *v = small_ints;
4348 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
4349 _Py_DEC_REFTOTAL;
4350 _Py_ForgetReference((PyObject*)v);
4351 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004352#endif
4353}