blob: 23d2f1336f06c2293c711583d003c02aabde50c0 [file] [log] [blame]
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003/* Long (arbitrary precision) integer object implementation */
4
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00005/* XXX The functional organization of this file is terrible */
6
Guido van Rossumc0b618a1997-05-02 03:12:38 +00007#include "Python.h"
Guido van Rossumedcc38a1991-05-05 20:09:44 +00008#include "longintrepr.h"
Mark Dickinsonefc82f72009-03-20 15:51:55 +00009#include "structseq.h"
Guido van Rossumc0b618a1997-05-02 03:12:38 +000010
Mark Dickinson6736cf82009-04-20 21:13:33 +000011#include <float.h>
Guido van Rossumeb1fafc1994-08-29 12:47:19 +000012#include <ctype.h>
Mark Dickinson2ffb26f2009-02-15 10:13:41 +000013#include <stddef.h>
Guido van Rossumedcc38a1991-05-05 20:09:44 +000014
Tim Peters5af4e6c2002-08-12 02:31:19 +000015/* For long multiplication, use the O(N**2) school algorithm unless
16 * both operands contain more than KARATSUBA_CUTOFF digits (this
Christian Heimes7f39c9f2008-01-25 12:18:43 +000017 * being an internal Python long digit, in base PyLong_BASE).
Tim Peters5af4e6c2002-08-12 02:31:19 +000018 */
Tim Peters0973b992004-08-29 22:16:50 +000019#define KARATSUBA_CUTOFF 70
20#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000021
Tim Peters47e52ee2004-08-30 02:44:38 +000022/* For exponentiation, use the binary left-to-right algorithm
23 * unless the exponent contains more than FIVEARY_CUTOFF digits.
24 * In that case, do 5 bits at a time. The potential drawback is that
25 * a table of 2**5 intermediate results is computed.
26 */
27#define FIVEARY_CUTOFF 8
28
Guido van Rossume32e0141992-01-19 16:31:05 +000029#define ABS(x) ((x) < 0 ? -(x) : (x))
30
Tim Peters5af4e6c2002-08-12 02:31:19 +000031#undef MIN
32#undef MAX
33#define MAX(x, y) ((x) < (y) ? (y) : (x))
34#define MIN(x, y) ((x) > (y) ? (y) : (x))
35
Guido van Rossumc0b618a1997-05-02 03:12:38 +000036#define SIGCHECK(PyTryBlock) \
Skip Montanarod581d772002-09-03 20:10:45 +000037 if (--_Py_Ticker < 0) { \
38 _Py_Ticker = _Py_CheckInterval; \
Tim Petersd89fc222006-05-25 22:28:46 +000039 if (PyErr_CheckSignals()) PyTryBlock \
Guido van Rossum23d6f0e1991-05-14 12:06:49 +000040 }
41
Mark Dickinson6736cf82009-04-20 21:13:33 +000042/* forward declaration */
43static int bits_in_digit(digit d);
44
Guido van Rossumedcc38a1991-05-05 20:09:44 +000045/* Normalize (remove leading zeros from) a long int object.
46 Doesn't attempt to free the storage--in most cases, due to the nature
47 of the algorithms used, this could save at most be one word anyway. */
48
Guido van Rossumc0b618a1997-05-02 03:12:38 +000049static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +000050long_normalize(register PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +000051{
Christian Heimese93237d2007-12-19 02:37:44 +000052 Py_ssize_t j = ABS(Py_SIZE(v));
Martin v. Löwis18e16552006-02-15 17:27:45 +000053 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +000054
Guido van Rossumedcc38a1991-05-05 20:09:44 +000055 while (i > 0 && v->ob_digit[i-1] == 0)
56 --i;
57 if (i != j)
Christian Heimese93237d2007-12-19 02:37:44 +000058 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +000059 return v;
60}
61
62/* Allocate a new long int object with size digits.
63 Return NULL and set exception if we run out of memory. */
64
Mark Dickinson2ffb26f2009-02-15 10:13:41 +000065#define MAX_LONG_DIGITS \
66 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
67
Guido van Rossumc0b618a1997-05-02 03:12:38 +000068PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +000069_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +000070{
Mark Dickinsonbcf6b182009-02-15 15:48:39 +000071 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
Mark Dickinson2ffb26f2009-02-15 10:13:41 +000072 PyErr_SetString(PyExc_OverflowError,
73 "too many digits in integer");
Martin v. Löwis18e16552006-02-15 17:27:45 +000074 return NULL;
75 }
Christian Heimes4956d2b2008-01-18 19:12:56 +000076 /* coverity[ampersand_in_size] */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +000077 /* XXX(nnorwitz): PyObject_NEW_VAR / _PyObject_VAR_SIZE need to detect
78 overflow */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000079 return PyObject_NEW_VAR(PyLongObject, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +000080}
81
Tim Peters64b5ce32001-09-10 20:52:51 +000082PyObject *
83_PyLong_Copy(PyLongObject *src)
84{
85 PyLongObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +000086 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +000087
88 assert(src != NULL);
89 i = src->ob_size;
90 if (i < 0)
91 i = -(i);
92 result = _PyLong_New(i);
93 if (result != NULL) {
Tim Peters5329cdb2002-03-02 04:18:04 +000094 result->ob_size = src->ob_size;
Tim Peters64b5ce32001-09-10 20:52:51 +000095 while (--i >= 0)
96 result->ob_digit[i] = src->ob_digit[i];
97 }
98 return (PyObject *)result;
99}
100
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000101/* Create a new long int object from a C long int */
102
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000103PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000104PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000105{
Tim Petersce9de2f2001-06-14 04:56:19 +0000106 PyLongObject *v;
Mark Dickinson27a63252008-04-15 20:51:18 +0000107 unsigned long abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000108 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
109 int ndigits = 0;
110 int negative = 0;
111
112 if (ival < 0) {
Mark Dickinson27a63252008-04-15 20:51:18 +0000113 /* if LONG_MIN == -LONG_MAX-1 (true on most platforms) then
114 ANSI C says that the result of -ival is undefined when ival
115 == LONG_MIN. Hence the following workaround. */
116 abs_ival = (unsigned long)(-1-ival) + 1;
Tim Petersce9de2f2001-06-14 04:56:19 +0000117 negative = 1;
118 }
Mark Dickinson27a63252008-04-15 20:51:18 +0000119 else {
120 abs_ival = (unsigned long)ival;
121 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000122
123 /* Count the number of Python digits.
124 We used to pick 5 ("big enough for anything"), but that's a
125 waste of time and space given that 5*15 = 75 bits are rarely
126 needed. */
Mark Dickinson27a63252008-04-15 20:51:18 +0000127 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000128 while (t) {
129 ++ndigits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000130 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000131 }
132 v = _PyLong_New(ndigits);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000133 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000134 digit *p = v->ob_digit;
135 v->ob_size = negative ? -ndigits : ndigits;
Mark Dickinson27a63252008-04-15 20:51:18 +0000136 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000137 while (t) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000138 *p++ = (digit)(t & PyLong_MASK);
139 t >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000140 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000141 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000142 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000143}
144
Guido van Rossum53756b11997-01-03 17:14:46 +0000145/* Create a new long int object from a C unsigned long int */
146
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000147PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000148PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000149{
Tim Petersce9de2f2001-06-14 04:56:19 +0000150 PyLongObject *v;
151 unsigned long t;
152 int ndigits = 0;
153
154 /* Count the number of Python digits. */
155 t = (unsigned long)ival;
156 while (t) {
157 ++ndigits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000158 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000159 }
160 v = _PyLong_New(ndigits);
Guido van Rossum53756b11997-01-03 17:14:46 +0000161 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000162 digit *p = v->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +0000163 Py_SIZE(v) = ndigits;
Tim Petersce9de2f2001-06-14 04:56:19 +0000164 while (ival) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000165 *p++ = (digit)(ival & PyLong_MASK);
166 ival >>= PyLong_SHIFT;
Guido van Rossum53756b11997-01-03 17:14:46 +0000167 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000168 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000169 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000170}
171
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000172/* Create a new long int object from a C double */
173
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000174PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000175PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000176{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000177 PyLongObject *v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000178 double frac;
179 int i, ndig, expo, neg;
180 neg = 0;
Tim Peters39dce292000-08-15 03:34:48 +0000181 if (Py_IS_INFINITY(dval)) {
Guido van Rossum1a23c241999-09-27 17:11:52 +0000182 PyErr_SetString(PyExc_OverflowError,
Mark Dickinsonb6467572008-08-04 21:30:09 +0000183 "cannot convert float infinity to integer");
Guido van Rossum1a23c241999-09-27 17:11:52 +0000184 return NULL;
185 }
Christian Heimes8267d1d2008-01-04 00:37:34 +0000186 if (Py_IS_NAN(dval)) {
Mark Dickinsonb6467572008-08-04 21:30:09 +0000187 PyErr_SetString(PyExc_ValueError,
188 "cannot convert float NaN to integer");
189 return NULL;
Christian Heimes8267d1d2008-01-04 00:37:34 +0000190 }
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000191 if (dval < 0.0) {
192 neg = 1;
193 dval = -dval;
194 }
195 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
196 if (expo <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000197 return PyLong_FromLong(0L);
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000198 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000199 v = _PyLong_New(ndig);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000200 if (v == NULL)
201 return NULL;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000202 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000203 for (i = ndig; --i >= 0; ) {
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000204 digit bits = (digit)frac;
205 v->ob_digit[i] = bits;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000206 frac = frac - (double)bits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000207 frac = ldexp(frac, PyLong_SHIFT);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000208 }
209 if (neg)
Christian Heimese93237d2007-12-19 02:37:44 +0000210 Py_SIZE(v) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000212}
213
Armin Rigo7ccbca92006-10-04 12:17:45 +0000214/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
215 * anything about what happens when a signed integer operation overflows,
216 * and some compilers think they're doing you a favor by being "clever"
217 * then. The bit pattern for the largest postive signed long is
218 * (unsigned long)LONG_MAX, and for the smallest negative signed long
219 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
220 * However, some other compilers warn about applying unary minus to an
221 * unsigned operand. Hence the weird "0-".
222 */
223#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
224#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
225
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000226/* Get a C long int from a long int object.
227 Returns -1 and sets an error condition if overflow occurs. */
228
229long
Tim Peters9f688bf2000-07-07 15:53:28 +0000230PyLong_AsLong(PyObject *vv)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000231{
Guido van Rossumf7531811998-05-26 14:33:37 +0000232 /* This version by Tim Peters */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000233 register PyLongObject *v;
Guido van Rossumf7531811998-05-26 14:33:37 +0000234 unsigned long x, prev;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000235 Py_ssize_t i;
236 int sign;
Guido van Rossumf7531811998-05-26 14:33:37 +0000237
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000238 if (vv == NULL || !PyLong_Check(vv)) {
Guido van Rossum7e35d572001-09-15 03:14:32 +0000239 if (vv != NULL && PyInt_Check(vv))
240 return PyInt_AsLong(vv);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000241 PyErr_BadInternalCall();
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000242 return -1;
243 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 v = (PyLongObject *)vv;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000245 i = v->ob_size;
246 sign = 1;
247 x = 0;
248 if (i < 0) {
249 sign = -1;
Guido van Rossum4c260ff1992-01-14 18:36:43 +0000250 i = -(i);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000251 }
252 while (--i >= 0) {
253 prev = x;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000254 x = (x << PyLong_SHIFT) + v->ob_digit[i];
255 if ((x >> PyLong_SHIFT) != prev)
Guido van Rossumf7531811998-05-26 14:33:37 +0000256 goto overflow;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000257 }
Armin Rigo7ccbca92006-10-04 12:17:45 +0000258 /* Haven't lost any bits, but casting to long requires extra care
259 * (see comment above).
260 */
261 if (x <= (unsigned long)LONG_MAX) {
262 return (long)x * sign;
263 }
264 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
265 return LONG_MIN;
266 }
267 /* else overflow */
Guido van Rossumf7531811998-05-26 14:33:37 +0000268
269 overflow:
270 PyErr_SetString(PyExc_OverflowError,
Skip Montanarobafedec2001-09-13 19:05:30 +0000271 "long int too large to convert to int");
Guido van Rossumf7531811998-05-26 14:33:37 +0000272 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000273}
274
Neal Norwitz8a87f5d2006-08-12 17:03:09 +0000275/* Get a Py_ssize_t from a long int object.
276 Returns -1 and sets an error condition if overflow occurs. */
277
278Py_ssize_t
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000279PyLong_AsSsize_t(PyObject *vv) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000280 register PyLongObject *v;
281 size_t x, prev;
282 Py_ssize_t i;
283 int sign;
284
285 if (vv == NULL || !PyLong_Check(vv)) {
286 PyErr_BadInternalCall();
287 return -1;
288 }
289 v = (PyLongObject *)vv;
290 i = v->ob_size;
291 sign = 1;
292 x = 0;
293 if (i < 0) {
294 sign = -1;
295 i = -(i);
296 }
297 while (--i >= 0) {
298 prev = x;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000299 x = (x << PyLong_SHIFT) + v->ob_digit[i];
300 if ((x >> PyLong_SHIFT) != prev)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000301 goto overflow;
302 }
Armin Rigo7ccbca92006-10-04 12:17:45 +0000303 /* Haven't lost any bits, but casting to a signed type requires
304 * extra care (see comment above).
Martin v. Löwis18e16552006-02-15 17:27:45 +0000305 */
Armin Rigo7ccbca92006-10-04 12:17:45 +0000306 if (x <= (size_t)PY_SSIZE_T_MAX) {
307 return (Py_ssize_t)x * sign;
308 }
309 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
310 return PY_SSIZE_T_MIN;
311 }
312 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000313
314 overflow:
315 PyErr_SetString(PyExc_OverflowError,
316 "long int too large to convert to int");
Neal Norwitz8a87f5d2006-08-12 17:03:09 +0000317 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000318}
319
Guido van Rossumd8c80482002-08-13 00:24:58 +0000320/* Get a C unsigned long int from a long int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000321 Returns -1 and sets an error condition if overflow occurs. */
322
323unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000324PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000325{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000326 register PyLongObject *v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000327 unsigned long x, prev;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000328 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000329
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000330 if (vv == NULL || !PyLong_Check(vv)) {
Martin v. Löwis729d47d2004-09-20 06:17:46 +0000331 if (vv != NULL && PyInt_Check(vv)) {
332 long val = PyInt_AsLong(vv);
333 if (val < 0) {
334 PyErr_SetString(PyExc_OverflowError,
335 "can't convert negative value to unsigned long");
336 return (unsigned long) -1;
337 }
338 return val;
339 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000340 PyErr_BadInternalCall();
Guido van Rossum53756b11997-01-03 17:14:46 +0000341 return (unsigned long) -1;
342 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000343 v = (PyLongObject *)vv;
Christian Heimese93237d2007-12-19 02:37:44 +0000344 i = Py_SIZE(v);
Guido van Rossum53756b11997-01-03 17:14:46 +0000345 x = 0;
346 if (i < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000347 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum53756b11997-01-03 17:14:46 +0000348 "can't convert negative value to unsigned long");
349 return (unsigned long) -1;
350 }
351 while (--i >= 0) {
352 prev = x;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000353 x = (x << PyLong_SHIFT) + v->ob_digit[i];
354 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000355 PyErr_SetString(PyExc_OverflowError,
Fred Drake661ea262000-10-24 19:57:45 +0000356 "long int too large to convert");
Guido van Rossum53756b11997-01-03 17:14:46 +0000357 return (unsigned long) -1;
358 }
359 }
360 return x;
361}
362
Thomas Hellera4ea6032003-04-17 18:55:45 +0000363/* Get a C unsigned long int from a long int object, ignoring the high bits.
364 Returns -1 and sets an error condition if an error occurs. */
365
366unsigned long
367PyLong_AsUnsignedLongMask(PyObject *vv)
368{
369 register PyLongObject *v;
370 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000371 Py_ssize_t i;
372 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000373
374 if (vv == NULL || !PyLong_Check(vv)) {
Martin v. Löwis729d47d2004-09-20 06:17:46 +0000375 if (vv != NULL && PyInt_Check(vv))
376 return PyInt_AsUnsignedLongMask(vv);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000377 PyErr_BadInternalCall();
378 return (unsigned long) -1;
379 }
380 v = (PyLongObject *)vv;
381 i = v->ob_size;
382 sign = 1;
383 x = 0;
384 if (i < 0) {
385 sign = -1;
386 i = -i;
387 }
388 while (--i >= 0) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000389 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +0000390 }
391 return x * sign;
392}
393
Tim Peters5b8132f2003-01-31 15:52:05 +0000394int
395_PyLong_Sign(PyObject *vv)
396{
397 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000398
399 assert(v != NULL);
400 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000401
Christian Heimese93237d2007-12-19 02:37:44 +0000402 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000403}
404
Tim Petersbaefd9e2003-01-28 20:37:45 +0000405size_t
406_PyLong_NumBits(PyObject *vv)
407{
408 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000409 size_t result = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000410 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000411
412 assert(v != NULL);
413 assert(PyLong_Check(v));
Christian Heimese93237d2007-12-19 02:37:44 +0000414 ndigits = ABS(Py_SIZE(v));
Tim Petersbaefd9e2003-01-28 20:37:45 +0000415 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
416 if (ndigits > 0) {
Tim Petersbaefd9e2003-01-28 20:37:45 +0000417 digit msd = v->ob_digit[ndigits - 1];
418
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000419 result = (ndigits - 1) * PyLong_SHIFT;
420 if (result / PyLong_SHIFT != (size_t)(ndigits - 1))
Tim Petersbaefd9e2003-01-28 20:37:45 +0000421 goto Overflow;
422 do {
423 ++result;
424 if (result == 0)
425 goto Overflow;
426 msd >>= 1;
427 } while (msd);
428 }
429 return result;
430
431Overflow:
432 PyErr_SetString(PyExc_OverflowError, "long has too many bits "
433 "to express in a platform size_t");
434 return (size_t)-1;
435}
436
Tim Peters2a9b3672001-06-11 21:23:58 +0000437PyObject *
438_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
439 int little_endian, int is_signed)
440{
441 const unsigned char* pstartbyte;/* LSB of bytes */
442 int incr; /* direction to move pstartbyte */
443 const unsigned char* pendbyte; /* MSB of bytes */
444 size_t numsignificantbytes; /* number of bytes that matter */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000445 Py_ssize_t ndigits; /* number of Python long digits */
Tim Peters2a9b3672001-06-11 21:23:58 +0000446 PyLongObject* v; /* result */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000447 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000448
449 if (n == 0)
450 return PyLong_FromLong(0L);
451
452 if (little_endian) {
453 pstartbyte = bytes;
454 pendbyte = bytes + n - 1;
455 incr = 1;
456 }
457 else {
458 pstartbyte = bytes + n - 1;
459 pendbyte = bytes;
460 incr = -1;
461 }
462
463 if (is_signed)
464 is_signed = *pendbyte >= 0x80;
465
466 /* Compute numsignificantbytes. This consists of finding the most
467 significant byte. Leading 0 bytes are insignficant if the number
468 is positive, and leading 0xff bytes if negative. */
469 {
470 size_t i;
471 const unsigned char* p = pendbyte;
472 const int pincr = -incr; /* search MSB to LSB */
473 const unsigned char insignficant = is_signed ? 0xff : 0x00;
474
475 for (i = 0; i < n; ++i, p += pincr) {
476 if (*p != insignficant)
477 break;
478 }
479 numsignificantbytes = n - i;
480 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
481 actually has 2 significant bytes. OTOH, 0xff0001 ==
482 -0x00ffff, so we wouldn't *need* to bump it there; but we
483 do for 0xffff = -0x0001. To be safe without bothering to
484 check every case, bump it regardless. */
485 if (is_signed && numsignificantbytes < n)
486 ++numsignificantbytes;
487 }
488
489 /* How many Python long digits do we need? We have
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000490 8*numsignificantbytes bits, and each Python long digit has
491 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
492 /* catch overflow before it happens */
493 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
494 PyErr_SetString(PyExc_OverflowError,
495 "byte array too long to convert to int");
496 return NULL;
497 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000498 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000499 v = _PyLong_New(ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000500 if (v == NULL)
501 return NULL;
502
503 /* Copy the bits over. The tricky parts are computing 2's-comp on
504 the fly for signed numbers, and dealing with the mismatch between
505 8-bit bytes and (probably) 15-bit Python digits.*/
506 {
507 size_t i;
Tim Petersf251d062001-06-13 21:09:15 +0000508 twodigits carry = 1; /* for 2's-comp calculation */
Tim Peters2a9b3672001-06-11 21:23:58 +0000509 twodigits accum = 0; /* sliding register */
510 unsigned int accumbits = 0; /* number of bits in accum */
511 const unsigned char* p = pstartbyte;
512
513 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
Tim Peters8bc84b42001-06-12 19:17:03 +0000514 twodigits thisbyte = *p;
Tim Peters2a9b3672001-06-11 21:23:58 +0000515 /* Compute correction for 2's comp, if needed. */
516 if (is_signed) {
517 thisbyte = (0xff ^ thisbyte) + carry;
518 carry = thisbyte >> 8;
519 thisbyte &= 0xff;
520 }
521 /* Because we're going LSB to MSB, thisbyte is
522 more significant than what's already in accum,
523 so needs to be prepended to accum. */
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000524 accum |= (twodigits)thisbyte << accumbits;
Tim Peters2a9b3672001-06-11 21:23:58 +0000525 accumbits += 8;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000526 if (accumbits >= PyLong_SHIFT) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000527 /* There's enough to fill a Python digit. */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000528 assert(idigit < ndigits);
529 v->ob_digit[idigit] = (digit)(accum &
530 PyLong_MASK);
Tim Peters2a9b3672001-06-11 21:23:58 +0000531 ++idigit;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000532 accum >>= PyLong_SHIFT;
533 accumbits -= PyLong_SHIFT;
534 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000535 }
536 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000537 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000538 if (accumbits) {
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000539 assert(idigit < ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000540 v->ob_digit[idigit] = (digit)accum;
541 ++idigit;
542 }
543 }
544
Christian Heimese93237d2007-12-19 02:37:44 +0000545 Py_SIZE(v) = is_signed ? -idigit : idigit;
Tim Peters2a9b3672001-06-11 21:23:58 +0000546 return (PyObject *)long_normalize(v);
547}
548
549int
550_PyLong_AsByteArray(PyLongObject* v,
551 unsigned char* bytes, size_t n,
552 int little_endian, int is_signed)
553{
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000554 Py_ssize_t i; /* index into v->ob_digit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000555 Py_ssize_t ndigits; /* |v->ob_size| */
Tim Peters2a9b3672001-06-11 21:23:58 +0000556 twodigits accum; /* sliding register */
557 unsigned int accumbits; /* # bits in accum */
558 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
Mark Dickinson1afe6dd2009-01-25 22:12:31 +0000559 digit carry; /* for computing 2's-comp */
Tim Peters2a9b3672001-06-11 21:23:58 +0000560 size_t j; /* # bytes filled */
561 unsigned char* p; /* pointer to next byte in bytes */
562 int pincr; /* direction to move p */
563
564 assert(v != NULL && PyLong_Check(v));
565
Christian Heimese93237d2007-12-19 02:37:44 +0000566 if (Py_SIZE(v) < 0) {
567 ndigits = -(Py_SIZE(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000568 if (!is_signed) {
Mark Dickinson4015f622009-02-10 15:46:50 +0000569 PyErr_SetString(PyExc_OverflowError,
Tim Peters2a9b3672001-06-11 21:23:58 +0000570 "can't convert negative long to unsigned");
571 return -1;
572 }
573 do_twos_comp = 1;
574 }
575 else {
Christian Heimese93237d2007-12-19 02:37:44 +0000576 ndigits = Py_SIZE(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000577 do_twos_comp = 0;
578 }
579
580 if (little_endian) {
581 p = bytes;
582 pincr = 1;
583 }
584 else {
585 p = bytes + n - 1;
586 pincr = -1;
587 }
588
Tim Peters898cf852001-06-13 20:50:08 +0000589 /* Copy over all the Python digits.
590 It's crucial that every Python digit except for the MSD contribute
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000591 exactly PyLong_SHIFT bits to the total, so first assert that the long is
Tim Peters898cf852001-06-13 20:50:08 +0000592 normalized. */
593 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
Tim Peters2a9b3672001-06-11 21:23:58 +0000594 j = 0;
595 accum = 0;
596 accumbits = 0;
597 carry = do_twos_comp ? 1 : 0;
598 for (i = 0; i < ndigits; ++i) {
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000599 digit thisdigit = v->ob_digit[i];
Tim Peters2a9b3672001-06-11 21:23:58 +0000600 if (do_twos_comp) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000601 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
602 carry = thisdigit >> PyLong_SHIFT;
603 thisdigit &= PyLong_MASK;
Tim Peters2a9b3672001-06-11 21:23:58 +0000604 }
Tim Peters8bc84b42001-06-12 19:17:03 +0000605 /* Because we're going LSB to MSB, thisdigit is more
606 significant than what's already in accum, so needs to be
607 prepended to accum. */
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000608 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000609
Tim Petersede05092001-06-14 08:53:38 +0000610 /* The most-significant digit may be (probably is) at least
611 partly empty. */
Tim Peters8bc84b42001-06-12 19:17:03 +0000612 if (i == ndigits - 1) {
Tim Petersede05092001-06-14 08:53:38 +0000613 /* Count # of sign bits -- they needn't be stored,
614 * although for signed conversion we need later to
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000615 * make sure at least one sign bit gets stored. */
616 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK :
617 thisdigit;
618 while (s != 0) {
619 s >>= 1;
620 accumbits++;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000621 }
Tim Peters7a3bfc32001-06-12 01:22:22 +0000622 }
Mark Dickinsonff84aa82009-01-24 15:27:44 +0000623 else
624 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000625
Tim Peters2a9b3672001-06-11 21:23:58 +0000626 /* Store as many bytes as possible. */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000627 while (accumbits >= 8) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000628 if (j >= n)
629 goto Overflow;
630 ++j;
631 *p = (unsigned char)(accum & 0xff);
632 p += pincr;
633 accumbits -= 8;
634 accum >>= 8;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000635 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000636 }
637
638 /* Store the straggler (if any). */
639 assert(accumbits < 8);
640 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000641 if (accumbits > 0) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000642 if (j >= n)
643 goto Overflow;
644 ++j;
645 if (do_twos_comp) {
646 /* Fill leading bits of the byte with sign bits
647 (appropriately pretending that the long had an
648 infinite supply of sign bits). */
649 accum |= (~(twodigits)0) << accumbits;
650 }
651 *p = (unsigned char)(accum & 0xff);
652 p += pincr;
653 }
Tim Peters05607ad2001-06-13 21:01:27 +0000654 else if (j == n && n > 0 && is_signed) {
655 /* The main loop filled the byte array exactly, so the code
656 just above didn't get to ensure there's a sign bit, and the
657 loop below wouldn't add one either. Make sure a sign bit
658 exists. */
Tim Peters2a9b3672001-06-11 21:23:58 +0000659 unsigned char msb = *(p - pincr);
Tim Peters05607ad2001-06-13 21:01:27 +0000660 int sign_bit_set = msb >= 0x80;
661 assert(accumbits == 0);
662 if (sign_bit_set == do_twos_comp)
663 return 0;
664 else
Tim Peters2a9b3672001-06-11 21:23:58 +0000665 goto Overflow;
666 }
Tim Peters05607ad2001-06-13 21:01:27 +0000667
668 /* Fill remaining bytes with copies of the sign bit. */
669 {
670 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
671 for ( ; j < n; ++j, p += pincr)
672 *p = signbyte;
673 }
674
Tim Peters2a9b3672001-06-11 21:23:58 +0000675 return 0;
676
677Overflow:
678 PyErr_SetString(PyExc_OverflowError, "long too big to convert");
679 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000680
Tim Peters2a9b3672001-06-11 21:23:58 +0000681}
682
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000683double
684_PyLong_AsScaledDouble(PyObject *vv, int *exponent)
685{
686/* NBITS_WANTED should be > the number of bits in a double's precision,
687 but small enough so that 2**NBITS_WANTED is within the normal double
688 range. nbitsneeded is set to 1 less than that because the most-significant
689 Python digit contains at least 1 significant bit, but we don't want to
690 bother counting them (catering to the worst case cheaply).
691
692 57 is one more than VAX-D double precision; I (Tim) don't know of a double
693 format with more precision than that; it's 1 larger so that we add in at
694 least one round bit to stand in for the ignored least-significant bits.
695*/
696#define NBITS_WANTED 57
697 PyLongObject *v;
698 double x;
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000699 const double multiplier = (double)(1L << PyLong_SHIFT);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000700 Py_ssize_t i;
701 int sign;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000702 int nbitsneeded;
703
704 if (vv == NULL || !PyLong_Check(vv)) {
705 PyErr_BadInternalCall();
706 return -1;
707 }
708 v = (PyLongObject *)vv;
Christian Heimese93237d2007-12-19 02:37:44 +0000709 i = Py_SIZE(v);
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000710 sign = 1;
711 if (i < 0) {
712 sign = -1;
713 i = -(i);
714 }
715 else if (i == 0) {
716 *exponent = 0;
717 return 0.0;
718 }
719 --i;
720 x = (double)v->ob_digit[i];
721 nbitsneeded = NBITS_WANTED - 1;
722 /* Invariant: i Python digits remain unaccounted for. */
723 while (i > 0 && nbitsneeded > 0) {
724 --i;
725 x = x * multiplier + (double)v->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000726 nbitsneeded -= PyLong_SHIFT;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000727 }
728 /* There are i digits we didn't shift in. Pretending they're all
Christian Heimes7f39c9f2008-01-25 12:18:43 +0000729 zeroes, the true value is x * 2**(i*PyLong_SHIFT). */
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000730 *exponent = i;
731 assert(x > 0.0);
732 return x * sign;
733#undef NBITS_WANTED
734}
735
Mark Dickinson6736cf82009-04-20 21:13:33 +0000736/* Get a C double from a long int object. Rounds to the nearest double,
737 using the round-half-to-even rule in the case of a tie. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000738
739double
Tim Peters9f688bf2000-07-07 15:53:28 +0000740PyLong_AsDouble(PyObject *vv)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000741{
Mark Dickinson6736cf82009-04-20 21:13:33 +0000742 PyLongObject *v = (PyLongObject *)vv;
743 Py_ssize_t rnd_digit, rnd_bit, m, n;
744 digit lsb, *d;
745 int round_up = 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000746 double x;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000747
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000748 if (vv == NULL || !PyLong_Check(vv)) {
749 PyErr_BadInternalCall();
Tim Peters9fffa3e2001-09-04 05:14:19 +0000750 return -1.0;
Mark Dickinson6736cf82009-04-20 21:13:33 +0000751 }
Tim Peters9fffa3e2001-09-04 05:14:19 +0000752
Mark Dickinson6736cf82009-04-20 21:13:33 +0000753 /* Notes on the method: for simplicity, assume v is positive and >=
754 2**DBL_MANT_DIG. (For negative v we just ignore the sign until the
755 end; for small v no rounding is necessary.) Write n for the number
756 of bits in v, so that 2**(n-1) <= v < 2**n, and n > DBL_MANT_DIG.
757
758 Some terminology: the *rounding bit* of v is the 1st bit of v that
759 will be rounded away (bit n - DBL_MANT_DIG - 1); the *parity bit*
760 is the bit immediately above. The round-half-to-even rule says
761 that we round up if the rounding bit is set, unless v is exactly
762 halfway between two floats and the parity bit is zero.
763
764 Write d[0] ... d[m] for the digits of v, least to most significant.
765 Let rnd_bit be the index of the rounding bit, and rnd_digit the
766 index of the PyLong digit containing the rounding bit. Then the
767 bits of the digit d[rnd_digit] look something like:
768
769 rounding bit
770 |
771 v
772 msb -> sssssrttttttttt <- lsb
773 ^
774 |
775 parity bit
776
777 where 's' represents a 'significant bit' that will be included in
778 the mantissa of the result, 'r' is the rounding bit, and 't'
779 represents a 'trailing bit' following the rounding bit. Note that
780 if the rounding bit is at the top of d[rnd_digit] then the parity
781 bit will be the lsb of d[rnd_digit+1]. If we set
782
783 lsb = 1 << (rnd_bit % PyLong_SHIFT)
784
785 then d[rnd_digit] & (PyLong_BASE - 2*lsb) selects just the
786 significant bits of d[rnd_digit], d[rnd_digit] & (lsb-1) gets the
787 trailing bits, and d[rnd_digit] & lsb gives the rounding bit.
788
789 We initialize the double x to the integer given by digits
790 d[rnd_digit:m-1], but with the rounding bit and trailing bits of
791 d[rnd_digit] masked out. So the value of x comes from the top
792 DBL_MANT_DIG bits of v, multiplied by 2*lsb. Note that in the loop
793 that produces x, all floating-point operations are exact (assuming
794 that FLT_RADIX==2). Now if we're rounding down, the value we want
795 to return is simply
796
797 x * 2**(PyLong_SHIFT * rnd_digit).
798
799 and if we're rounding up, it's
800
801 (x + 2*lsb) * 2**(PyLong_SHIFT * rnd_digit).
802
803 Under the round-half-to-even rule, we round up if, and only
804 if, the rounding bit is set *and* at least one of the
805 following three conditions is satisfied:
806
807 (1) the parity bit is set, or
808 (2) at least one of the trailing bits of d[rnd_digit] is set, or
809 (3) at least one of the digits d[i], 0 <= i < rnd_digit
810 is nonzero.
811
812 Finally, we have to worry about overflow. If v >= 2**DBL_MAX_EXP,
813 or equivalently n > DBL_MAX_EXP, then overflow occurs. If v <
814 2**DBL_MAX_EXP then we're usually safe, but there's a corner case
815 to consider: if v is very close to 2**DBL_MAX_EXP then it's
816 possible that v is rounded up to exactly 2**DBL_MAX_EXP, and then
817 again overflow occurs.
818 */
819
820 if (Py_SIZE(v) == 0)
821 return 0.0;
822 m = ABS(Py_SIZE(v)) - 1;
823 d = v->ob_digit;
824 assert(d[m]); /* v should be normalized */
825
826 /* fast path for case where 0 < abs(v) < 2**DBL_MANT_DIG */
827 if (m < DBL_MANT_DIG / PyLong_SHIFT ||
828 (m == DBL_MANT_DIG / PyLong_SHIFT &&
829 d[m] < (digit)1 << DBL_MANT_DIG%PyLong_SHIFT)) {
830 x = d[m];
831 while (--m >= 0)
832 x = x*PyLong_BASE + d[m];
833 return Py_SIZE(v) < 0 ? -x : x;
834 }
835
836 /* if m is huge then overflow immediately; otherwise, compute the
837 number of bits n in v. The condition below implies n (= #bits) >=
838 m * PyLong_SHIFT + 1 > DBL_MAX_EXP, hence v >= 2**DBL_MAX_EXP. */
839 if (m > (DBL_MAX_EXP-1)/PyLong_SHIFT)
840 goto overflow;
841 n = m * PyLong_SHIFT + bits_in_digit(d[m]);
842 if (n > DBL_MAX_EXP)
843 goto overflow;
844
845 /* find location of rounding bit */
846 assert(n > DBL_MANT_DIG); /* dealt with |v| < 2**DBL_MANT_DIG above */
847 rnd_bit = n - DBL_MANT_DIG - 1;
848 rnd_digit = rnd_bit/PyLong_SHIFT;
849 lsb = (digit)1 << (rnd_bit%PyLong_SHIFT);
850
851 /* Get top DBL_MANT_DIG bits of v. Assumes PyLong_SHIFT <
852 DBL_MANT_DIG, so we'll need bits from at least 2 digits of v. */
853 x = d[m];
854 assert(m > rnd_digit);
855 while (--m > rnd_digit)
856 x = x*PyLong_BASE + d[m];
857 x = x*PyLong_BASE + (d[m] & (PyLong_BASE-2*lsb));
858
859 /* decide whether to round up, using round-half-to-even */
860 assert(m == rnd_digit);
861 if (d[m] & lsb) { /* if (rounding bit is set) */
862 digit parity_bit;
863 if (lsb == PyLong_BASE/2)
864 parity_bit = d[m+1] & 1;
865 else
866 parity_bit = d[m] & 2*lsb;
867 if (parity_bit)
868 round_up = 1;
869 else if (d[m] & (lsb-1))
870 round_up = 1;
871 else {
872 while (--m >= 0) {
873 if (d[m]) {
874 round_up = 1;
875 break;
876 }
877 }
878 }
879 }
880
881 /* and round up if necessary */
882 if (round_up) {
883 x += 2*lsb;
884 if (n == DBL_MAX_EXP &&
885 x == ldexp((double)(2*lsb), DBL_MANT_DIG)) {
886 /* overflow corner case */
887 goto overflow;
888 }
889 }
890
891 /* shift, adjust for sign, and return */
892 x = ldexp(x, rnd_digit*PyLong_SHIFT);
893 return Py_SIZE(v) < 0 ? -x : x;
894
895 overflow:
Tim Peters9fffa3e2001-09-04 05:14:19 +0000896 PyErr_SetString(PyExc_OverflowError,
897 "long int too large to convert to float");
898 return -1.0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000899}
900
Guido van Rossum78694d91998-09-18 14:14:13 +0000901/* Create a new long (or int) object from a C pointer */
902
903PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000904PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +0000905{
Tim Peters70128a12001-06-16 08:48:40 +0000906#if SIZEOF_VOID_P <= SIZEOF_LONG
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000907 if ((long)p < 0)
908 return PyLong_FromUnsignedLong((unsigned long)p);
Guido van Rossum78694d91998-09-18 14:14:13 +0000909 return PyInt_FromLong((long)p);
910#else
Guido van Rossum78694d91998-09-18 14:14:13 +0000911
Tim Peters70128a12001-06-16 08:48:40 +0000912#ifndef HAVE_LONG_LONG
913# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
914#endif
915#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000916# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +0000917#endif
918 /* optimize null pointers */
919 if (p == NULL)
920 return PyInt_FromLong(0);
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000921 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)p);
Tim Peters70128a12001-06-16 08:48:40 +0000922
923#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +0000924}
925
926/* Get a C pointer from a long object (or an int object in some cases) */
927
928void *
Tim Peters9f688bf2000-07-07 15:53:28 +0000929PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +0000930{
931 /* This function will allow int or long objects. If vv is neither,
932 then the PyLong_AsLong*() functions will raise the exception:
933 PyExc_SystemError, "bad argument to internal function"
934 */
Tim Peters70128a12001-06-16 08:48:40 +0000935#if SIZEOF_VOID_P <= SIZEOF_LONG
Guido van Rossum78694d91998-09-18 14:14:13 +0000936 long x;
937
Tim Peters70128a12001-06-16 08:48:40 +0000938 if (PyInt_Check(vv))
Guido van Rossum78694d91998-09-18 14:14:13 +0000939 x = PyInt_AS_LONG(vv);
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000940 else if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +0000941 x = PyLong_AsLong(vv);
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000942 else
943 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +0000944#else
Tim Peters70128a12001-06-16 08:48:40 +0000945
946#ifndef HAVE_LONG_LONG
947# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
948#endif
949#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000950# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +0000951#endif
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000952 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +0000953
Tim Peters70128a12001-06-16 08:48:40 +0000954 if (PyInt_Check(vv))
Guido van Rossum78694d91998-09-18 14:14:13 +0000955 x = PyInt_AS_LONG(vv);
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000956 else if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +0000957 x = PyLong_AsLongLong(vv);
Martin v. Löwis0bc2ab92006-04-10 20:28:17 +0000958 else
959 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +0000960
961#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +0000962
963 if (x == -1 && PyErr_Occurred())
964 return NULL;
965 return (void *)x;
966}
967
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000968#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +0000969
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000970/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +0000971 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000972 */
973
Tim Peterscf37dfc2001-06-14 18:42:50 +0000974#define IS_LITTLE_ENDIAN (int)*(unsigned char*)&one
Tim Petersd1a7da62001-06-13 00:35:57 +0000975
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000976/* Create a new long int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000977
978PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000979PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000980{
Bob Ippolitoa85bf202006-05-25 18:20:23 +0000981 PyLongObject *v;
Mark Dickinson27a63252008-04-15 20:51:18 +0000982 unsigned PY_LONG_LONG abs_ival;
Bob Ippolitoa85bf202006-05-25 18:20:23 +0000983 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
984 int ndigits = 0;
985 int negative = 0;
986
987 if (ival < 0) {
Mark Dickinson27a63252008-04-15 20:51:18 +0000988 /* avoid signed overflow on negation; see comments
989 in PyLong_FromLong above. */
990 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
Bob Ippolitoa85bf202006-05-25 18:20:23 +0000991 negative = 1;
992 }
Mark Dickinson27a63252008-04-15 20:51:18 +0000993 else {
994 abs_ival = (unsigned PY_LONG_LONG)ival;
995 }
Bob Ippolitoa85bf202006-05-25 18:20:23 +0000996
997 /* Count the number of Python digits.
998 We used to pick 5 ("big enough for anything"), but that's a
999 waste of time and space given that 5*15 = 75 bits are rarely
1000 needed. */
Mark Dickinson27a63252008-04-15 20:51:18 +00001001 t = abs_ival;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001002 while (t) {
1003 ++ndigits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001004 t >>= PyLong_SHIFT;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001005 }
1006 v = _PyLong_New(ndigits);
1007 if (v != NULL) {
1008 digit *p = v->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +00001009 Py_SIZE(v) = negative ? -ndigits : ndigits;
Mark Dickinson27a63252008-04-15 20:51:18 +00001010 t = abs_ival;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001011 while (t) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001012 *p++ = (digit)(t & PyLong_MASK);
1013 t >>= PyLong_SHIFT;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001014 }
1015 }
1016 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001017}
1018
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001019/* Create a new long int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001020
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001021PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001022PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001023{
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001024 PyLongObject *v;
1025 unsigned PY_LONG_LONG t;
1026 int ndigits = 0;
1027
1028 /* Count the number of Python digits. */
1029 t = (unsigned PY_LONG_LONG)ival;
1030 while (t) {
1031 ++ndigits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001032 t >>= PyLong_SHIFT;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001033 }
1034 v = _PyLong_New(ndigits);
1035 if (v != NULL) {
1036 digit *p = v->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +00001037 Py_SIZE(v) = ndigits;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001038 while (ival) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001039 *p++ = (digit)(ival & PyLong_MASK);
1040 ival >>= PyLong_SHIFT;
Bob Ippolitoa85bf202006-05-25 18:20:23 +00001041 }
1042 }
1043 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001044}
1045
Martin v. Löwis18e16552006-02-15 17:27:45 +00001046/* Create a new long int object from a C Py_ssize_t. */
1047
1048PyObject *
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001049PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001050{
1051 Py_ssize_t bytes = ival;
1052 int one = 1;
1053 return _PyLong_FromByteArray(
1054 (unsigned char *)&bytes,
Kristján Valur Jónssonf0303942007-05-03 20:27:03 +00001055 SIZEOF_SIZE_T, IS_LITTLE_ENDIAN, 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001056}
1057
1058/* Create a new long int object from a C size_t. */
1059
1060PyObject *
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001061PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001062{
1063 size_t bytes = ival;
1064 int one = 1;
1065 return _PyLong_FromByteArray(
1066 (unsigned char *)&bytes,
1067 SIZEOF_SIZE_T, IS_LITTLE_ENDIAN, 0);
1068}
1069
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001070/* Get a C PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001071 Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001072
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001073PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001074PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001075{
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001076 PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001077 int one = 1;
1078 int res;
1079
Tim Petersd38b1c72001-09-30 05:09:37 +00001080 if (vv == NULL) {
1081 PyErr_BadInternalCall();
1082 return -1;
1083 }
1084 if (!PyLong_Check(vv)) {
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001085 PyNumberMethods *nb;
1086 PyObject *io;
Tim Petersd38b1c72001-09-30 05:09:37 +00001087 if (PyInt_Check(vv))
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001088 return (PY_LONG_LONG)PyInt_AsLong(vv);
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001089 if ((nb = vv->ob_type->tp_as_number) == NULL ||
1090 nb->nb_int == NULL) {
1091 PyErr_SetString(PyExc_TypeError, "an integer is required");
1092 return -1;
1093 }
1094 io = (*nb->nb_int) (vv);
1095 if (io == NULL)
1096 return -1;
1097 if (PyInt_Check(io)) {
1098 bytes = PyInt_AsLong(io);
1099 Py_DECREF(io);
1100 return bytes;
1101 }
1102 if (PyLong_Check(io)) {
1103 bytes = PyLong_AsLongLong(io);
1104 Py_DECREF(io);
1105 return bytes;
1106 }
1107 Py_DECREF(io);
1108 PyErr_SetString(PyExc_TypeError, "integer conversion failed");
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001109 return -1;
1110 }
1111
Tim Petersd1a7da62001-06-13 00:35:57 +00001112 res = _PyLong_AsByteArray(
1113 (PyLongObject *)vv, (unsigned char *)&bytes,
1114 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 1);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001115
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001116 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001117 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001118 return (PY_LONG_LONG)-1;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001119 else
1120 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001121}
1122
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001123/* Get a C unsigned PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001124 Return -1 and set an error if overflow occurs. */
1125
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001126unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001127PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001128{
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001129 unsigned PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001130 int one = 1;
1131 int res;
1132
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001133 if (vv == NULL || !PyLong_Check(vv)) {
1134 PyErr_BadInternalCall();
Skip Montanaro429433b2006-04-18 00:35:43 +00001135 return (unsigned PY_LONG_LONG)-1;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001136 }
1137
Tim Petersd1a7da62001-06-13 00:35:57 +00001138 res = _PyLong_AsByteArray(
1139 (PyLongObject *)vv, (unsigned char *)&bytes,
1140 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001141
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001142 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001143 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001144 return (unsigned PY_LONG_LONG)res;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001145 else
1146 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001147}
Tim Petersd1a7da62001-06-13 00:35:57 +00001148
Thomas Hellera4ea6032003-04-17 18:55:45 +00001149/* Get a C unsigned long int from a long int object, ignoring the high bits.
1150 Returns -1 and sets an error condition if an error occurs. */
1151
1152unsigned PY_LONG_LONG
1153PyLong_AsUnsignedLongLongMask(PyObject *vv)
1154{
1155 register PyLongObject *v;
1156 unsigned PY_LONG_LONG x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001157 Py_ssize_t i;
1158 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001159
1160 if (vv == NULL || !PyLong_Check(vv)) {
1161 PyErr_BadInternalCall();
1162 return (unsigned long) -1;
1163 }
1164 v = (PyLongObject *)vv;
1165 i = v->ob_size;
1166 sign = 1;
1167 x = 0;
1168 if (i < 0) {
1169 sign = -1;
1170 i = -i;
1171 }
1172 while (--i >= 0) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001173 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +00001174 }
1175 return x * sign;
1176}
Tim Petersd1a7da62001-06-13 00:35:57 +00001177#undef IS_LITTLE_ENDIAN
1178
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001179#endif /* HAVE_LONG_LONG */
1180
Neil Schemenauerba872e22001-01-04 01:46:03 +00001181
1182static int
1183convert_binop(PyObject *v, PyObject *w, PyLongObject **a, PyLongObject **b) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00001184 if (PyLong_Check(v)) {
Neil Schemenauerba872e22001-01-04 01:46:03 +00001185 *a = (PyLongObject *) v;
1186 Py_INCREF(v);
1187 }
1188 else if (PyInt_Check(v)) {
1189 *a = (PyLongObject *) PyLong_FromLong(PyInt_AS_LONG(v));
1190 }
1191 else {
1192 return 0;
1193 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00001194 if (PyLong_Check(w)) {
Neil Schemenauerba872e22001-01-04 01:46:03 +00001195 *b = (PyLongObject *) w;
1196 Py_INCREF(w);
1197 }
1198 else if (PyInt_Check(w)) {
1199 *b = (PyLongObject *) PyLong_FromLong(PyInt_AS_LONG(w));
1200 }
1201 else {
1202 Py_DECREF(*a);
1203 return 0;
1204 }
1205 return 1;
1206}
1207
1208#define CONVERT_BINOP(v, w, a, b) \
1209 if (!convert_binop(v, w, a, b)) { \
1210 Py_INCREF(Py_NotImplemented); \
1211 return Py_NotImplemented; \
1212 }
1213
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001214/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1215 2**k if d is nonzero, else 0. */
1216
1217static const unsigned char BitLengthTable[32] = {
1218 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1219 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
1220};
1221
1222static int
1223bits_in_digit(digit d)
1224{
1225 int d_bits = 0;
1226 while (d >= 32) {
1227 d_bits += 6;
1228 d >>= 6;
1229 }
1230 d_bits += (int)BitLengthTable[d];
1231 return d_bits;
1232}
1233
Tim Peters877a2122002-08-12 05:09:36 +00001234/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1235 * is modified in place, by adding y to it. Carries are propagated as far as
1236 * x[m-1], and the remaining carry (0 or 1) is returned.
1237 */
1238static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001239v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001240{
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001241 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001242 digit carry = 0;
1243
1244 assert(m >= n);
1245 for (i = 0; i < n; ++i) {
1246 carry += x[i] + y[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001247 x[i] = carry & PyLong_MASK;
1248 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001249 assert((carry & 1) == carry);
1250 }
1251 for (; carry && i < m; ++i) {
1252 carry += x[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001253 x[i] = carry & PyLong_MASK;
1254 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001255 assert((carry & 1) == carry);
1256 }
1257 return carry;
1258}
1259
1260/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1261 * is modified in place, by subtracting y from it. Borrows are propagated as
1262 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1263 */
1264static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001265v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001266{
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001267 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001268 digit borrow = 0;
1269
1270 assert(m >= n);
1271 for (i = 0; i < n; ++i) {
1272 borrow = x[i] - y[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001273 x[i] = borrow & PyLong_MASK;
1274 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001275 borrow &= 1; /* keep only 1 sign bit */
1276 }
1277 for (; borrow && i < m; ++i) {
1278 borrow = x[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001279 x[i] = borrow & PyLong_MASK;
1280 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001281 borrow &= 1;
1282 }
1283 return borrow;
1284}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001285
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001286/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1287 * result in z[0:m], and return the d bits shifted out of the top.
1288 */
1289static digit
1290v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001291{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001292 Py_ssize_t i;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001293 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001294
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001295 assert(0 <= d && d < PyLong_SHIFT);
1296 for (i=0; i < m; i++) {
1297 twodigits acc = (twodigits)a[i] << d | carry;
1298 z[i] = (digit)acc & PyLong_MASK;
1299 carry = (digit)(acc >> PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001300 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001301 return carry;
1302}
1303
1304/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1305 * result in z[0:m], and return the d bits shifted out of the bottom.
1306 */
1307static digit
1308v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1309{
1310 Py_ssize_t i;
1311 digit carry = 0;
1312 digit mask = ((digit)1 << d) - 1U;
1313
1314 assert(0 <= d && d < PyLong_SHIFT);
1315 for (i=m; i-- > 0;) {
1316 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1317 carry = (digit)acc & mask;
1318 z[i] = (digit)(acc >> d);
1319 }
1320 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001321}
1322
Tim Peters212e6142001-07-14 12:23:19 +00001323/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1324 in pout, and returning the remainder. pin and pout point at the LSD.
1325 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Eric Smith5e527eb2008-02-10 01:36:53 +00001326 _PyLong_Format, but that should be done with great care since longs are
Tim Peters212e6142001-07-14 12:23:19 +00001327 immutable. */
1328
1329static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001330inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001331{
1332 twodigits rem = 0;
1333
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001334 assert(n > 0 && n <= PyLong_MASK);
Tim Peters212e6142001-07-14 12:23:19 +00001335 pin += size;
1336 pout += size;
1337 while (--size >= 0) {
1338 digit hi;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001339 rem = (rem << PyLong_SHIFT) + *--pin;
Tim Peters212e6142001-07-14 12:23:19 +00001340 *--pout = hi = (digit)(rem / n);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001341 rem -= (twodigits)hi * n;
Tim Peters212e6142001-07-14 12:23:19 +00001342 }
1343 return (digit)rem;
1344}
1345
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001346/* Divide a long integer by a digit, returning both the quotient
1347 (as function result) and the remainder (through *prem).
1348 The sign of a is ignored; n should not be zero. */
1349
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001350static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001351divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001352{
Christian Heimese93237d2007-12-19 02:37:44 +00001353 const Py_ssize_t size = ABS(Py_SIZE(a));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001354 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001355
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001356 assert(n > 0 && n <= PyLong_MASK);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001357 z = _PyLong_New(size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001358 if (z == NULL)
1359 return NULL;
Tim Peters212e6142001-07-14 12:23:19 +00001360 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001361 return long_normalize(z);
1362}
1363
Mark Dickinsonaa2adc82009-09-16 22:10:56 +00001364/* Convert a long integer to a base 10 string. Returns a new non-shared
1365 string. (Return value is non-shared so that callers can modify the
1366 returned value if necessary.) */
1367
1368static PyObject *
1369long_to_decimal_string(PyObject *aa, int addL)
1370{
1371 PyLongObject *scratch, *a;
1372 PyObject *str;
1373 Py_ssize_t size, strlen, size_a, i, j;
1374 digit *pout, *pin, rem, tenpow;
1375 char *p;
1376 int negative;
1377
1378 a = (PyLongObject *)aa;
1379 if (a == NULL || !PyLong_Check(a)) {
1380 PyErr_BadInternalCall();
1381 return NULL;
1382 }
1383 size_a = ABS(Py_SIZE(a));
1384 negative = Py_SIZE(a) < 0;
1385
1386 /* quick and dirty upper bound for the number of digits
1387 required to express a in base _PyLong_DECIMAL_BASE:
1388
1389 #digits = 1 + floor(log2(a) / log2(_PyLong_DECIMAL_BASE))
1390
1391 But log2(a) < size_a * PyLong_SHIFT, and
1392 log2(_PyLong_DECIMAL_BASE) = log2(10) * _PyLong_DECIMAL_SHIFT
1393 > 3 * _PyLong_DECIMAL_SHIFT
1394 */
1395 if (size_a > PY_SSIZE_T_MAX / PyLong_SHIFT) {
1396 PyErr_SetString(PyExc_OverflowError,
1397 "long is too large to format");
1398 return NULL;
1399 }
1400 /* the expression size_a * PyLong_SHIFT is now safe from overflow */
1401 size = 1 + size_a * PyLong_SHIFT / (3 * _PyLong_DECIMAL_SHIFT);
1402 scratch = _PyLong_New(size);
1403 if (scratch == NULL)
1404 return NULL;
1405
1406 /* convert array of base _PyLong_BASE digits in pin to an array of
1407 base _PyLong_DECIMAL_BASE digits in pout, following Knuth (TAOCP,
1408 Volume 2 (3rd edn), section 4.4, Method 1b). */
1409 pin = a->ob_digit;
1410 pout = scratch->ob_digit;
1411 size = 0;
1412 for (i = size_a; --i >= 0; ) {
1413 digit hi = pin[i];
1414 for (j = 0; j < size; j++) {
1415 twodigits z = (twodigits)pout[j] << PyLong_SHIFT | hi;
1416 hi = z / _PyLong_DECIMAL_BASE;
1417 pout[j] = z - (twodigits)hi * _PyLong_DECIMAL_BASE;
1418 }
1419 while (hi) {
1420 pout[size++] = hi % _PyLong_DECIMAL_BASE;
1421 hi /= _PyLong_DECIMAL_BASE;
1422 }
1423 /* check for keyboard interrupt */
1424 SIGCHECK({
1425 Py_DECREF(scratch);
1426 return NULL;
1427 })
1428 }
1429 /* pout should have at least one digit, so that the case when a = 0
1430 works correctly */
1431 if (size == 0)
1432 pout[size++] = 0;
1433
1434 /* calculate exact length of output string, and allocate */
1435 strlen = (addL != 0) + negative +
1436 1 + (size - 1) * _PyLong_DECIMAL_SHIFT;
1437 tenpow = 10;
1438 rem = pout[size-1];
1439 while (rem >= tenpow) {
1440 tenpow *= 10;
1441 strlen++;
1442 }
1443 str = PyString_FromStringAndSize(NULL, strlen);
1444 if (str == NULL) {
1445 Py_DECREF(scratch);
1446 return NULL;
1447 }
1448
1449 /* fill the string right-to-left */
1450 p = PyString_AS_STRING(str) + strlen;
1451 *p = '\0';
1452 if (addL)
1453 *--p = 'L';
1454 /* pout[0] through pout[size-2] contribute exactly
1455 _PyLong_DECIMAL_SHIFT digits each */
1456 for (i=0; i < size - 1; i++) {
1457 rem = pout[i];
1458 for (j = 0; j < _PyLong_DECIMAL_SHIFT; j++) {
1459 *--p = '0' + rem % 10;
1460 rem /= 10;
1461 }
1462 }
1463 /* pout[size-1]: always produce at least one decimal digit */
1464 rem = pout[i];
1465 do {
1466 *--p = '0' + rem % 10;
1467 rem /= 10;
1468 } while (rem != 0);
1469
1470 /* and sign */
1471 if (negative)
1472 *--p = '-';
1473
1474 /* check we've counted correctly */
1475 assert(p == PyString_AS_STRING(str));
1476 Py_DECREF(scratch);
1477 return (PyObject *)str;
1478}
1479
Eric Smith5e527eb2008-02-10 01:36:53 +00001480/* Convert the long to a string object with given base,
1481 appending a base prefix of 0[box] if base is 2, 8 or 16.
1482 Add a trailing "L" if addL is non-zero.
1483 If newstyle is zero, then use the pre-2.6 behavior of octal having
1484 a leading "0", instead of the prefix "0o" */
1485PyAPI_FUNC(PyObject *)
1486_PyLong_Format(PyObject *aa, int base, int addL, int newstyle)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001487{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001488 register PyLongObject *a = (PyLongObject *)aa;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001489 PyStringObject *str;
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001490 Py_ssize_t i, sz;
Neal Norwitzc09efa82006-07-23 07:53:14 +00001491 Py_ssize_t size_a;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001492 char *p;
1493 int bits;
1494 char sign = '\0';
Guido van Rossume32e0141992-01-19 16:31:05 +00001495
Mark Dickinsonaa2adc82009-09-16 22:10:56 +00001496 if (base == 10)
1497 return long_to_decimal_string((PyObject *)a, addL);
1498
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001499 if (a == NULL || !PyLong_Check(a)) {
1500 PyErr_BadInternalCall();
Guido van Rossume32e0141992-01-19 16:31:05 +00001501 return NULL;
1502 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001503 assert(base >= 2 && base <= 36);
Christian Heimese93237d2007-12-19 02:37:44 +00001504 size_a = ABS(Py_SIZE(a));
Tim Peters5af4e6c2002-08-12 02:31:19 +00001505
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001506 /* Compute a rough upper bound for the length of the string */
1507 i = base;
1508 bits = 0;
1509 while (i > 1) {
1510 ++bits;
1511 i >>= 1;
1512 }
Armin Rigo7ccbca92006-10-04 12:17:45 +00001513 i = 5 + (addL ? 1 : 0);
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001514 /* ensure we don't get signed overflow in sz calculation */
1515 if (size_a > (PY_SSIZE_T_MAX - i) / PyLong_SHIFT) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00001516 PyErr_SetString(PyExc_OverflowError,
1517 "long is too large to format");
1518 return NULL;
1519 }
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001520 sz = i + 1 + (size_a * PyLong_SHIFT - 1) / bits;
1521 assert(sz >= 0);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001522 str = (PyStringObject *) PyString_FromStringAndSize((char *)0, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001523 if (str == NULL)
1524 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001525 p = PyString_AS_STRING(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001526 *p = '\0';
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001527 if (addL)
1528 *--p = 'L';
Guido van Rossum4c260ff1992-01-14 18:36:43 +00001529 if (a->ob_size < 0)
1530 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001531
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001532 if (a->ob_size == 0) {
1533 *--p = '0';
1534 }
1535 else if ((base & (base - 1)) == 0) {
1536 /* JRH: special case for power-of-2 bases */
Tim Peters586b2e32001-07-15 09:11:14 +00001537 twodigits accum = 0;
1538 int accumbits = 0; /* # of bits in accum */
1539 int basebits = 1; /* # of bits in base-1 */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001540 i = base;
Tim Peters7d3a5112000-07-08 04:17:21 +00001541 while ((i >>= 1) > 1)
1542 ++basebits;
Tim Peters586b2e32001-07-15 09:11:14 +00001543
1544 for (i = 0; i < size_a; ++i) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00001545 accum |= (twodigits)a->ob_digit[i] << accumbits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001546 accumbits += PyLong_SHIFT;
Tim Peters586b2e32001-07-15 09:11:14 +00001547 assert(accumbits >= basebits);
1548 do {
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001549 char cdigit = (char)(accum & (base - 1));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001550 cdigit += (cdigit < 10) ? '0' : 'a'-10;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001551 assert(p > PyString_AS_STRING(str));
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001552 *--p = cdigit;
Tim Peters586b2e32001-07-15 09:11:14 +00001553 accumbits -= basebits;
1554 accum >>= basebits;
1555 } while (i < size_a-1 ? accumbits >= basebits :
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001556 accum > 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001557 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001558 }
1559 else {
Tim Petersfad225f2001-07-13 02:59:26 +00001560 /* Not 0, and base not a power of 2. Divide repeatedly by
1561 base, but for speed use the highest power of base that
1562 fits in a digit. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001563 Py_ssize_t size = size_a;
Tim Peters212e6142001-07-14 12:23:19 +00001564 digit *pin = a->ob_digit;
1565 PyLongObject *scratch;
1566 /* powbasw <- largest power of base that fits in a digit. */
Tim Petersfad225f2001-07-13 02:59:26 +00001567 digit powbase = base; /* powbase == base ** power */
1568 int power = 1;
1569 for (;;) {
Mark Dickinsonb6464872009-02-25 20:29:50 +00001570 twodigits newpow = powbase * (twodigits)base;
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001571 if (newpow >> PyLong_SHIFT)
1572 /* doesn't fit in a digit */
Tim Petersfad225f2001-07-13 02:59:26 +00001573 break;
1574 powbase = (digit)newpow;
1575 ++power;
1576 }
Tim Peters212e6142001-07-14 12:23:19 +00001577
1578 /* Get a scratch area for repeated division. */
1579 scratch = _PyLong_New(size);
1580 if (scratch == NULL) {
1581 Py_DECREF(str);
1582 return NULL;
1583 }
1584
1585 /* Repeatedly divide by powbase. */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001586 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001587 int ntostore = power;
Tim Peters212e6142001-07-14 12:23:19 +00001588 digit rem = inplace_divrem1(scratch->ob_digit,
1589 pin, size, powbase);
1590 pin = scratch->ob_digit; /* no need to use a again */
1591 if (pin[size - 1] == 0)
1592 --size;
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001593 SIGCHECK({
Tim Peters212e6142001-07-14 12:23:19 +00001594 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001595 Py_DECREF(str);
1596 return NULL;
1597 })
Tim Peters212e6142001-07-14 12:23:19 +00001598
1599 /* Break rem into digits. */
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001600 assert(ntostore > 0);
1601 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001602 digit nextrem = (digit)(rem / base);
1603 char c = (char)(rem - nextrem * base);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001604 assert(p > PyString_AS_STRING(str));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001605 c += (c < 10) ? '0' : 'a'-10;
Tim Petersfad225f2001-07-13 02:59:26 +00001606 *--p = c;
1607 rem = nextrem;
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001608 --ntostore;
1609 /* Termination is a bit delicate: must not
1610 store leading zeroes, so must get out if
Tim Peters212e6142001-07-14 12:23:19 +00001611 remaining quotient and rem are both 0. */
1612 } while (ntostore && (size || rem));
1613 } while (size != 0);
1614 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001615 }
1616
Eric Smith5e527eb2008-02-10 01:36:53 +00001617 if (base == 2) {
1618 *--p = 'b';
1619 *--p = '0';
1620 }
1621 else if (base == 8) {
Mark Dickinson1f4fc092009-09-13 11:56:13 +00001622 if (newstyle) {
Eric Smith5e527eb2008-02-10 01:36:53 +00001623 *--p = 'o';
Guido van Rossum2c475421992-08-14 15:13:07 +00001624 *--p = '0';
Eric Smith5e527eb2008-02-10 01:36:53 +00001625 }
1626 else
1627 if (size_a != 0)
1628 *--p = '0';
Guido van Rossum2c475421992-08-14 15:13:07 +00001629 }
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001630 else if (base == 16) {
1631 *--p = 'x';
1632 *--p = '0';
1633 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00001634 else if (base != 10) {
1635 *--p = '#';
1636 *--p = '0' + base%10;
1637 if (base > 10)
1638 *--p = '0' + base/10;
1639 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001640 if (sign)
1641 *--p = sign;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001642 if (p != PyString_AS_STRING(str)) {
1643 char *q = PyString_AS_STRING(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001644 assert(p > q);
1645 do {
1646 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001647 q--;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001648 _PyString_Resize((PyObject **)&str,
1649 (Py_ssize_t) (q - PyString_AS_STRING(str)));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001650 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001652}
1653
Tim Petersda53afa2006-05-25 17:34:03 +00001654/* Table of digit values for 8-bit string -> integer conversion.
1655 * '0' maps to 0, ..., '9' maps to 9.
1656 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1657 * All other indices map to 37.
1658 * Note that when converting a base B string, a char c is a legitimate
1659 * base B digit iff _PyLong_DigitValue[Py_CHARMASK(c)] < B.
1660 */
1661int _PyLong_DigitValue[256] = {
Tim Peters696cf432006-05-24 21:10:40 +00001662 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1663 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1664 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1665 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1666 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1667 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1668 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1669 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1670 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1671 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1672 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1673 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1674 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1675 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1676 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1677 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
Tim Peters696cf432006-05-24 21:10:40 +00001678};
1679
1680/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001681 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1682 * non-digit (which may be *str!). A normalized long is returned.
1683 * The point to this routine is that it takes time linear in the number of
1684 * string characters.
1685 */
1686static PyLongObject *
1687long_from_binary_base(char **str, int base)
1688{
1689 char *p = *str;
1690 char *start = p;
1691 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001692 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001693 PyLongObject *z;
1694 twodigits accum;
1695 int bits_in_accum;
1696 digit *pdigit;
1697
1698 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1699 n = base;
1700 for (bits_per_char = -1; n; ++bits_per_char)
1701 n >>= 1;
1702 /* n <- total # of bits needed, while setting p to end-of-string */
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001703 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001704 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001705 *str = p;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001706 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1707 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001708 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001709 PyErr_SetString(PyExc_ValueError,
1710 "long string too large to convert");
1711 return NULL;
1712 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001713 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001714 z = _PyLong_New(n);
1715 if (z == NULL)
1716 return NULL;
1717 /* Read string from right, and fill in long from left; i.e.,
1718 * from least to most significant in both.
1719 */
1720 accum = 0;
1721 bits_in_accum = 0;
1722 pdigit = z->ob_digit;
1723 while (--p >= start) {
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001724 int k = _PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001725 assert(k >= 0 && k < base);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001726 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001727 bits_in_accum += bits_per_char;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001728 if (bits_in_accum >= PyLong_SHIFT) {
1729 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001730 assert(pdigit - z->ob_digit <= n);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001731 accum >>= PyLong_SHIFT;
1732 bits_in_accum -= PyLong_SHIFT;
1733 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001734 }
1735 }
1736 if (bits_in_accum) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001737 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001738 *pdigit++ = (digit)accum;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001739 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001740 }
1741 while (pdigit - z->ob_digit < n)
1742 *pdigit++ = 0;
1743 return long_normalize(z);
1744}
1745
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001746PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001747PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001748{
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001749 int sign = 1;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001750 char *start, *orig_str = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001751 PyLongObject *z;
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001752 PyObject *strobj, *strrepr;
1753 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001754
Guido van Rossum472c04f1996-12-05 21:57:21 +00001755 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001756 PyErr_SetString(PyExc_ValueError,
Fred Drake661ea262000-10-24 19:57:45 +00001757 "long() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001758 return NULL;
1759 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001760 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001761 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001762 if (*str == '+')
1763 ++str;
1764 else if (*str == '-') {
1765 ++str;
1766 sign = -1;
1767 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001768 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001769 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001770 if (base == 0) {
Eric Smith9ff19b52008-03-17 17:32:20 +00001771 /* No base given. Deduce the base from the contents
1772 of the string */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001773 if (str[0] != '0')
1774 base = 10;
1775 else if (str[1] == 'x' || str[1] == 'X')
1776 base = 16;
Eric Smith9ff19b52008-03-17 17:32:20 +00001777 else if (str[1] == 'o' || str[1] == 'O')
1778 base = 8;
1779 else if (str[1] == 'b' || str[1] == 'B')
1780 base = 2;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001781 else
Eric Smith9ff19b52008-03-17 17:32:20 +00001782 /* "old" (C-style) octal literal, still valid in
1783 2.x, although illegal in 3.x */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001784 base = 8;
1785 }
Eric Smith9ff19b52008-03-17 17:32:20 +00001786 /* Whether or not we were deducing the base, skip leading chars
1787 as needed */
1788 if (str[0] == '0' &&
1789 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1790 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1791 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001792 str += 2;
Tim Peters696cf432006-05-24 21:10:40 +00001793
Guido van Rossume6762971998-06-22 03:54:46 +00001794 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00001795 if ((base & (base - 1)) == 0)
1796 z = long_from_binary_base(&str, base);
1797 else {
Tim Peters696cf432006-05-24 21:10:40 +00001798/***
1799Binary bases can be converted in time linear in the number of digits, because
1800Python's representation base is binary. Other bases (including decimal!) use
1801the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001802
Tim Peters696cf432006-05-24 21:10:40 +00001803First some math: the largest integer that can be expressed in N base-B digits
1804is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1805case number of Python digits needed to hold it is the smallest integer n s.t.
1806
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001807 PyLong_BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1808 PyLong_BASE**n >= B**N [taking logs to base PyLong_BASE]
1809 n >= log(B**N)/log(PyLong_BASE) = N * log(B)/log(PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001810
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001811The static array log_base_PyLong_BASE[base] == log(base)/log(PyLong_BASE) so we can compute
Tim Peters696cf432006-05-24 21:10:40 +00001812this quickly. A Python long with that much space is reserved near the start,
1813and the result is computed into it.
1814
1815The input string is actually treated as being in base base**i (i.e., i digits
1816are processed at a time), where two more static arrays hold:
1817
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001818 convwidth_base[base] = the largest integer i such that base**i <= PyLong_BASE
Tim Peters696cf432006-05-24 21:10:40 +00001819 convmultmax_base[base] = base ** convwidth_base[base]
1820
1821The first of these is the largest i such that i consecutive input digits
1822must fit in a single Python digit. The second is effectively the input
1823base we're really using.
1824
1825Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1826convmultmax_base[base], the result is "simply"
1827
1828 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1829
1830where B = convmultmax_base[base].
Tim Peters9faa3ed2006-05-30 15:53:34 +00001831
1832Error analysis: as above, the number of Python digits `n` needed is worst-
1833case
1834
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001835 n >= N * log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001836
1837where `N` is the number of input digits in base `B`. This is computed via
1838
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001839 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001840
1841below. Two numeric concerns are how much space this can waste, and whether
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001842the computed result can be too small. To be concrete, assume PyLong_BASE = 2**15,
Tim Peters9faa3ed2006-05-30 15:53:34 +00001843which is the default (and it's unlikely anyone changes that).
1844
1845Waste isn't a problem: provided the first input digit isn't 0, the difference
1846between the worst-case input with N digits and the smallest input with N
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001847digits is about a factor of B, but B is small compared to PyLong_BASE so at most
Tim Peters9faa3ed2006-05-30 15:53:34 +00001848one allocated Python digit can remain unused on that count. If
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001849N*log(B)/log(PyLong_BASE) is mathematically an exact integer, then truncating that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001850and adding 1 returns a result 1 larger than necessary. However, that can't
1851happen: whenever B is a power of 2, long_from_binary_base() is called
1852instead, and it's impossible for B**i to be an integer power of 2**15 when
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001853B is not a power of 2 (i.e., it's impossible for N*log(B)/log(PyLong_BASE) to be
Tim Peters9faa3ed2006-05-30 15:53:34 +00001854an exact integer when B is not a power of 2, since B**i has a prime factor
1855other than 2 in that case, but (2**15)**j's only prime factor is 2).
1856
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001857The computed result can be too small if the true value of N*log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001858is a little bit larger than an exact integer, but due to roundoff errors (in
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001859computing log(B), log(PyLong_BASE), their quotient, and/or multiplying that by N)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001860yields a numeric result a little less than that integer. Unfortunately, "how
1861close can a transcendental function get to an integer over some range?"
1862questions are generally theoretically intractable. Computer analysis via
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001863continued fractions is practical: expand log(B)/log(PyLong_BASE) via continued
Tim Peters9faa3ed2006-05-30 15:53:34 +00001864fractions, giving a sequence i/j of "the best" rational approximations. Then
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001865j*log(B)/log(PyLong_BASE) is approximately equal to (the integer) i. This shows that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001866we can get very close to being in trouble, but very rarely. For example,
186776573 is a denominator in one of the continued-fraction approximations to
1868log(10)/log(2**15), and indeed:
1869
1870 >>> log(10)/log(2**15)*76573
1871 16958.000000654003
1872
1873is very close to an integer. If we were working with IEEE single-precision,
1874rounding errors could kill us. Finding worst cases in IEEE double-precision
1875requires better-than-double-precision log() functions, and Tim didn't bother.
1876Instead the code checks to see whether the allocated space is enough as each
1877new Python digit is added, and copies the whole thing to a larger long if not.
1878This should happen extremely rarely, and in fact I don't have a test case
1879that triggers it(!). Instead the code was tested by artificially allocating
1880just 1 digit at the start, so that the copying code was exercised for every
1881digit beyond the first.
Tim Peters696cf432006-05-24 21:10:40 +00001882***/
1883 register twodigits c; /* current input character */
1884 Py_ssize_t size_z;
1885 int i;
1886 int convwidth;
1887 twodigits convmultmax, convmult;
1888 digit *pz, *pzstop;
1889 char* scan;
1890
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001891 static double log_base_PyLong_BASE[37] = {0.0e0,};
Tim Peters696cf432006-05-24 21:10:40 +00001892 static int convwidth_base[37] = {0,};
1893 static twodigits convmultmax_base[37] = {0,};
1894
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001895 if (log_base_PyLong_BASE[base] == 0.0) {
Tim Peters696cf432006-05-24 21:10:40 +00001896 twodigits convmax = base;
1897 int i = 1;
1898
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001899 log_base_PyLong_BASE[base] = log((double)base) /
1900 log((double)PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001901 for (;;) {
1902 twodigits next = convmax * base;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001903 if (next > PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001904 break;
1905 convmax = next;
1906 ++i;
1907 }
1908 convmultmax_base[base] = convmax;
1909 assert(i > 0);
1910 convwidth_base[base] = i;
1911 }
1912
1913 /* Find length of the string of numeric characters. */
1914 scan = str;
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001915 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Tim Peters696cf432006-05-24 21:10:40 +00001916 ++scan;
1917
1918 /* Create a long object that can contain the largest possible
1919 * integer with this base and length. Note that there's no
1920 * need to initialize z->ob_digit -- no slot is read up before
1921 * being stored into.
1922 */
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001923 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001924 /* Uncomment next line to test exceedingly rare copy code */
1925 /* size_z = 1; */
Tim Peters696cf432006-05-24 21:10:40 +00001926 assert(size_z > 0);
1927 z = _PyLong_New(size_z);
1928 if (z == NULL)
1929 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00001930 Py_SIZE(z) = 0;
Tim Peters696cf432006-05-24 21:10:40 +00001931
1932 /* `convwidth` consecutive input digits are treated as a single
1933 * digit in base `convmultmax`.
1934 */
1935 convwidth = convwidth_base[base];
1936 convmultmax = convmultmax_base[base];
1937
1938 /* Work ;-) */
1939 while (str < scan) {
1940 /* grab up to convwidth digits from the input string */
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001941 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Tim Peters696cf432006-05-24 21:10:40 +00001942 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
1943 c = (twodigits)(c * base +
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001944 _PyLong_DigitValue[Py_CHARMASK(*str)]);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001945 assert(c < PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001946 }
1947
1948 convmult = convmultmax;
1949 /* Calculate the shift only if we couldn't get
1950 * convwidth digits.
1951 */
1952 if (i != convwidth) {
1953 convmult = base;
1954 for ( ; i > 1; --i)
1955 convmult *= base;
1956 }
1957
1958 /* Multiply z by convmult, and add c. */
1959 pz = z->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +00001960 pzstop = pz + Py_SIZE(z);
Tim Peters696cf432006-05-24 21:10:40 +00001961 for (; pz < pzstop; ++pz) {
1962 c += (twodigits)*pz * convmult;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001963 *pz = (digit)(c & PyLong_MASK);
1964 c >>= PyLong_SHIFT;
Tim Peters696cf432006-05-24 21:10:40 +00001965 }
1966 /* carry off the current end? */
1967 if (c) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001968 assert(c < PyLong_BASE);
Christian Heimese93237d2007-12-19 02:37:44 +00001969 if (Py_SIZE(z) < size_z) {
Tim Peters9faa3ed2006-05-30 15:53:34 +00001970 *pz = (digit)c;
Christian Heimese93237d2007-12-19 02:37:44 +00001971 ++Py_SIZE(z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001972 }
1973 else {
1974 PyLongObject *tmp;
1975 /* Extremely rare. Get more space. */
Christian Heimese93237d2007-12-19 02:37:44 +00001976 assert(Py_SIZE(z) == size_z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001977 tmp = _PyLong_New(size_z + 1);
1978 if (tmp == NULL) {
1979 Py_DECREF(z);
1980 return NULL;
1981 }
1982 memcpy(tmp->ob_digit,
1983 z->ob_digit,
1984 sizeof(digit) * size_z);
1985 Py_DECREF(z);
1986 z = tmp;
1987 z->ob_digit[size_z] = (digit)c;
1988 ++size_z;
1989 }
Tim Peters696cf432006-05-24 21:10:40 +00001990 }
Tim Petersbf2674b2003-02-02 07:51:32 +00001991 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001992 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00001993 if (z == NULL)
1994 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001995 if (str == start)
1996 goto onError;
Tim Peters696cf432006-05-24 21:10:40 +00001997 if (sign < 0)
Christian Heimese93237d2007-12-19 02:37:44 +00001998 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001999 if (*str == 'L' || *str == 'l')
2000 str++;
2001 while (*str && isspace(Py_CHARMASK(*str)))
2002 str++;
2003 if (*str != '\0')
2004 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002005 if (pend)
2006 *pend = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002007 return (PyObject *) z;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002008
2009 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00002010 Py_XDECREF(z);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00002011 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002012 strobj = PyString_FromStringAndSize(orig_str, slen);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00002013 if (strobj == NULL)
2014 return NULL;
2015 strrepr = PyObject_Repr(strobj);
2016 Py_DECREF(strobj);
2017 if (strrepr == NULL)
2018 return NULL;
2019 PyErr_Format(PyExc_ValueError,
2020 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002021 base, PyString_AS_STRING(strrepr));
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00002022 Py_DECREF(strrepr);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002023 return NULL;
2024}
2025
Martin v. Löwis339d0f72001-08-17 18:39:25 +00002026#ifdef Py_USING_UNICODE
Guido van Rossum9e896b32000-04-05 20:11:21 +00002027PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002028PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002029{
Walter Dörwald07e14762002-11-06 16:15:14 +00002030 PyObject *result;
Anthony Baxter377be112006-04-11 06:54:30 +00002031 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002032
Walter Dörwald07e14762002-11-06 16:15:14 +00002033 if (buffer == NULL)
2034 return NULL;
2035
2036 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
2037 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002038 return NULL;
2039 }
Walter Dörwald07e14762002-11-06 16:15:14 +00002040 result = PyLong_FromString(buffer, NULL, base);
2041 PyMem_FREE(buffer);
2042 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002043}
Martin v. Löwis339d0f72001-08-17 18:39:25 +00002044#endif
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002045
Tim Peters9f688bf2000-07-07 15:53:28 +00002046/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002047static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00002048 (PyLongObject *, PyLongObject *, PyLongObject **);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00002049static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002050
2051/* Long division with remainder, top-level routine */
2052
Guido van Rossume32e0141992-01-19 16:31:05 +00002053static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002054long_divrem(PyLongObject *a, PyLongObject *b,
2055 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002056{
Christian Heimese93237d2007-12-19 02:37:44 +00002057 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002058 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002059
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002060 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00002061 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +00002062 "long division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00002063 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002064 }
2065 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00002066 (size_a == size_b &&
2067 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002068 /* |a| < |b|. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002069 *pdiv = _PyLong_New(0);
Georg Brandlc02e1312007-04-11 17:16:24 +00002070 if (*pdiv == NULL)
2071 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002072 Py_INCREF(a);
2073 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00002074 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002075 }
2076 if (size_b == 1) {
2077 digit rem = 0;
2078 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002079 if (z == NULL)
2080 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002081 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Georg Brandlc02e1312007-04-11 17:16:24 +00002082 if (*prem == NULL) {
2083 Py_DECREF(z);
2084 return -1;
2085 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002086 }
Guido van Rossume32e0141992-01-19 16:31:05 +00002087 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002088 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002089 if (z == NULL)
2090 return -1;
2091 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002092 /* Set the signs.
2093 The quotient z has the sign of a*b;
2094 the remainder r has the sign of a,
2095 so a = b*z + r. */
Guido van Rossume32e0141992-01-19 16:31:05 +00002096 if ((a->ob_size < 0) != (b->ob_size < 0))
2097 z->ob_size = -(z->ob_size);
2098 if (a->ob_size < 0 && (*prem)->ob_size != 0)
2099 (*prem)->ob_size = -((*prem)->ob_size);
2100 *pdiv = z;
2101 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002102}
2103
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002104/* Unsigned long division with remainder -- the algorithm. The arguments v1
2105 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002106
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002107static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002108x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002109{
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002110 PyLongObject *v, *w, *a;
2111 Py_ssize_t i, k, size_v, size_w;
2112 int d;
2113 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2114 twodigits vv;
2115 sdigit zhi;
2116 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002117
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002118 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2119 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2120 handle the special case when the initial estimate q for a quotient
2121 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2122 that won't overflow a digit. */
2123
2124 /* allocate space; w will also be used to hold the final remainder */
2125 size_v = ABS(Py_SIZE(v1));
2126 size_w = ABS(Py_SIZE(w1));
2127 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2128 v = _PyLong_New(size_v+1);
2129 if (v == NULL) {
2130 *prem = NULL;
2131 return NULL;
2132 }
2133 w = _PyLong_New(size_w);
2134 if (w == NULL) {
2135 Py_DECREF(v);
2136 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002137 return NULL;
2138 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002139
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002140 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2141 shift v1 left by the same amount. Results go into w and v. */
2142 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2143 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2144 assert(carry == 0);
2145 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2146 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2147 v->ob_digit[size_v] = carry;
2148 size_v++;
2149 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002150
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002151 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2152 at most (and usually exactly) k = size_v - size_w digits. */
Neal Norwitzc6a989a2006-05-10 06:57:58 +00002153 k = size_v - size_w;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002154 assert(k >= 0);
2155 a = _PyLong_New(k);
2156 if (a == NULL) {
2157 Py_DECREF(w);
2158 Py_DECREF(v);
2159 *prem = NULL;
2160 return NULL;
2161 }
2162 v0 = v->ob_digit;
2163 w0 = w->ob_digit;
2164 wm1 = w0[size_w-1];
2165 wm2 = w0[size_w-2];
2166 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2167 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2168 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002169
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002170 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002171 Py_DECREF(a);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002172 Py_DECREF(w);
2173 Py_DECREF(v);
2174 *prem = NULL;
2175 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002176 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002177
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002178 /* estimate quotient digit q; may overestimate by 1 (rare) */
2179 vtop = vk[size_w];
2180 assert(vtop <= wm1);
2181 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2182 q = (digit)(vv / wm1);
2183 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2184 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2185 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002186 --q;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002187 r += wm1;
2188 if (r >= PyLong_BASE)
2189 break;
2190 }
2191 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002192
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002193 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2194 zhi = 0;
2195 for (i = 0; i < size_w; ++i) {
2196 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2197 -PyLong_BASE * q <= z < PyLong_BASE */
2198 z = (sdigit)vk[i] + zhi -
2199 (stwodigits)q * (stwodigits)w0[i];
2200 vk[i] = (digit)z & PyLong_MASK;
2201 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2202 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002203 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002204
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002205 /* add w back if q was too large (this branch taken rarely) */
2206 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2207 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002208 carry = 0;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002209 for (i = 0; i < size_w; ++i) {
2210 carry += vk[i] + w0[i];
2211 vk[i] = carry & PyLong_MASK;
2212 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002213 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002214 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002215 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002216
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002217 /* store quotient digit */
2218 assert(q < PyLong_BASE);
2219 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002220 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002221
2222 /* unshift remainder; we reuse w to store the result */
2223 carry = v_rshift(w0, v0, size_w, d);
2224 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002225 Py_DECREF(v);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002226
2227 *prem = long_normalize(w);
2228 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002229}
2230
2231/* Methods */
2232
2233static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002234long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002235{
Christian Heimese93237d2007-12-19 02:37:44 +00002236 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002237}
2238
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002239static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002240long_repr(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002241{
Eric Smith5e527eb2008-02-10 01:36:53 +00002242 return _PyLong_Format(v, 10, 1, 0);
Fred Drake121ee271999-12-23 15:41:28 +00002243}
2244
2245static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002246long_str(PyObject *v)
Fred Drake121ee271999-12-23 15:41:28 +00002247{
Eric Smith5e527eb2008-02-10 01:36:53 +00002248 return _PyLong_Format(v, 10, 0, 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002249}
2250
2251static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002252long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002253{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002254 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002255
Christian Heimese93237d2007-12-19 02:37:44 +00002256 if (Py_SIZE(a) != Py_SIZE(b)) {
2257 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002258 sign = 0;
2259 else
Christian Heimese93237d2007-12-19 02:37:44 +00002260 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002261 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002262 else {
Christian Heimese93237d2007-12-19 02:37:44 +00002263 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002264 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2265 ;
2266 if (i < 0)
2267 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002268 else {
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00002269 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimese93237d2007-12-19 02:37:44 +00002270 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002271 sign = -sign;
2272 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002273 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002274 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002275}
2276
Guido van Rossum9bfef441993-03-29 10:43:31 +00002277static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002278long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002279{
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002280 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002281 Py_ssize_t i;
2282 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002283
2284 /* This is designed so that Python ints and longs with the
2285 same value hash to the same value, otherwise comparisons
2286 of mapping keys will turn out weird */
2287 i = v->ob_size;
2288 sign = 1;
2289 x = 0;
2290 if (i < 0) {
2291 sign = -1;
2292 i = -(i);
2293 }
Mark Dickinsona0eae032009-01-26 21:40:08 +00002294 /* The following loop produces a C unsigned long x such that x is
2295 congruent to the absolute value of v modulo ULONG_MAX. The
2296 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002297 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002298 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002299 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002300 x += v->ob_digit[i];
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002301 /* If the addition above overflowed we compensate by
2302 incrementing. This preserves the value modulo
2303 ULONG_MAX. */
2304 if (x < v->ob_digit[i])
Facundo Batistad544df72007-09-19 15:10:06 +00002305 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002306 }
2307 x = x * sign;
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002308 if (x == (unsigned long)-1)
2309 x = (unsigned long)-2;
2310 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002311}
2312
2313
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002314/* Add the absolute values of two long integers. */
2315
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002316static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002317x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002318{
Christian Heimese93237d2007-12-19 02:37:44 +00002319 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002320 PyLongObject *z;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00002321 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002322 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002323
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002324 /* Ensure a is the larger of the two: */
2325 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002326 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002327 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002328 size_a = size_b;
2329 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002330 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002331 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002332 if (z == NULL)
2333 return NULL;
2334 for (i = 0; i < size_b; ++i) {
2335 carry += a->ob_digit[i] + b->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002336 z->ob_digit[i] = carry & PyLong_MASK;
2337 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002338 }
2339 for (; i < size_a; ++i) {
2340 carry += a->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002341 z->ob_digit[i] = carry & PyLong_MASK;
2342 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002343 }
2344 z->ob_digit[i] = carry;
2345 return long_normalize(z);
2346}
2347
2348/* Subtract the absolute values of two integers. */
2349
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002350static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002351x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002352{
Christian Heimese93237d2007-12-19 02:37:44 +00002353 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002354 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002355 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002356 int sign = 1;
2357 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002358
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002359 /* Ensure a is the larger of the two: */
2360 if (size_a < size_b) {
2361 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002362 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002363 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002364 size_a = size_b;
2365 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002366 }
2367 else if (size_a == size_b) {
2368 /* Find highest digit where a and b differ: */
2369 i = size_a;
2370 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2371 ;
2372 if (i < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002373 return _PyLong_New(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002374 if (a->ob_digit[i] < b->ob_digit[i]) {
2375 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002376 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002377 }
2378 size_a = size_b = i+1;
2379 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002380 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002381 if (z == NULL)
2382 return NULL;
2383 for (i = 0; i < size_b; ++i) {
2384 /* The following assumes unsigned arithmetic
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002385 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002386 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002387 z->ob_digit[i] = borrow & PyLong_MASK;
2388 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002389 borrow &= 1; /* Keep only one sign bit */
2390 }
2391 for (; i < size_a; ++i) {
2392 borrow = a->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002393 z->ob_digit[i] = borrow & PyLong_MASK;
2394 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002395 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002396 }
2397 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002398 if (sign < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002399 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002400 return long_normalize(z);
2401}
2402
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002403static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002404long_add(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002405{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002406 PyLongObject *a, *b, *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002407
Neil Schemenauerba872e22001-01-04 01:46:03 +00002408 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2409
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002410 if (a->ob_size < 0) {
2411 if (b->ob_size < 0) {
2412 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002413 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002414 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002415 }
2416 else
2417 z = x_sub(b, a);
2418 }
2419 else {
2420 if (b->ob_size < 0)
2421 z = x_sub(a, b);
2422 else
2423 z = x_add(a, b);
2424 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002425 Py_DECREF(a);
2426 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002427 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002428}
2429
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002430static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002431long_sub(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002432{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002433 PyLongObject *a, *b, *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002434
Neil Schemenauerba872e22001-01-04 01:46:03 +00002435 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2436
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002437 if (a->ob_size < 0) {
2438 if (b->ob_size < 0)
2439 z = x_sub(a, b);
2440 else
2441 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002442 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002443 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002444 }
2445 else {
2446 if (b->ob_size < 0)
2447 z = x_add(a, b);
2448 else
2449 z = x_sub(a, b);
2450 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002451 Py_DECREF(a);
2452 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002453 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002454}
2455
Tim Peters5af4e6c2002-08-12 02:31:19 +00002456/* Grade school multiplication, ignoring the signs.
2457 * Returns the absolute value of the product, or NULL if error.
2458 */
2459static PyLongObject *
2460x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002461{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002462 PyLongObject *z;
Christian Heimese93237d2007-12-19 02:37:44 +00002463 Py_ssize_t size_a = ABS(Py_SIZE(a));
2464 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002465 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002466
Tim Peters5af4e6c2002-08-12 02:31:19 +00002467 z = _PyLong_New(size_a + size_b);
2468 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002469 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002470
Christian Heimese93237d2007-12-19 02:37:44 +00002471 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002472 if (a == b) {
2473 /* Efficient squaring per HAC, Algorithm 14.16:
2474 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2475 * Gives slightly less than a 2x speedup when a == b,
2476 * via exploiting that each entry in the multiplication
2477 * pyramid appears twice (except for the size_a squares).
2478 */
2479 for (i = 0; i < size_a; ++i) {
2480 twodigits carry;
2481 twodigits f = a->ob_digit[i];
2482 digit *pz = z->ob_digit + (i << 1);
2483 digit *pa = a->ob_digit + i + 1;
2484 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002485
Tim Peters0973b992004-08-29 22:16:50 +00002486 SIGCHECK({
2487 Py_DECREF(z);
2488 return NULL;
2489 })
2490
2491 carry = *pz + f * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002492 *pz++ = (digit)(carry & PyLong_MASK);
2493 carry >>= PyLong_SHIFT;
2494 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002495
2496 /* Now f is added in twice in each column of the
2497 * pyramid it appears. Same as adding f<<1 once.
2498 */
2499 f <<= 1;
2500 while (pa < paend) {
2501 carry += *pz + *pa++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002502 *pz++ = (digit)(carry & PyLong_MASK);
2503 carry >>= PyLong_SHIFT;
2504 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002505 }
2506 if (carry) {
2507 carry += *pz;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002508 *pz++ = (digit)(carry & PyLong_MASK);
2509 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002510 }
2511 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002512 *pz += (digit)(carry & PyLong_MASK);
2513 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002514 }
Tim Peters0973b992004-08-29 22:16:50 +00002515 }
2516 else { /* a is not the same as b -- gradeschool long mult */
2517 for (i = 0; i < size_a; ++i) {
2518 twodigits carry = 0;
2519 twodigits f = a->ob_digit[i];
2520 digit *pz = z->ob_digit + i;
2521 digit *pb = b->ob_digit;
2522 digit *pbend = b->ob_digit + size_b;
2523
2524 SIGCHECK({
2525 Py_DECREF(z);
2526 return NULL;
2527 })
2528
2529 while (pb < pbend) {
2530 carry += *pz + *pb++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002531 *pz++ = (digit)(carry & PyLong_MASK);
2532 carry >>= PyLong_SHIFT;
2533 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002534 }
2535 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002536 *pz += (digit)(carry & PyLong_MASK);
2537 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002538 }
2539 }
Tim Peters44121a62002-08-12 06:17:58 +00002540 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002541}
2542
2543/* A helper for Karatsuba multiplication (k_mul).
2544 Takes a long "n" and an integer "size" representing the place to
2545 split, and sets low and high such that abs(n) == (high << size) + low,
2546 viewing the shift as being by digits. The sign bit is ignored, and
2547 the return values are >= 0.
2548 Returns 0 on success, -1 on failure.
2549*/
2550static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002551kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002552{
2553 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002554 Py_ssize_t size_lo, size_hi;
Christian Heimese93237d2007-12-19 02:37:44 +00002555 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002556
2557 size_lo = MIN(size_n, size);
2558 size_hi = size_n - size_lo;
2559
2560 if ((hi = _PyLong_New(size_hi)) == NULL)
2561 return -1;
2562 if ((lo = _PyLong_New(size_lo)) == NULL) {
2563 Py_DECREF(hi);
2564 return -1;
2565 }
2566
2567 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2568 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2569
2570 *high = long_normalize(hi);
2571 *low = long_normalize(lo);
2572 return 0;
2573}
2574
Tim Peters60004642002-08-12 22:01:34 +00002575static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2576
Tim Peters5af4e6c2002-08-12 02:31:19 +00002577/* Karatsuba multiplication. Ignores the input signs, and returns the
2578 * absolute value of the product (or NULL if error).
2579 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2580 */
2581static PyLongObject *
2582k_mul(PyLongObject *a, PyLongObject *b)
2583{
Christian Heimese93237d2007-12-19 02:37:44 +00002584 Py_ssize_t asize = ABS(Py_SIZE(a));
2585 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002586 PyLongObject *ah = NULL;
2587 PyLongObject *al = NULL;
2588 PyLongObject *bh = NULL;
2589 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002590 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002591 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002592 Py_ssize_t shift; /* the number of digits we split off */
2593 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002594
Tim Peters5af4e6c2002-08-12 02:31:19 +00002595 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2596 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2597 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002598 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002599 * By picking X to be a power of 2, "*X" is just shifting, and it's
2600 * been reduced to 3 multiplies on numbers half the size.
2601 */
2602
Tim Petersfc07e562002-08-12 02:54:10 +00002603 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002604 * is largest.
2605 */
Tim Peters738eda72002-08-12 15:08:20 +00002606 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002607 t1 = a;
2608 a = b;
2609 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002610
2611 i = asize;
2612 asize = bsize;
2613 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002614 }
2615
2616 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002617 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2618 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002619 if (asize == 0)
Tim Peters44121a62002-08-12 06:17:58 +00002620 return _PyLong_New(0);
2621 else
2622 return x_mul(a, b);
2623 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002624
Tim Peters60004642002-08-12 22:01:34 +00002625 /* If a is small compared to b, splitting on b gives a degenerate
2626 * case with ah==0, and Karatsuba may be (even much) less efficient
2627 * than "grade school" then. However, we can still win, by viewing
2628 * b as a string of "big digits", each of width a->ob_size. That
2629 * leads to a sequence of balanced calls to k_mul.
2630 */
2631 if (2 * asize <= bsize)
2632 return k_lopsided_mul(a, b);
2633
Tim Petersd6974a52002-08-13 20:37:51 +00002634 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002635 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002636 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002637 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002638
Tim Peters0973b992004-08-29 22:16:50 +00002639 if (a == b) {
2640 bh = ah;
2641 bl = al;
2642 Py_INCREF(bh);
2643 Py_INCREF(bl);
2644 }
2645 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002646
Tim Petersd64c1de2002-08-12 17:36:03 +00002647 /* The plan:
2648 * 1. Allocate result space (asize + bsize digits: that's always
2649 * enough).
2650 * 2. Compute ah*bh, and copy into result at 2*shift.
2651 * 3. Compute al*bl, and copy into result at 0. Note that this
2652 * can't overlap with #2.
2653 * 4. Subtract al*bl from the result, starting at shift. This may
2654 * underflow (borrow out of the high digit), but we don't care:
2655 * we're effectively doing unsigned arithmetic mod
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002656 * PyLong_BASE**(sizea + sizeb), and so long as the *final* result fits,
Tim Petersd64c1de2002-08-12 17:36:03 +00002657 * borrows and carries out of the high digit can be ignored.
2658 * 5. Subtract ah*bh from the result, starting at shift.
2659 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2660 * at shift.
2661 */
2662
2663 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002664 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002665 if (ret == NULL) goto fail;
2666#ifdef Py_DEBUG
2667 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002668 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002669#endif
Tim Peters44121a62002-08-12 06:17:58 +00002670
Tim Petersd64c1de2002-08-12 17:36:03 +00002671 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002672 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002673 assert(Py_SIZE(t1) >= 0);
2674 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002675 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimese93237d2007-12-19 02:37:44 +00002676 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002677
2678 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimese93237d2007-12-19 02:37:44 +00002679 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002680 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002681 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002682 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002683
Tim Petersd64c1de2002-08-12 17:36:03 +00002684 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002685 if ((t2 = k_mul(al, bl)) == NULL) {
2686 Py_DECREF(t1);
2687 goto fail;
2688 }
Christian Heimese93237d2007-12-19 02:37:44 +00002689 assert(Py_SIZE(t2) >= 0);
2690 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2691 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002692
2693 /* Zero out remaining digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002694 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002695 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002696 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002697
Tim Petersd64c1de2002-08-12 17:36:03 +00002698 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2699 * because it's fresher in cache.
2700 */
Christian Heimese93237d2007-12-19 02:37:44 +00002701 i = Py_SIZE(ret) - shift; /* # digits after shift */
2702 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002703 Py_DECREF(t2);
2704
Christian Heimese93237d2007-12-19 02:37:44 +00002705 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002706 Py_DECREF(t1);
2707
Tim Petersd64c1de2002-08-12 17:36:03 +00002708 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002709 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2710 Py_DECREF(ah);
2711 Py_DECREF(al);
2712 ah = al = NULL;
2713
Tim Peters0973b992004-08-29 22:16:50 +00002714 if (a == b) {
2715 t2 = t1;
2716 Py_INCREF(t2);
2717 }
2718 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002719 Py_DECREF(t1);
2720 goto fail;
2721 }
2722 Py_DECREF(bh);
2723 Py_DECREF(bl);
2724 bh = bl = NULL;
2725
Tim Peters738eda72002-08-12 15:08:20 +00002726 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002727 Py_DECREF(t1);
2728 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002729 if (t3 == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002730 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002731
Tim Petersd6974a52002-08-13 20:37:51 +00002732 /* Add t3. It's not obvious why we can't run out of room here.
2733 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002734 */
Christian Heimese93237d2007-12-19 02:37:44 +00002735 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002736 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002737
Tim Peters5af4e6c2002-08-12 02:31:19 +00002738 return long_normalize(ret);
2739
2740 fail:
2741 Py_XDECREF(ret);
2742 Py_XDECREF(ah);
2743 Py_XDECREF(al);
2744 Py_XDECREF(bh);
2745 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002746 return NULL;
2747}
2748
Tim Petersd6974a52002-08-13 20:37:51 +00002749/* (*) Why adding t3 can't "run out of room" above.
2750
Tim Petersab86c2b2002-08-15 20:06:00 +00002751Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
2752to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00002753
Tim Petersab86c2b2002-08-15 20:06:00 +000027541. For any integer i, i = c(i/2) + f(i/2). In particular,
2755 bsize = c(bsize/2) + f(bsize/2).
27562. shift = f(bsize/2)
27573. asize <= bsize
27584. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
2759 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00002760
Tim Petersab86c2b2002-08-15 20:06:00 +00002761We allocated asize + bsize result digits, and add t3 into them at an offset
2762of shift. This leaves asize+bsize-shift allocated digit positions for t3
2763to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
2764asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00002765
Tim Petersab86c2b2002-08-15 20:06:00 +00002766bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
2767at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002768
Tim Petersab86c2b2002-08-15 20:06:00 +00002769If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
2770digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
2771most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002772
Tim Petersab86c2b2002-08-15 20:06:00 +00002773The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00002774
Tim Petersab86c2b2002-08-15 20:06:00 +00002775 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00002776
Tim Petersab86c2b2002-08-15 20:06:00 +00002777and we have asize + c(bsize/2) available digit positions. We need to show
2778this is always enough. An instance of c(bsize/2) cancels out in both, so
2779the question reduces to whether asize digits is enough to hold
2780(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
2781then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
2782asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002783digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00002784asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00002785c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
2786is enough to hold 2 bits. This is so if bsize >= 2, which holds because
2787bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00002788
Tim Peters48d52c02002-08-14 17:07:32 +00002789Note that since there's always enough room for (ah+al)*(bh+bl), and that's
2790clearly >= each of ah*bh and al*bl, there's always enough room to subtract
2791ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00002792*/
2793
Tim Peters60004642002-08-12 22:01:34 +00002794/* b has at least twice the digits of a, and a is big enough that Karatsuba
2795 * would pay off *if* the inputs had balanced sizes. View b as a sequence
2796 * of slices, each with a->ob_size digits, and multiply the slices by a,
2797 * one at a time. This gives k_mul balanced inputs to work with, and is
2798 * also cache-friendly (we compute one double-width slice of the result
2799 * at a time, then move on, never bactracking except for the helpful
2800 * single-width slice overlap between successive partial sums).
2801 */
2802static PyLongObject *
2803k_lopsided_mul(PyLongObject *a, PyLongObject *b)
2804{
Christian Heimese93237d2007-12-19 02:37:44 +00002805 const Py_ssize_t asize = ABS(Py_SIZE(a));
2806 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002807 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00002808 PyLongObject *ret;
2809 PyLongObject *bslice = NULL;
2810
2811 assert(asize > KARATSUBA_CUTOFF);
2812 assert(2 * asize <= bsize);
2813
2814 /* Allocate result space, and zero it out. */
2815 ret = _PyLong_New(asize + bsize);
2816 if (ret == NULL)
2817 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00002818 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00002819
2820 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00002821 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00002822 if (bslice == NULL)
2823 goto fail;
2824
2825 nbdone = 0;
2826 while (bsize > 0) {
2827 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002828 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00002829
2830 /* Multiply the next slice of b by a. */
2831 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
2832 nbtouse * sizeof(digit));
Christian Heimese93237d2007-12-19 02:37:44 +00002833 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00002834 product = k_mul(a, bslice);
2835 if (product == NULL)
2836 goto fail;
2837
2838 /* Add into result. */
Christian Heimese93237d2007-12-19 02:37:44 +00002839 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
2840 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00002841 Py_DECREF(product);
2842
2843 bsize -= nbtouse;
2844 nbdone += nbtouse;
2845 }
2846
2847 Py_DECREF(bslice);
2848 return long_normalize(ret);
2849
2850 fail:
2851 Py_DECREF(ret);
2852 Py_XDECREF(bslice);
2853 return NULL;
2854}
Tim Peters5af4e6c2002-08-12 02:31:19 +00002855
2856static PyObject *
2857long_mul(PyLongObject *v, PyLongObject *w)
2858{
2859 PyLongObject *a, *b, *z;
2860
2861 if (!convert_binop((PyObject *)v, (PyObject *)w, &a, &b)) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002862 Py_INCREF(Py_NotImplemented);
2863 return Py_NotImplemented;
2864 }
2865
Tim Petersd64c1de2002-08-12 17:36:03 +00002866 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00002867 /* Negate if exactly one of the inputs is negative. */
2868 if (((a->ob_size ^ b->ob_size) < 0) && z)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002869 z->ob_size = -(z->ob_size);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002870 Py_DECREF(a);
2871 Py_DECREF(b);
Tim Peters9973d742002-08-15 19:41:06 +00002872 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002873}
2874
Guido van Rossume32e0141992-01-19 16:31:05 +00002875/* The / and % operators are now defined in terms of divmod().
2876 The expression a mod b has the value a - b*floor(a/b).
2877 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002878 |a| by |b|, with the sign of a. This is also expressed
2879 as a - b*trunc(a/b), if trunc truncates towards zero.
2880 Some examples:
2881 a b a rem b a mod b
2882 13 10 3 3
2883 -13 10 -3 7
2884 13 -10 3 -7
2885 -13 -10 -3 -3
2886 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002887 have different signs. We then subtract one from the 'div'
2888 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002889
Tim Peters47e52ee2004-08-30 02:44:38 +00002890/* Compute
2891 * *pdiv, *pmod = divmod(v, w)
2892 * NULL can be passed for pdiv or pmod, in which case that part of
2893 * the result is simply thrown away. The caller owns a reference to
2894 * each of these it requests (does not pass NULL for).
2895 */
Guido van Rossume32e0141992-01-19 16:31:05 +00002896static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00002897l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00002898 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00002899{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002900 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002901
Guido van Rossume32e0141992-01-19 16:31:05 +00002902 if (long_divrem(v, w, &div, &mod) < 0)
2903 return -1;
Christian Heimese93237d2007-12-19 02:37:44 +00002904 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
2905 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002906 PyLongObject *temp;
2907 PyLongObject *one;
2908 temp = (PyLongObject *) long_add(mod, w);
2909 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00002910 mod = temp;
2911 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002912 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002913 return -1;
2914 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002915 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00002916 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002917 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
2918 Py_DECREF(mod);
2919 Py_DECREF(div);
2920 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00002921 return -1;
2922 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002923 Py_DECREF(one);
2924 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002925 div = temp;
2926 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002927 if (pdiv != NULL)
2928 *pdiv = div;
2929 else
2930 Py_DECREF(div);
2931
2932 if (pmod != NULL)
2933 *pmod = mod;
2934 else
2935 Py_DECREF(mod);
2936
Guido van Rossume32e0141992-01-19 16:31:05 +00002937 return 0;
2938}
2939
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002940static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002941long_div(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00002942{
Tim Peters47e52ee2004-08-30 02:44:38 +00002943 PyLongObject *a, *b, *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002944
2945 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00002946 if (l_divmod(a, b, &div, NULL) < 0)
2947 div = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002948 Py_DECREF(a);
2949 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002950 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00002951}
2952
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002953static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +00002954long_classic_div(PyObject *v, PyObject *w)
2955{
Tim Peters47e52ee2004-08-30 02:44:38 +00002956 PyLongObject *a, *b, *div;
Guido van Rossum393661d2001-08-31 17:40:15 +00002957
2958 CONVERT_BINOP(v, w, &a, &b);
Guido van Rossum393661d2001-08-31 17:40:15 +00002959 if (Py_DivisionWarningFlag &&
2960 PyErr_Warn(PyExc_DeprecationWarning, "classic long division") < 0)
2961 div = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00002962 else if (l_divmod(a, b, &div, NULL) < 0)
Guido van Rossum393661d2001-08-31 17:40:15 +00002963 div = NULL;
Guido van Rossum393661d2001-08-31 17:40:15 +00002964 Py_DECREF(a);
2965 Py_DECREF(b);
2966 return (PyObject *)div;
2967}
2968
2969static PyObject *
Tim Peters20dab9f2001-09-04 05:31:47 +00002970long_true_divide(PyObject *v, PyObject *w)
2971{
Tim Peterse2a60002001-09-04 06:17:36 +00002972 PyLongObject *a, *b;
2973 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00002974 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00002975
2976 CONVERT_BINOP(v, w, &a, &b);
2977 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
2978 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00002979 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
2980 Py_DECREF(a);
2981 Py_DECREF(b);
2982 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00002983 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00002984 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
2985 but should really be set correctly after sucessful calls to
2986 _PyLong_AsScaledDouble() */
2987 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00002988
2989 if (bd == 0.0) {
2990 PyErr_SetString(PyExc_ZeroDivisionError,
2991 "long division or modulo by zero");
2992 return NULL;
2993 }
2994
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002995 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00002996 ad /= bd; /* overflow/underflow impossible here */
2997 aexp -= bexp;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002998 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00002999 goto overflow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003000 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00003001 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003002 errno = 0;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003003 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00003004 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003005 goto overflow;
3006 return PyFloat_FromDouble(ad);
3007
3008overflow:
3009 PyErr_SetString(PyExc_OverflowError,
3010 "long/long too large for a float");
3011 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003012
Tim Peters20dab9f2001-09-04 05:31:47 +00003013}
3014
3015static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003016long_mod(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00003017{
Tim Peters47e52ee2004-08-30 02:44:38 +00003018 PyLongObject *a, *b, *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003019
3020 CONVERT_BINOP(v, w, &a, &b);
3021
Tim Peters47e52ee2004-08-30 02:44:38 +00003022 if (l_divmod(a, b, NULL, &mod) < 0)
3023 mod = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003024 Py_DECREF(a);
3025 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003026 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003027}
3028
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003029static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003030long_divmod(PyObject *v, PyObject *w)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003031{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003032 PyLongObject *a, *b, *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003033 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003034
3035 CONVERT_BINOP(v, w, &a, &b);
3036
3037 if (l_divmod(a, b, &div, &mod) < 0) {
3038 Py_DECREF(a);
3039 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003040 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003041 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003042 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003043 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003044 PyTuple_SetItem(z, 0, (PyObject *) div);
3045 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003046 }
3047 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003048 Py_DECREF(div);
3049 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003050 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003051 Py_DECREF(a);
3052 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003053 return z;
3054}
3055
Tim Peters47e52ee2004-08-30 02:44:38 +00003056/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003057static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003058long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003059{
Tim Peters47e52ee2004-08-30 02:44:38 +00003060 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3061 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003062
Tim Peters47e52ee2004-08-30 02:44:38 +00003063 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00003064 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00003065 PyLongObject *temp = NULL;
3066
3067 /* 5-ary values. If the exponent is large enough, table is
3068 * precomputed so that table[i] == a**i % c for i in range(32).
3069 */
3070 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3071 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
3072
3073 /* a, b, c = v, w, x */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003074 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00003075 if (PyLong_Check(x)) {
3076 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003077 Py_INCREF(x);
3078 }
Tim Petersde7990b2005-07-17 23:45:23 +00003079 else if (PyInt_Check(x)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003080 c = (PyLongObject *)PyLong_FromLong(PyInt_AS_LONG(x));
Tim Petersde7990b2005-07-17 23:45:23 +00003081 if (c == NULL)
3082 goto Error;
3083 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003084 else if (x == Py_None)
3085 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003086 else {
3087 Py_DECREF(a);
3088 Py_DECREF(b);
3089 Py_INCREF(Py_NotImplemented);
3090 return Py_NotImplemented;
3091 }
Tim Peters4c483c42001-09-05 06:24:58 +00003092
Christian Heimese93237d2007-12-19 02:37:44 +00003093 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00003094 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00003095 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00003096 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00003097 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00003098 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003099 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00003100 /* else return a float. This works because we know
3101 that this calls float_pow() which converts its
3102 arguments to double. */
3103 Py_DECREF(a);
3104 Py_DECREF(b);
3105 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003106 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003107 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003108
3109 if (c) {
3110 /* if modulus == 0:
3111 raise ValueError() */
Christian Heimese93237d2007-12-19 02:37:44 +00003112 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003113 PyErr_SetString(PyExc_ValueError,
3114 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00003115 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003116 }
3117
3118 /* if modulus < 0:
3119 negativeOutput = True
3120 modulus = -modulus */
Christian Heimese93237d2007-12-19 02:37:44 +00003121 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003122 negativeOutput = 1;
3123 temp = (PyLongObject *)_PyLong_Copy(c);
3124 if (temp == NULL)
3125 goto Error;
3126 Py_DECREF(c);
3127 c = temp;
3128 temp = NULL;
3129 c->ob_size = - c->ob_size;
3130 }
3131
3132 /* if modulus == 1:
3133 return 0 */
Christian Heimese93237d2007-12-19 02:37:44 +00003134 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003135 z = (PyLongObject *)PyLong_FromLong(0L);
3136 goto Done;
3137 }
3138
3139 /* if base < 0:
3140 base = base % modulus
3141 Having the base positive just makes things easier. */
Christian Heimese93237d2007-12-19 02:37:44 +00003142 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003143 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003144 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003145 Py_DECREF(a);
3146 a = temp;
3147 temp = NULL;
3148 }
3149 }
3150
3151 /* At this point a, b, and c are guaranteed non-negative UNLESS
3152 c is NULL, in which case a may be negative. */
3153
3154 z = (PyLongObject *)PyLong_FromLong(1L);
3155 if (z == NULL)
3156 goto Error;
3157
3158 /* Perform a modular reduction, X = X % c, but leave X alone if c
3159 * is NULL.
3160 */
3161#define REDUCE(X) \
3162 if (c != NULL) { \
3163 if (l_divmod(X, c, NULL, &temp) < 0) \
3164 goto Error; \
3165 Py_XDECREF(X); \
3166 X = temp; \
3167 temp = NULL; \
3168 }
3169
3170 /* Multiply two values, then reduce the result:
3171 result = X*Y % c. If c is NULL, skip the mod. */
3172#define MULT(X, Y, result) \
3173{ \
3174 temp = (PyLongObject *)long_mul(X, Y); \
3175 if (temp == NULL) \
3176 goto Error; \
3177 Py_XDECREF(result); \
3178 result = temp; \
3179 temp = NULL; \
3180 REDUCE(result) \
3181}
3182
Christian Heimese93237d2007-12-19 02:37:44 +00003183 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003184 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3185 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimese93237d2007-12-19 02:37:44 +00003186 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003187 digit bi = b->ob_digit[i];
3188
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003189 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003190 MULT(z, z, z)
3191 if (bi & j)
3192 MULT(z, a, z)
3193 }
3194 }
3195 }
3196 else {
3197 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3198 Py_INCREF(z); /* still holds 1L */
3199 table[0] = z;
3200 for (i = 1; i < 32; ++i)
3201 MULT(table[i-1], a, table[i])
3202
Christian Heimese93237d2007-12-19 02:37:44 +00003203 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003204 const digit bi = b->ob_digit[i];
3205
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003206 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003207 const int index = (bi >> j) & 0x1f;
3208 for (k = 0; k < 5; ++k)
3209 MULT(z, z, z)
3210 if (index)
3211 MULT(z, table[index], z)
3212 }
3213 }
3214 }
3215
Christian Heimese93237d2007-12-19 02:37:44 +00003216 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003217 temp = (PyLongObject *)long_sub(z, c);
3218 if (temp == NULL)
3219 goto Error;
3220 Py_DECREF(z);
3221 z = temp;
3222 temp = NULL;
3223 }
3224 goto Done;
3225
3226 Error:
3227 if (z != NULL) {
3228 Py_DECREF(z);
3229 z = NULL;
3230 }
3231 /* fall through */
3232 Done:
Christian Heimese93237d2007-12-19 02:37:44 +00003233 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003234 for (i = 0; i < 32; ++i)
3235 Py_XDECREF(table[i]);
3236 }
Tim Petersde7990b2005-07-17 23:45:23 +00003237 Py_DECREF(a);
3238 Py_DECREF(b);
3239 Py_XDECREF(c);
3240 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003241 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003242}
3243
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003244static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003245long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003246{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003247 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003248 PyLongObject *x;
3249 PyLongObject *w;
3250 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003251 if (w == NULL)
3252 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003253 x = (PyLongObject *) long_add(v, w);
3254 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003255 if (x == NULL)
3256 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00003257 Py_SIZE(x) = -(Py_SIZE(x));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003258 return (PyObject *)x;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003259}
3260
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003261static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003262long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003263{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003264 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00003265 if (v->ob_size == 0 && PyLong_CheckExact(v)) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003266 /* -0 == 0 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003267 Py_INCREF(v);
3268 return (PyObject *) v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003269 }
Tim Peters69c2de32001-09-11 22:31:33 +00003270 z = (PyLongObject *)_PyLong_Copy(v);
3271 if (z != NULL)
3272 z->ob_size = -(v->ob_size);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003273 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003274}
3275
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003276static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003277long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003278{
3279 if (v->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003280 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003281 else
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003282 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003283}
3284
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003285static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003286long_nonzero(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003287{
Christian Heimese93237d2007-12-19 02:37:44 +00003288 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003289}
3290
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003291static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003292long_rshift(PyLongObject *v, PyLongObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003293{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003294 PyLongObject *a, *b;
3295 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003296 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003297 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003298 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003299
Neil Schemenauerba872e22001-01-04 01:46:03 +00003300 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
3301
Christian Heimese93237d2007-12-19 02:37:44 +00003302 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003303 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003304 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003305 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003306 if (a1 == NULL)
3307 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003308 a2 = (PyLongObject *) long_rshift(a1, b);
3309 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003310 if (a2 == NULL)
3311 goto rshift_error;
3312 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003313 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003314 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003315 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003316
Neil Schemenauerba872e22001-01-04 01:46:03 +00003317 shiftby = PyLong_AsLong((PyObject *)b);
3318 if (shiftby == -1L && PyErr_Occurred())
3319 goto rshift_error;
3320 if (shiftby < 0) {
3321 PyErr_SetString(PyExc_ValueError,
3322 "negative shift count");
3323 goto rshift_error;
3324 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003325 wordshift = shiftby / PyLong_SHIFT;
Christian Heimese93237d2007-12-19 02:37:44 +00003326 newsize = ABS(Py_SIZE(a)) - wordshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003327 if (newsize <= 0) {
3328 z = _PyLong_New(0);
3329 Py_DECREF(a);
3330 Py_DECREF(b);
3331 return (PyObject *)z;
3332 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003333 loshift = shiftby % PyLong_SHIFT;
3334 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003335 lomask = ((digit)1 << hishift) - 1;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003336 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003337 z = _PyLong_New(newsize);
3338 if (z == NULL)
3339 goto rshift_error;
Christian Heimese93237d2007-12-19 02:37:44 +00003340 if (Py_SIZE(a) < 0)
3341 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003342 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3343 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3344 if (i+1 < newsize)
3345 z->ob_digit[i] |=
3346 (a->ob_digit[j+1] << hishift) & himask;
3347 }
3348 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003349 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003350rshift_error:
3351 Py_DECREF(a);
3352 Py_DECREF(b);
3353 return (PyObject *) z;
3354
Guido van Rossumc6913e71991-11-19 20:26:46 +00003355}
3356
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003357static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003358long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003359{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003360 /* This version due to Tim Peters */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003361 PyLongObject *a, *b;
3362 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003363 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003364 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003365 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003366
Neil Schemenauerba872e22001-01-04 01:46:03 +00003367 CONVERT_BINOP(v, w, &a, &b);
3368
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003369 shiftby = PyLong_AsLong((PyObject *)b);
3370 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003371 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003372 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003373 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003374 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003375 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003376 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003377 PyErr_SetString(PyExc_ValueError,
3378 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003379 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003380 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003381 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3382 wordshift = (int)shiftby / PyLong_SHIFT;
3383 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003384
3385 oldsize = ABS(a->ob_size);
3386 newsize = oldsize + wordshift;
3387 if (remshift)
3388 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003389 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003390 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003391 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003392 if (a->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003393 z->ob_size = -(z->ob_size);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003394 for (i = 0; i < wordshift; i++)
3395 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003396 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003397 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003398 accum |= (twodigits)a->ob_digit[j] << remshift;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003399 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3400 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003401 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003402 if (remshift)
3403 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003404 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003405 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003406 z = long_normalize(z);
3407lshift_error:
3408 Py_DECREF(a);
3409 Py_DECREF(b);
3410 return (PyObject *) z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003411}
3412
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003413
3414/* Bitwise and/xor/or operations */
3415
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003416static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003417long_bitwise(PyLongObject *a,
3418 int op, /* '&', '|', '^' */
3419 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003420{
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003421 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003422 int negz;
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003423 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003424 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003425 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003426 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003427
Christian Heimese93237d2007-12-19 02:37:44 +00003428 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003429 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003430 if (a == NULL)
3431 return NULL;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003432 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003433 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003434 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003435 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003436 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003437 }
Christian Heimese93237d2007-12-19 02:37:44 +00003438 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003439 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003440 if (b == NULL) {
3441 Py_DECREF(a);
3442 return NULL;
3443 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003444 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003445 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003446 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003447 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003448 maskb = 0;
3449 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003450
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003451 negz = 0;
3452 switch (op) {
3453 case '^':
3454 if (maska != maskb) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003455 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003456 negz = -1;
3457 }
3458 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003459 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003460 if (maska && maskb) {
3461 op = '|';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003462 maska ^= PyLong_MASK;
3463 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003464 negz = -1;
3465 }
3466 break;
3467 case '|':
3468 if (maska || maskb) {
3469 op = '&';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003470 maska ^= PyLong_MASK;
3471 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003472 negz = -1;
3473 }
3474 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003475 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003476
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003477 /* JRH: The original logic here was to allocate the result value (z)
3478 as the longer of the two operands. However, there are some cases
3479 where the result is guaranteed to be shorter than that: AND of two
3480 positives, OR of two negatives: use the shorter number. AND with
3481 mixed signs: use the positive number. OR with mixed signs: use the
3482 negative number. After the transformations above, op will be '&'
3483 iff one of these cases applies, and mask will be non-0 for operands
3484 whose length should be ignored.
3485 */
3486
Christian Heimese93237d2007-12-19 02:37:44 +00003487 size_a = Py_SIZE(a);
3488 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003489 size_z = op == '&'
3490 ? (maska
3491 ? size_b
3492 : (maskb ? size_a : MIN(size_a, size_b)))
3493 : MAX(size_a, size_b);
3494 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003495 if (z == NULL) {
Neal Norwitzef02b9e2006-07-16 02:00:32 +00003496 Py_DECREF(a);
3497 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003498 return NULL;
3499 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003500
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003501 for (i = 0; i < size_z; ++i) {
3502 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3503 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3504 switch (op) {
3505 case '&': z->ob_digit[i] = diga & digb; break;
3506 case '|': z->ob_digit[i] = diga | digb; break;
3507 case '^': z->ob_digit[i] = diga ^ digb; break;
3508 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003509 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003510
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003511 Py_DECREF(a);
3512 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003513 z = long_normalize(z);
3514 if (negz == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003515 return (PyObject *) z;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003516 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003517 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003518 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003519}
3520
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003521static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003522long_and(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003523{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003524 PyLongObject *a, *b;
3525 PyObject *c;
3526 CONVERT_BINOP(v, w, &a, &b);
3527 c = long_bitwise(a, '&', b);
3528 Py_DECREF(a);
3529 Py_DECREF(b);
3530 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003531}
3532
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003533static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003534long_xor(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003535{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003536 PyLongObject *a, *b;
3537 PyObject *c;
3538 CONVERT_BINOP(v, w, &a, &b);
3539 c = long_bitwise(a, '^', b);
3540 Py_DECREF(a);
3541 Py_DECREF(b);
3542 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003543}
3544
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003545static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003546long_or(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003547{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003548 PyLongObject *a, *b;
3549 PyObject *c;
3550 CONVERT_BINOP(v, w, &a, &b);
3551 c = long_bitwise(a, '|', b);
3552 Py_DECREF(a);
3553 Py_DECREF(b);
3554 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003555}
3556
Guido van Rossum234f9421993-06-17 12:35:49 +00003557static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003558long_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +00003559{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003560 if (PyInt_Check(*pw)) {
Neil Schemenauerba872e22001-01-04 01:46:03 +00003561 *pw = PyLong_FromLong(PyInt_AS_LONG(*pw));
Georg Brandlc02e1312007-04-11 17:16:24 +00003562 if (*pw == NULL)
3563 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003564 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +00003565 return 0;
3566 }
Guido van Rossum1952e382001-09-19 01:25:16 +00003567 else if (PyLong_Check(*pw)) {
3568 Py_INCREF(*pv);
3569 Py_INCREF(*pw);
3570 return 0;
3571 }
Guido van Rossume6eefc21992-08-14 12:06:52 +00003572 return 1; /* Can't do it */
3573}
3574
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003575static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003576long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003577{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003578 if (PyLong_CheckExact(v))
3579 Py_INCREF(v);
3580 else
3581 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003582 return v;
3583}
3584
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003585static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +00003586long_int(PyObject *v)
3587{
3588 long x;
3589 x = PyLong_AsLong(v);
3590 if (PyErr_Occurred()) {
3591 if (PyErr_ExceptionMatches(PyExc_OverflowError)) {
3592 PyErr_Clear();
3593 if (PyLong_CheckExact(v)) {
3594 Py_INCREF(v);
3595 return v;
3596 }
3597 else
3598 return _PyLong_Copy((PyLongObject *)v);
3599 }
3600 else
3601 return NULL;
3602 }
3603 return PyInt_FromLong(x);
3604}
3605
3606static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003607long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003608{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003609 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003610 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003611 if (result == -1.0 && PyErr_Occurred())
3612 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003613 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003614}
3615
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003616static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003617long_oct(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003618{
Eric Smith5e527eb2008-02-10 01:36:53 +00003619 return _PyLong_Format(v, 8, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003620}
3621
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003622static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003623long_hex(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003624{
Eric Smith5e527eb2008-02-10 01:36:53 +00003625 return _PyLong_Format(v, 16, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003626}
Jeremy Hylton938ace62002-07-17 16:30:39 +00003627
3628static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003629long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003630
Tim Peters6d6c1a32001-08-02 04:15:00 +00003631static PyObject *
3632long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3633{
3634 PyObject *x = NULL;
3635 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003636 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003637
Guido van Rossumbef14172001-08-29 15:47:46 +00003638 if (type != &PyLong_Type)
3639 return long_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003640 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:long", kwlist,
3641 &x, &base))
3642 return NULL;
3643 if (x == NULL)
3644 return PyLong_FromLong(0L);
3645 if (base == -909)
3646 return PyNumber_Long(x);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003647 else if (PyString_Check(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003648 /* Since PyLong_FromString doesn't have a length parameter,
3649 * check here for possible NULs in the string. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003650 char *string = PyString_AS_STRING(x);
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003651 if (strlen(string) != (size_t)PyString_Size(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003652 /* create a repr() of the input string,
3653 * just like PyLong_FromString does. */
3654 PyObject *srepr;
3655 srepr = PyObject_Repr(x);
3656 if (srepr == NULL)
3657 return NULL;
3658 PyErr_Format(PyExc_ValueError,
3659 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003660 base, PyString_AS_STRING(srepr));
Georg Brandl00cd8182007-03-06 18:41:12 +00003661 Py_DECREF(srepr);
3662 return NULL;
3663 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003664 return PyLong_FromString(PyString_AS_STRING(x), NULL, base);
Georg Brandl00cd8182007-03-06 18:41:12 +00003665 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003666#ifdef Py_USING_UNICODE
Tim Peters6d6c1a32001-08-02 04:15:00 +00003667 else if (PyUnicode_Check(x))
3668 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3669 PyUnicode_GET_SIZE(x),
3670 base);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003671#endif
Tim Peters6d6c1a32001-08-02 04:15:00 +00003672 else {
3673 PyErr_SetString(PyExc_TypeError,
3674 "long() can't convert non-string with explicit base");
3675 return NULL;
3676 }
3677}
3678
Guido van Rossumbef14172001-08-29 15:47:46 +00003679/* Wimpy, slow approach to tp_new calls for subtypes of long:
3680 first create a regular long from whatever arguments we got,
3681 then allocate a subtype instance and initialize it from
3682 the regular long. The regular long is then thrown away.
3683*/
3684static PyObject *
3685long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3686{
Anthony Baxter377be112006-04-11 06:54:30 +00003687 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003688 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003689
3690 assert(PyType_IsSubtype(type, &PyLong_Type));
3691 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3692 if (tmp == NULL)
3693 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003694 assert(PyLong_CheckExact(tmp));
Christian Heimese93237d2007-12-19 02:37:44 +00003695 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003696 if (n < 0)
3697 n = -n;
Anthony Baxter377be112006-04-11 06:54:30 +00003698 newobj = (PyLongObject *)type->tp_alloc(type, n);
3699 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003700 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003701 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003702 }
Anthony Baxter377be112006-04-11 06:54:30 +00003703 assert(PyLong_Check(newobj));
Christian Heimese93237d2007-12-19 02:37:44 +00003704 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003705 for (i = 0; i < n; i++)
Anthony Baxter377be112006-04-11 06:54:30 +00003706 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003707 Py_DECREF(tmp);
Anthony Baxter377be112006-04-11 06:54:30 +00003708 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003709}
3710
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003711static PyObject *
3712long_getnewargs(PyLongObject *v)
3713{
3714 return Py_BuildValue("(N)", _PyLong_Copy(v));
3715}
3716
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003717static PyObject *
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003718long_get0(PyLongObject *v, void *context) {
3719 return PyLong_FromLong(0L);
3720}
3721
3722static PyObject *
3723long_get1(PyLongObject *v, void *context) {
3724 return PyLong_FromLong(1L);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003725}
3726
Eric Smitha9f7d622008-02-17 19:46:49 +00003727static PyObject *
3728long__format__(PyObject *self, PyObject *args)
3729{
3730 PyObject *format_spec;
3731
3732 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
3733 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00003734 if (PyBytes_Check(format_spec))
Eric Smithdc13b792008-05-30 18:10:04 +00003735 return _PyLong_FormatAdvanced(self,
3736 PyBytes_AS_STRING(format_spec),
3737 PyBytes_GET_SIZE(format_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003738 if (PyUnicode_Check(format_spec)) {
3739 /* Convert format_spec to a str */
Eric Smithdc13b792008-05-30 18:10:04 +00003740 PyObject *result;
3741 PyObject *str_spec = PyObject_Str(format_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003742
Eric Smithdc13b792008-05-30 18:10:04 +00003743 if (str_spec == NULL)
3744 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00003745
Eric Smithdc13b792008-05-30 18:10:04 +00003746 result = _PyLong_FormatAdvanced(self,
3747 PyBytes_AS_STRING(str_spec),
3748 PyBytes_GET_SIZE(str_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003749
Eric Smithdc13b792008-05-30 18:10:04 +00003750 Py_DECREF(str_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003751 return result;
3752 }
3753 PyErr_SetString(PyExc_TypeError, "__format__ requires str or unicode");
3754 return NULL;
3755}
3756
Robert Schuppenies51df0642008-06-01 16:16:17 +00003757static PyObject *
3758long_sizeof(PyLongObject *v)
3759{
3760 Py_ssize_t res;
3761
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003762 res = v->ob_type->tp_basicsize + ABS(Py_SIZE(v))*sizeof(digit);
Robert Schuppenies51df0642008-06-01 16:16:17 +00003763 return PyInt_FromSsize_t(res);
3764}
3765
Mark Dickinson1a707982008-12-17 16:14:37 +00003766static PyObject *
3767long_bit_length(PyLongObject *v)
3768{
3769 PyLongObject *result, *x, *y;
3770 Py_ssize_t ndigits, msd_bits = 0;
3771 digit msd;
3772
3773 assert(v != NULL);
3774 assert(PyLong_Check(v));
3775
3776 ndigits = ABS(Py_SIZE(v));
3777 if (ndigits == 0)
3778 return PyInt_FromLong(0);
3779
3780 msd = v->ob_digit[ndigits-1];
3781 while (msd >= 32) {
3782 msd_bits += 6;
3783 msd >>= 6;
3784 }
3785 msd_bits += (long)(BitLengthTable[msd]);
3786
3787 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
3788 return PyInt_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
3789
3790 /* expression above may overflow; use Python integers instead */
3791 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
3792 if (result == NULL)
3793 return NULL;
3794 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
3795 if (x == NULL)
3796 goto error;
3797 y = (PyLongObject *)long_mul(result, x);
3798 Py_DECREF(x);
3799 if (y == NULL)
3800 goto error;
3801 Py_DECREF(result);
3802 result = y;
3803
3804 x = (PyLongObject *)PyLong_FromLong(msd_bits);
3805 if (x == NULL)
3806 goto error;
3807 y = (PyLongObject *)long_add(result, x);
3808 Py_DECREF(x);
3809 if (y == NULL)
3810 goto error;
3811 Py_DECREF(result);
3812 result = y;
3813
3814 return (PyObject *)result;
3815
3816error:
3817 Py_DECREF(result);
3818 return NULL;
3819}
3820
3821PyDoc_STRVAR(long_bit_length_doc,
3822"long.bit_length() -> int or long\n\
3823\n\
3824Number of bits necessary to represent self in binary.\n\
3825>>> bin(37L)\n\
3826'0b100101'\n\
3827>>> (37L).bit_length()\n\
38286");
3829
Christian Heimes6f341092008-04-18 23:13:07 +00003830#if 0
3831static PyObject *
3832long_is_finite(PyObject *v)
3833{
3834 Py_RETURN_TRUE;
3835}
3836#endif
3837
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003838static PyMethodDef long_methods[] = {
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003839 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
3840 "Returns self, the complex conjugate of any long."},
Mark Dickinson1a707982008-12-17 16:14:37 +00003841 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
3842 long_bit_length_doc},
Christian Heimes6f341092008-04-18 23:13:07 +00003843#if 0
3844 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
3845 "Returns always True."},
3846#endif
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003847 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
3848 "Truncating an Integral returns itself."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003849 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smitha9f7d622008-02-17 19:46:49 +00003850 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Robert Schuppenies51df0642008-06-01 16:16:17 +00003851 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
Georg Brandl7a6de8b2008-06-01 16:42:16 +00003852 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003853 {NULL, NULL} /* sentinel */
3854};
3855
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003856static PyGetSetDef long_getset[] = {
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003857 {"real",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003858 (getter)long_long, (setter)NULL,
3859 "the real part of a complex number",
3860 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003861 {"imag",
3862 (getter)long_get0, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003863 "the imaginary part of a complex number",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003864 NULL},
3865 {"numerator",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003866 (getter)long_long, (setter)NULL,
3867 "the numerator of a rational number in lowest terms",
3868 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003869 {"denominator",
3870 (getter)long_get1, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003871 "the denominator of a rational number in lowest terms",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003872 NULL},
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003873 {NULL} /* Sentinel */
3874};
3875
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003876PyDoc_STRVAR(long_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003877"long(x[, base]) -> integer\n\
3878\n\
3879Convert a string or number to a long integer, if possible. A floating\n\
3880point argument will be truncated towards zero (this does not include a\n\
3881string representation of a floating point number!) When converting a\n\
3882string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003883converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003884
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003885static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00003886 (binaryfunc) long_add, /*nb_add*/
3887 (binaryfunc) long_sub, /*nb_subtract*/
3888 (binaryfunc) long_mul, /*nb_multiply*/
Georg Brandl347b3002006-03-30 11:57:00 +00003889 long_classic_div, /*nb_divide*/
3890 long_mod, /*nb_remainder*/
3891 long_divmod, /*nb_divmod*/
3892 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003893 (unaryfunc) long_neg, /*nb_negative*/
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003894 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003895 (unaryfunc) long_abs, /*tp_absolute*/
3896 (inquiry) long_nonzero, /*tp_nonzero*/
3897 (unaryfunc) long_invert, /*nb_invert*/
Georg Brandl347b3002006-03-30 11:57:00 +00003898 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003899 (binaryfunc) long_rshift, /*nb_rshift*/
Georg Brandl347b3002006-03-30 11:57:00 +00003900 long_and, /*nb_and*/
3901 long_xor, /*nb_xor*/
3902 long_or, /*nb_or*/
3903 long_coerce, /*nb_coerce*/
3904 long_int, /*nb_int*/
3905 long_long, /*nb_long*/
3906 long_float, /*nb_float*/
3907 long_oct, /*nb_oct*/
3908 long_hex, /*nb_hex*/
Guido van Rossum4668b002001-08-08 05:00:18 +00003909 0, /* nb_inplace_add */
3910 0, /* nb_inplace_subtract */
3911 0, /* nb_inplace_multiply */
3912 0, /* nb_inplace_divide */
3913 0, /* nb_inplace_remainder */
3914 0, /* nb_inplace_power */
3915 0, /* nb_inplace_lshift */
3916 0, /* nb_inplace_rshift */
3917 0, /* nb_inplace_and */
3918 0, /* nb_inplace_xor */
3919 0, /* nb_inplace_or */
Georg Brandl347b3002006-03-30 11:57:00 +00003920 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00003921 long_true_divide, /* nb_true_divide */
3922 0, /* nb_inplace_floor_divide */
3923 0, /* nb_inplace_true_divide */
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003924 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003925};
3926
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003927PyTypeObject PyLong_Type = {
3928 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003929 0, /* ob_size */
3930 "long", /* tp_name */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003931 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003932 sizeof(digit), /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003933 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003934 0, /* tp_print */
3935 0, /* tp_getattr */
3936 0, /* tp_setattr */
3937 (cmpfunc)long_compare, /* tp_compare */
Georg Brandl347b3002006-03-30 11:57:00 +00003938 long_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003939 &long_as_number, /* tp_as_number */
3940 0, /* tp_as_sequence */
3941 0, /* tp_as_mapping */
3942 (hashfunc)long_hash, /* tp_hash */
3943 0, /* tp_call */
Georg Brandl347b3002006-03-30 11:57:00 +00003944 long_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003945 PyObject_GenericGetAttr, /* tp_getattro */
3946 0, /* tp_setattro */
3947 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00003948 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003949 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003950 long_doc, /* tp_doc */
3951 0, /* tp_traverse */
3952 0, /* tp_clear */
3953 0, /* tp_richcompare */
3954 0, /* tp_weaklistoffset */
3955 0, /* tp_iter */
3956 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003957 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003958 0, /* tp_members */
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003959 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003960 0, /* tp_base */
3961 0, /* tp_dict */
3962 0, /* tp_descr_get */
3963 0, /* tp_descr_set */
3964 0, /* tp_dictoffset */
3965 0, /* tp_init */
3966 0, /* tp_alloc */
3967 long_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00003968 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003969};
Mark Dickinsonefc82f72009-03-20 15:51:55 +00003970
3971static PyTypeObject Long_InfoType;
3972
3973PyDoc_STRVAR(long_info__doc__,
3974"sys.long_info\n\
3975\n\
3976A struct sequence that holds information about Python's\n\
3977internal representation of integers. The attributes are read only.");
3978
3979static PyStructSequence_Field long_info_fields[] = {
3980 {"bits_per_digit", "size of a digit in bits"},
3981 {"sizeof_digit", "size in bytes of the C type used to "
3982 "represent a digit"},
3983 {NULL, NULL}
3984};
3985
3986static PyStructSequence_Desc long_info_desc = {
3987 "sys.long_info", /* name */
3988 long_info__doc__, /* doc */
3989 long_info_fields, /* fields */
3990 2 /* number of fields */
3991};
3992
3993PyObject *
3994PyLong_GetInfo(void)
3995{
3996 PyObject* long_info;
3997 int field = 0;
3998 long_info = PyStructSequence_New(&Long_InfoType);
3999 if (long_info == NULL)
4000 return NULL;
Mark Dickinson48e3fd22009-04-02 18:39:37 +00004001 PyStructSequence_SET_ITEM(long_info, field++,
4002 PyInt_FromLong(PyLong_SHIFT));
4003 PyStructSequence_SET_ITEM(long_info, field++,
4004 PyInt_FromLong(sizeof(digit)));
Mark Dickinsonefc82f72009-03-20 15:51:55 +00004005 if (PyErr_Occurred()) {
4006 Py_CLEAR(long_info);
4007 return NULL;
4008 }
4009 return long_info;
4010}
4011
4012int
4013_PyLong_Init(void)
4014{
4015 /* initialize long_info */
4016 if (Long_InfoType.tp_name == 0)
4017 PyStructSequence_InitType(&Long_InfoType, &long_info_desc);
4018 return 1;
4019}