blob: 1fe7b06b49a061a2cf9382c3139039dd3fa6fbbd [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
Eric Smith5e527eb2008-02-10 01:36:53 +00001364/* Convert the long to a string object with given base,
1365 appending a base prefix of 0[box] if base is 2, 8 or 16.
1366 Add a trailing "L" if addL is non-zero.
1367 If newstyle is zero, then use the pre-2.6 behavior of octal having
1368 a leading "0", instead of the prefix "0o" */
1369PyAPI_FUNC(PyObject *)
1370_PyLong_Format(PyObject *aa, int base, int addL, int newstyle)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001371{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001372 register PyLongObject *a = (PyLongObject *)aa;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001373 PyStringObject *str;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001374 Py_ssize_t i, j, sz;
Neal Norwitzc09efa82006-07-23 07:53:14 +00001375 Py_ssize_t size_a;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001376 char *p;
1377 int bits;
1378 char sign = '\0';
Guido van Rossume32e0141992-01-19 16:31:05 +00001379
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001380 if (a == NULL || !PyLong_Check(a)) {
1381 PyErr_BadInternalCall();
Guido van Rossume32e0141992-01-19 16:31:05 +00001382 return NULL;
1383 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001384 assert(base >= 2 && base <= 36);
Christian Heimese93237d2007-12-19 02:37:44 +00001385 size_a = ABS(Py_SIZE(a));
Tim Peters5af4e6c2002-08-12 02:31:19 +00001386
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001387 /* Compute a rough upper bound for the length of the string */
1388 i = base;
1389 bits = 0;
1390 while (i > 1) {
1391 ++bits;
1392 i >>= 1;
1393 }
Armin Rigo7ccbca92006-10-04 12:17:45 +00001394 i = 5 + (addL ? 1 : 0);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001395 j = size_a*PyLong_SHIFT + bits-1;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001396 sz = i + j / bits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001397 if (j / PyLong_SHIFT < size_a || sz < i) {
Armin Rigo7ccbca92006-10-04 12:17:45 +00001398 PyErr_SetString(PyExc_OverflowError,
1399 "long is too large to format");
1400 return NULL;
1401 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001402 str = (PyStringObject *) PyString_FromStringAndSize((char *)0, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001403 if (str == NULL)
1404 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001405 p = PyString_AS_STRING(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001406 *p = '\0';
Fred Drake121ee271999-12-23 15:41:28 +00001407 if (addL)
1408 *--p = 'L';
Guido van Rossum4c260ff1992-01-14 18:36:43 +00001409 if (a->ob_size < 0)
1410 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001411
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001412 if (a->ob_size == 0) {
1413 *--p = '0';
1414 }
1415 else if ((base & (base - 1)) == 0) {
1416 /* JRH: special case for power-of-2 bases */
Tim Peters586b2e32001-07-15 09:11:14 +00001417 twodigits accum = 0;
1418 int accumbits = 0; /* # of bits in accum */
1419 int basebits = 1; /* # of bits in base-1 */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001420 i = base;
Tim Peters7d3a5112000-07-08 04:17:21 +00001421 while ((i >>= 1) > 1)
1422 ++basebits;
Tim Peters586b2e32001-07-15 09:11:14 +00001423
1424 for (i = 0; i < size_a; ++i) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00001425 accum |= (twodigits)a->ob_digit[i] << accumbits;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001426 accumbits += PyLong_SHIFT;
Tim Peters586b2e32001-07-15 09:11:14 +00001427 assert(accumbits >= basebits);
1428 do {
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001429 char cdigit = (char)(accum & (base - 1));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001430 cdigit += (cdigit < 10) ? '0' : 'a'-10;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001431 assert(p > PyString_AS_STRING(str));
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001432 *--p = cdigit;
Tim Peters586b2e32001-07-15 09:11:14 +00001433 accumbits -= basebits;
1434 accum >>= basebits;
1435 } while (i < size_a-1 ? accumbits >= basebits :
1436 accum > 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001437 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001438 }
1439 else {
Tim Petersfad225f2001-07-13 02:59:26 +00001440 /* Not 0, and base not a power of 2. Divide repeatedly by
1441 base, but for speed use the highest power of base that
1442 fits in a digit. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001443 Py_ssize_t size = size_a;
Tim Peters212e6142001-07-14 12:23:19 +00001444 digit *pin = a->ob_digit;
1445 PyLongObject *scratch;
1446 /* powbasw <- largest power of base that fits in a digit. */
Tim Petersfad225f2001-07-13 02:59:26 +00001447 digit powbase = base; /* powbase == base ** power */
1448 int power = 1;
1449 for (;;) {
Mark Dickinsonb6464872009-02-25 20:29:50 +00001450 twodigits newpow = powbase * (twodigits)base;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001451 if (newpow >> PyLong_SHIFT) /* doesn't fit in a digit */
Tim Petersfad225f2001-07-13 02:59:26 +00001452 break;
1453 powbase = (digit)newpow;
1454 ++power;
1455 }
Tim Peters212e6142001-07-14 12:23:19 +00001456
1457 /* Get a scratch area for repeated division. */
1458 scratch = _PyLong_New(size);
1459 if (scratch == NULL) {
1460 Py_DECREF(str);
1461 return NULL;
1462 }
1463
1464 /* Repeatedly divide by powbase. */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001465 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001466 int ntostore = power;
Tim Peters212e6142001-07-14 12:23:19 +00001467 digit rem = inplace_divrem1(scratch->ob_digit,
1468 pin, size, powbase);
1469 pin = scratch->ob_digit; /* no need to use a again */
1470 if (pin[size - 1] == 0)
1471 --size;
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001472 SIGCHECK({
Tim Peters212e6142001-07-14 12:23:19 +00001473 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001474 Py_DECREF(str);
1475 return NULL;
1476 })
Tim Peters212e6142001-07-14 12:23:19 +00001477
1478 /* Break rem into digits. */
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001479 assert(ntostore > 0);
1480 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001481 digit nextrem = (digit)(rem / base);
1482 char c = (char)(rem - nextrem * base);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001483 assert(p > PyString_AS_STRING(str));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001484 c += (c < 10) ? '0' : 'a'-10;
Tim Petersfad225f2001-07-13 02:59:26 +00001485 *--p = c;
1486 rem = nextrem;
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001487 --ntostore;
1488 /* Termination is a bit delicate: must not
1489 store leading zeroes, so must get out if
Tim Peters212e6142001-07-14 12:23:19 +00001490 remaining quotient and rem are both 0. */
1491 } while (ntostore && (size || rem));
1492 } while (size != 0);
1493 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001494 }
1495
Eric Smith5e527eb2008-02-10 01:36:53 +00001496 if (base == 2) {
1497 *--p = 'b';
1498 *--p = '0';
1499 }
1500 else if (base == 8) {
1501 if (newstyle) {
1502 *--p = 'o';
Guido van Rossum2c475421992-08-14 15:13:07 +00001503 *--p = '0';
Eric Smith5e527eb2008-02-10 01:36:53 +00001504 }
1505 else
1506 if (size_a != 0)
1507 *--p = '0';
Guido van Rossum2c475421992-08-14 15:13:07 +00001508 }
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001509 else if (base == 16) {
1510 *--p = 'x';
1511 *--p = '0';
1512 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00001513 else if (base != 10) {
1514 *--p = '#';
1515 *--p = '0' + base%10;
1516 if (base > 10)
1517 *--p = '0' + base/10;
1518 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001519 if (sign)
1520 *--p = sign;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001521 if (p != PyString_AS_STRING(str)) {
1522 char *q = PyString_AS_STRING(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001523 assert(p > q);
1524 do {
1525 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001526 q--;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001527 _PyString_Resize((PyObject **)&str,
1528 (Py_ssize_t) (q - PyString_AS_STRING(str)));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001529 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001530 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001531}
1532
Tim Petersda53afa2006-05-25 17:34:03 +00001533/* Table of digit values for 8-bit string -> integer conversion.
1534 * '0' maps to 0, ..., '9' maps to 9.
1535 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1536 * All other indices map to 37.
1537 * Note that when converting a base B string, a char c is a legitimate
1538 * base B digit iff _PyLong_DigitValue[Py_CHARMASK(c)] < B.
1539 */
1540int _PyLong_DigitValue[256] = {
Tim Peters696cf432006-05-24 21:10:40 +00001541 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1542 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1543 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1544 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1545 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1546 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1547 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1548 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1549 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1550 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1551 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1552 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1553 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1554 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1555 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1556 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
Tim Peters696cf432006-05-24 21:10:40 +00001557};
1558
1559/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001560 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1561 * non-digit (which may be *str!). A normalized long is returned.
1562 * The point to this routine is that it takes time linear in the number of
1563 * string characters.
1564 */
1565static PyLongObject *
1566long_from_binary_base(char **str, int base)
1567{
1568 char *p = *str;
1569 char *start = p;
1570 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001571 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001572 PyLongObject *z;
1573 twodigits accum;
1574 int bits_in_accum;
1575 digit *pdigit;
1576
1577 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1578 n = base;
1579 for (bits_per_char = -1; n; ++bits_per_char)
1580 n >>= 1;
1581 /* n <- total # of bits needed, while setting p to end-of-string */
1582 n = 0;
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001583 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001584 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001585 *str = p;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001586 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1587 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001588 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001589 PyErr_SetString(PyExc_ValueError,
1590 "long string too large to convert");
1591 return NULL;
1592 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001593 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001594 z = _PyLong_New(n);
1595 if (z == NULL)
1596 return NULL;
1597 /* Read string from right, and fill in long from left; i.e.,
1598 * from least to most significant in both.
1599 */
1600 accum = 0;
1601 bits_in_accum = 0;
1602 pdigit = z->ob_digit;
1603 while (--p >= start) {
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001604 int k = _PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001605 assert(k >= 0 && k < base);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001606 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001607 bits_in_accum += bits_per_char;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001608 if (bits_in_accum >= PyLong_SHIFT) {
1609 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001610 assert(pdigit - z->ob_digit <= n);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001611 accum >>= PyLong_SHIFT;
1612 bits_in_accum -= PyLong_SHIFT;
1613 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001614 }
1615 }
1616 if (bits_in_accum) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001617 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001618 *pdigit++ = (digit)accum;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001619 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001620 }
1621 while (pdigit - z->ob_digit < n)
1622 *pdigit++ = 0;
1623 return long_normalize(z);
1624}
1625
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001626PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001627PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001628{
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001629 int sign = 1;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001630 char *start, *orig_str = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631 PyLongObject *z;
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001632 PyObject *strobj, *strrepr;
1633 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001634
Guido van Rossum472c04f1996-12-05 21:57:21 +00001635 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001636 PyErr_SetString(PyExc_ValueError,
Fred Drake661ea262000-10-24 19:57:45 +00001637 "long() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001638 return NULL;
1639 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001640 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001641 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001642 if (*str == '+')
1643 ++str;
1644 else if (*str == '-') {
1645 ++str;
1646 sign = -1;
1647 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001648 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001649 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001650 if (base == 0) {
Eric Smith9ff19b52008-03-17 17:32:20 +00001651 /* No base given. Deduce the base from the contents
1652 of the string */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001653 if (str[0] != '0')
1654 base = 10;
1655 else if (str[1] == 'x' || str[1] == 'X')
1656 base = 16;
Eric Smith9ff19b52008-03-17 17:32:20 +00001657 else if (str[1] == 'o' || str[1] == 'O')
1658 base = 8;
1659 else if (str[1] == 'b' || str[1] == 'B')
1660 base = 2;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001661 else
Eric Smith9ff19b52008-03-17 17:32:20 +00001662 /* "old" (C-style) octal literal, still valid in
1663 2.x, although illegal in 3.x */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001664 base = 8;
1665 }
Eric Smith9ff19b52008-03-17 17:32:20 +00001666 /* Whether or not we were deducing the base, skip leading chars
1667 as needed */
1668 if (str[0] == '0' &&
1669 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1670 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1671 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001672 str += 2;
Tim Peters696cf432006-05-24 21:10:40 +00001673
Guido van Rossume6762971998-06-22 03:54:46 +00001674 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00001675 if ((base & (base - 1)) == 0)
1676 z = long_from_binary_base(&str, base);
1677 else {
Tim Peters696cf432006-05-24 21:10:40 +00001678/***
1679Binary bases can be converted in time linear in the number of digits, because
1680Python's representation base is binary. Other bases (including decimal!) use
1681the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001682
Tim Peters696cf432006-05-24 21:10:40 +00001683First some math: the largest integer that can be expressed in N base-B digits
1684is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1685case number of Python digits needed to hold it is the smallest integer n s.t.
1686
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001687 PyLong_BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1688 PyLong_BASE**n >= B**N [taking logs to base PyLong_BASE]
1689 n >= log(B**N)/log(PyLong_BASE) = N * log(B)/log(PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001690
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001691The static array log_base_PyLong_BASE[base] == log(base)/log(PyLong_BASE) so we can compute
Tim Peters696cf432006-05-24 21:10:40 +00001692this quickly. A Python long with that much space is reserved near the start,
1693and the result is computed into it.
1694
1695The input string is actually treated as being in base base**i (i.e., i digits
1696are processed at a time), where two more static arrays hold:
1697
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001698 convwidth_base[base] = the largest integer i such that base**i <= PyLong_BASE
Tim Peters696cf432006-05-24 21:10:40 +00001699 convmultmax_base[base] = base ** convwidth_base[base]
1700
1701The first of these is the largest i such that i consecutive input digits
1702must fit in a single Python digit. The second is effectively the input
1703base we're really using.
1704
1705Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1706convmultmax_base[base], the result is "simply"
1707
1708 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1709
1710where B = convmultmax_base[base].
Tim Peters9faa3ed2006-05-30 15:53:34 +00001711
1712Error analysis: as above, the number of Python digits `n` needed is worst-
1713case
1714
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001715 n >= N * log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001716
1717where `N` is the number of input digits in base `B`. This is computed via
1718
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001719 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001720
1721below. Two numeric concerns are how much space this can waste, and whether
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001722the computed result can be too small. To be concrete, assume PyLong_BASE = 2**15,
Tim Peters9faa3ed2006-05-30 15:53:34 +00001723which is the default (and it's unlikely anyone changes that).
1724
1725Waste isn't a problem: provided the first input digit isn't 0, the difference
1726between the worst-case input with N digits and the smallest input with N
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001727digits is about a factor of B, but B is small compared to PyLong_BASE so at most
Tim Peters9faa3ed2006-05-30 15:53:34 +00001728one allocated Python digit can remain unused on that count. If
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001729N*log(B)/log(PyLong_BASE) is mathematically an exact integer, then truncating that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001730and adding 1 returns a result 1 larger than necessary. However, that can't
1731happen: whenever B is a power of 2, long_from_binary_base() is called
1732instead, and it's impossible for B**i to be an integer power of 2**15 when
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001733B 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 +00001734an exact integer when B is not a power of 2, since B**i has a prime factor
1735other than 2 in that case, but (2**15)**j's only prime factor is 2).
1736
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001737The computed result can be too small if the true value of N*log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001738is a little bit larger than an exact integer, but due to roundoff errors (in
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001739computing log(B), log(PyLong_BASE), their quotient, and/or multiplying that by N)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001740yields a numeric result a little less than that integer. Unfortunately, "how
1741close can a transcendental function get to an integer over some range?"
1742questions are generally theoretically intractable. Computer analysis via
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001743continued fractions is practical: expand log(B)/log(PyLong_BASE) via continued
Tim Peters9faa3ed2006-05-30 15:53:34 +00001744fractions, giving a sequence i/j of "the best" rational approximations. Then
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001745j*log(B)/log(PyLong_BASE) is approximately equal to (the integer) i. This shows that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001746we can get very close to being in trouble, but very rarely. For example,
174776573 is a denominator in one of the continued-fraction approximations to
1748log(10)/log(2**15), and indeed:
1749
1750 >>> log(10)/log(2**15)*76573
1751 16958.000000654003
1752
1753is very close to an integer. If we were working with IEEE single-precision,
1754rounding errors could kill us. Finding worst cases in IEEE double-precision
1755requires better-than-double-precision log() functions, and Tim didn't bother.
1756Instead the code checks to see whether the allocated space is enough as each
1757new Python digit is added, and copies the whole thing to a larger long if not.
1758This should happen extremely rarely, and in fact I don't have a test case
1759that triggers it(!). Instead the code was tested by artificially allocating
1760just 1 digit at the start, so that the copying code was exercised for every
1761digit beyond the first.
Tim Peters696cf432006-05-24 21:10:40 +00001762***/
1763 register twodigits c; /* current input character */
1764 Py_ssize_t size_z;
1765 int i;
1766 int convwidth;
1767 twodigits convmultmax, convmult;
1768 digit *pz, *pzstop;
1769 char* scan;
1770
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001771 static double log_base_PyLong_BASE[37] = {0.0e0,};
Tim Peters696cf432006-05-24 21:10:40 +00001772 static int convwidth_base[37] = {0,};
1773 static twodigits convmultmax_base[37] = {0,};
1774
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001775 if (log_base_PyLong_BASE[base] == 0.0) {
Tim Peters696cf432006-05-24 21:10:40 +00001776 twodigits convmax = base;
1777 int i = 1;
1778
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001779 log_base_PyLong_BASE[base] = log((double)base) /
1780 log((double)PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001781 for (;;) {
1782 twodigits next = convmax * base;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001783 if (next > PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001784 break;
1785 convmax = next;
1786 ++i;
1787 }
1788 convmultmax_base[base] = convmax;
1789 assert(i > 0);
1790 convwidth_base[base] = i;
1791 }
1792
1793 /* Find length of the string of numeric characters. */
1794 scan = str;
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001795 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Tim Peters696cf432006-05-24 21:10:40 +00001796 ++scan;
1797
1798 /* Create a long object that can contain the largest possible
1799 * integer with this base and length. Note that there's no
1800 * need to initialize z->ob_digit -- no slot is read up before
1801 * being stored into.
1802 */
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001803 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001804 /* Uncomment next line to test exceedingly rare copy code */
1805 /* size_z = 1; */
Tim Peters696cf432006-05-24 21:10:40 +00001806 assert(size_z > 0);
1807 z = _PyLong_New(size_z);
1808 if (z == NULL)
1809 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00001810 Py_SIZE(z) = 0;
Tim Peters696cf432006-05-24 21:10:40 +00001811
1812 /* `convwidth` consecutive input digits are treated as a single
1813 * digit in base `convmultmax`.
1814 */
1815 convwidth = convwidth_base[base];
1816 convmultmax = convmultmax_base[base];
1817
1818 /* Work ;-) */
1819 while (str < scan) {
1820 /* grab up to convwidth digits from the input string */
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001821 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Tim Peters696cf432006-05-24 21:10:40 +00001822 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
1823 c = (twodigits)(c * base +
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001824 _PyLong_DigitValue[Py_CHARMASK(*str)]);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001825 assert(c < PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001826 }
1827
1828 convmult = convmultmax;
1829 /* Calculate the shift only if we couldn't get
1830 * convwidth digits.
1831 */
1832 if (i != convwidth) {
1833 convmult = base;
1834 for ( ; i > 1; --i)
1835 convmult *= base;
1836 }
1837
1838 /* Multiply z by convmult, and add c. */
1839 pz = z->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +00001840 pzstop = pz + Py_SIZE(z);
Tim Peters696cf432006-05-24 21:10:40 +00001841 for (; pz < pzstop; ++pz) {
1842 c += (twodigits)*pz * convmult;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001843 *pz = (digit)(c & PyLong_MASK);
1844 c >>= PyLong_SHIFT;
Tim Peters696cf432006-05-24 21:10:40 +00001845 }
1846 /* carry off the current end? */
1847 if (c) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001848 assert(c < PyLong_BASE);
Christian Heimese93237d2007-12-19 02:37:44 +00001849 if (Py_SIZE(z) < size_z) {
Tim Peters9faa3ed2006-05-30 15:53:34 +00001850 *pz = (digit)c;
Christian Heimese93237d2007-12-19 02:37:44 +00001851 ++Py_SIZE(z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001852 }
1853 else {
1854 PyLongObject *tmp;
1855 /* Extremely rare. Get more space. */
Christian Heimese93237d2007-12-19 02:37:44 +00001856 assert(Py_SIZE(z) == size_z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001857 tmp = _PyLong_New(size_z + 1);
1858 if (tmp == NULL) {
1859 Py_DECREF(z);
1860 return NULL;
1861 }
1862 memcpy(tmp->ob_digit,
1863 z->ob_digit,
1864 sizeof(digit) * size_z);
1865 Py_DECREF(z);
1866 z = tmp;
1867 z->ob_digit[size_z] = (digit)c;
1868 ++size_z;
1869 }
Tim Peters696cf432006-05-24 21:10:40 +00001870 }
Tim Petersbf2674b2003-02-02 07:51:32 +00001871 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001872 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00001873 if (z == NULL)
1874 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001875 if (str == start)
1876 goto onError;
Tim Peters696cf432006-05-24 21:10:40 +00001877 if (sign < 0)
Christian Heimese93237d2007-12-19 02:37:44 +00001878 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001879 if (*str == 'L' || *str == 'l')
1880 str++;
1881 while (*str && isspace(Py_CHARMASK(*str)))
1882 str++;
1883 if (*str != '\0')
1884 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001885 if (pend)
1886 *pend = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001887 return (PyObject *) z;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001888
1889 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00001890 Py_XDECREF(z);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001891 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001892 strobj = PyString_FromStringAndSize(orig_str, slen);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001893 if (strobj == NULL)
1894 return NULL;
1895 strrepr = PyObject_Repr(strobj);
1896 Py_DECREF(strobj);
1897 if (strrepr == NULL)
1898 return NULL;
1899 PyErr_Format(PyExc_ValueError,
1900 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001901 base, PyString_AS_STRING(strrepr));
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001902 Py_DECREF(strrepr);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001903 return NULL;
1904}
1905
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001906#ifdef Py_USING_UNICODE
Guido van Rossum9e896b32000-04-05 20:11:21 +00001907PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001908PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00001909{
Walter Dörwald07e14762002-11-06 16:15:14 +00001910 PyObject *result;
Anthony Baxter377be112006-04-11 06:54:30 +00001911 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001912
Walter Dörwald07e14762002-11-06 16:15:14 +00001913 if (buffer == NULL)
1914 return NULL;
1915
1916 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
1917 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001918 return NULL;
1919 }
Walter Dörwald07e14762002-11-06 16:15:14 +00001920 result = PyLong_FromString(buffer, NULL, base);
1921 PyMem_FREE(buffer);
1922 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001923}
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001924#endif
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001925
Tim Peters9f688bf2000-07-07 15:53:28 +00001926/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001927static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00001928 (PyLongObject *, PyLongObject *, PyLongObject **);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001929static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001930
1931/* Long division with remainder, top-level routine */
1932
Guido van Rossume32e0141992-01-19 16:31:05 +00001933static int
Tim Peters9f688bf2000-07-07 15:53:28 +00001934long_divrem(PyLongObject *a, PyLongObject *b,
1935 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001936{
Christian Heimese93237d2007-12-19 02:37:44 +00001937 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001938 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001939
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001940 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001941 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +00001942 "long division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00001943 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001944 }
1945 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00001946 (size_a == size_b &&
1947 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001948 /* |a| < |b|. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001949 *pdiv = _PyLong_New(0);
Georg Brandlc02e1312007-04-11 17:16:24 +00001950 if (*pdiv == NULL)
1951 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001952 Py_INCREF(a);
1953 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00001954 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001955 }
1956 if (size_b == 1) {
1957 digit rem = 0;
1958 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00001959 if (z == NULL)
1960 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001961 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Georg Brandlc02e1312007-04-11 17:16:24 +00001962 if (*prem == NULL) {
1963 Py_DECREF(z);
1964 return -1;
1965 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001966 }
Guido van Rossume32e0141992-01-19 16:31:05 +00001967 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001968 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00001969 if (z == NULL)
1970 return -1;
1971 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001972 /* Set the signs.
1973 The quotient z has the sign of a*b;
1974 the remainder r has the sign of a,
1975 so a = b*z + r. */
Guido van Rossume32e0141992-01-19 16:31:05 +00001976 if ((a->ob_size < 0) != (b->ob_size < 0))
1977 z->ob_size = -(z->ob_size);
1978 if (a->ob_size < 0 && (*prem)->ob_size != 0)
1979 (*prem)->ob_size = -((*prem)->ob_size);
1980 *pdiv = z;
1981 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001982}
1983
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001984/* Unsigned long division with remainder -- the algorithm. The arguments v1
1985 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001986
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001987static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001988x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001989{
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001990 PyLongObject *v, *w, *a;
1991 Py_ssize_t i, k, size_v, size_w;
1992 int d;
1993 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
1994 twodigits vv;
1995 sdigit zhi;
1996 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001997
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001998 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
1999 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2000 handle the special case when the initial estimate q for a quotient
2001 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2002 that won't overflow a digit. */
2003
2004 /* allocate space; w will also be used to hold the final remainder */
2005 size_v = ABS(Py_SIZE(v1));
2006 size_w = ABS(Py_SIZE(w1));
2007 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2008 v = _PyLong_New(size_v+1);
2009 if (v == NULL) {
2010 *prem = NULL;
2011 return NULL;
2012 }
2013 w = _PyLong_New(size_w);
2014 if (w == NULL) {
2015 Py_DECREF(v);
2016 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002017 return NULL;
2018 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002019
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002020 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2021 shift v1 left by the same amount. Results go into w and v. */
2022 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2023 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2024 assert(carry == 0);
2025 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2026 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2027 v->ob_digit[size_v] = carry;
2028 size_v++;
2029 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002030
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002031 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2032 at most (and usually exactly) k = size_v - size_w digits. */
Neal Norwitzc6a989a2006-05-10 06:57:58 +00002033 k = size_v - size_w;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002034 assert(k >= 0);
2035 a = _PyLong_New(k);
2036 if (a == NULL) {
2037 Py_DECREF(w);
2038 Py_DECREF(v);
2039 *prem = NULL;
2040 return NULL;
2041 }
2042 v0 = v->ob_digit;
2043 w0 = w->ob_digit;
2044 wm1 = w0[size_w-1];
2045 wm2 = w0[size_w-2];
2046 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2047 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2048 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002049
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002050 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002051 Py_DECREF(a);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002052 Py_DECREF(w);
2053 Py_DECREF(v);
2054 *prem = NULL;
2055 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002056 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002057
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002058 /* estimate quotient digit q; may overestimate by 1 (rare) */
2059 vtop = vk[size_w];
2060 assert(vtop <= wm1);
2061 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2062 q = (digit)(vv / wm1);
2063 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2064 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2065 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002066 --q;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002067 r += wm1;
2068 if (r >= PyLong_BASE)
2069 break;
2070 }
2071 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002072
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002073 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2074 zhi = 0;
2075 for (i = 0; i < size_w; ++i) {
2076 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2077 -PyLong_BASE * q <= z < PyLong_BASE */
2078 z = (sdigit)vk[i] + zhi -
2079 (stwodigits)q * (stwodigits)w0[i];
2080 vk[i] = (digit)z & PyLong_MASK;
2081 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2082 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002083 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002084
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002085 /* add w back if q was too large (this branch taken rarely) */
2086 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2087 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002088 carry = 0;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002089 for (i = 0; i < size_w; ++i) {
2090 carry += vk[i] + w0[i];
2091 vk[i] = carry & PyLong_MASK;
2092 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002093 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002094 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002095 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002096
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002097 /* store quotient digit */
2098 assert(q < PyLong_BASE);
2099 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002100 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002101
2102 /* unshift remainder; we reuse w to store the result */
2103 carry = v_rshift(w0, v0, size_w, d);
2104 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002105 Py_DECREF(v);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002106
2107 *prem = long_normalize(w);
2108 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002109}
2110
2111/* Methods */
2112
2113static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002114long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002115{
Christian Heimese93237d2007-12-19 02:37:44 +00002116 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002117}
2118
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002119static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002120long_repr(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002121{
Eric Smith5e527eb2008-02-10 01:36:53 +00002122 return _PyLong_Format(v, 10, 1, 0);
Fred Drake121ee271999-12-23 15:41:28 +00002123}
2124
2125static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002126long_str(PyObject *v)
Fred Drake121ee271999-12-23 15:41:28 +00002127{
Eric Smith5e527eb2008-02-10 01:36:53 +00002128 return _PyLong_Format(v, 10, 0, 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002129}
2130
2131static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002132long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002133{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002134 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002135
Christian Heimese93237d2007-12-19 02:37:44 +00002136 if (Py_SIZE(a) != Py_SIZE(b)) {
2137 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002138 sign = 0;
2139 else
Christian Heimese93237d2007-12-19 02:37:44 +00002140 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002141 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002142 else {
Christian Heimese93237d2007-12-19 02:37:44 +00002143 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002144 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2145 ;
2146 if (i < 0)
2147 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002148 else {
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00002149 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimese93237d2007-12-19 02:37:44 +00002150 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002151 sign = -sign;
2152 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002153 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002154 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002155}
2156
Guido van Rossum9bfef441993-03-29 10:43:31 +00002157static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002158long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002159{
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002160 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002161 Py_ssize_t i;
2162 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002163
2164 /* This is designed so that Python ints and longs with the
2165 same value hash to the same value, otherwise comparisons
2166 of mapping keys will turn out weird */
2167 i = v->ob_size;
2168 sign = 1;
2169 x = 0;
2170 if (i < 0) {
2171 sign = -1;
2172 i = -(i);
2173 }
Mark Dickinsona0eae032009-01-26 21:40:08 +00002174 /* The following loop produces a C unsigned long x such that x is
2175 congruent to the absolute value of v modulo ULONG_MAX. The
2176 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002177 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002178 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002179 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002180 x += v->ob_digit[i];
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002181 /* If the addition above overflowed we compensate by
2182 incrementing. This preserves the value modulo
2183 ULONG_MAX. */
2184 if (x < v->ob_digit[i])
Facundo Batistad544df72007-09-19 15:10:06 +00002185 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002186 }
2187 x = x * sign;
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002188 if (x == (unsigned long)-1)
2189 x = (unsigned long)-2;
2190 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002191}
2192
2193
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002194/* Add the absolute values of two long integers. */
2195
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002197x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002198{
Christian Heimese93237d2007-12-19 02:37:44 +00002199 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002200 PyLongObject *z;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00002201 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002202 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002203
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002204 /* Ensure a is the larger of the two: */
2205 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002206 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002207 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002208 size_a = size_b;
2209 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002210 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002211 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002212 if (z == NULL)
2213 return NULL;
2214 for (i = 0; i < size_b; ++i) {
2215 carry += a->ob_digit[i] + b->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002216 z->ob_digit[i] = carry & PyLong_MASK;
2217 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002218 }
2219 for (; i < size_a; ++i) {
2220 carry += a->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002221 z->ob_digit[i] = carry & PyLong_MASK;
2222 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002223 }
2224 z->ob_digit[i] = carry;
2225 return long_normalize(z);
2226}
2227
2228/* Subtract the absolute values of two integers. */
2229
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002230static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002231x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002232{
Christian Heimese93237d2007-12-19 02:37:44 +00002233 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002234 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002235 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002236 int sign = 1;
2237 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002238
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002239 /* Ensure a is the larger of the two: */
2240 if (size_a < size_b) {
2241 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002242 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002243 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002244 size_a = size_b;
2245 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002246 }
2247 else if (size_a == size_b) {
2248 /* Find highest digit where a and b differ: */
2249 i = size_a;
2250 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2251 ;
2252 if (i < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002253 return _PyLong_New(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002254 if (a->ob_digit[i] < b->ob_digit[i]) {
2255 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002256 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002257 }
2258 size_a = size_b = i+1;
2259 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002260 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002261 if (z == NULL)
2262 return NULL;
2263 for (i = 0; i < size_b; ++i) {
2264 /* The following assumes unsigned arithmetic
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002265 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002266 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002267 z->ob_digit[i] = borrow & PyLong_MASK;
2268 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002269 borrow &= 1; /* Keep only one sign bit */
2270 }
2271 for (; i < size_a; ++i) {
2272 borrow = a->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002273 z->ob_digit[i] = borrow & PyLong_MASK;
2274 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002275 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002276 }
2277 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002278 if (sign < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002279 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002280 return long_normalize(z);
2281}
2282
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002283static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002284long_add(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002285{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002286 PyLongObject *a, *b, *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002287
Neil Schemenauerba872e22001-01-04 01:46:03 +00002288 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2289
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002290 if (a->ob_size < 0) {
2291 if (b->ob_size < 0) {
2292 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002293 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002294 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002295 }
2296 else
2297 z = x_sub(b, a);
2298 }
2299 else {
2300 if (b->ob_size < 0)
2301 z = x_sub(a, b);
2302 else
2303 z = x_add(a, b);
2304 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002305 Py_DECREF(a);
2306 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002307 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002308}
2309
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002310static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002311long_sub(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002312{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002313 PyLongObject *a, *b, *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002314
Neil Schemenauerba872e22001-01-04 01:46:03 +00002315 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2316
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002317 if (a->ob_size < 0) {
2318 if (b->ob_size < 0)
2319 z = x_sub(a, b);
2320 else
2321 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002322 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002323 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002324 }
2325 else {
2326 if (b->ob_size < 0)
2327 z = x_add(a, b);
2328 else
2329 z = x_sub(a, b);
2330 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002331 Py_DECREF(a);
2332 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002333 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002334}
2335
Tim Peters5af4e6c2002-08-12 02:31:19 +00002336/* Grade school multiplication, ignoring the signs.
2337 * Returns the absolute value of the product, or NULL if error.
2338 */
2339static PyLongObject *
2340x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002341{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002342 PyLongObject *z;
Christian Heimese93237d2007-12-19 02:37:44 +00002343 Py_ssize_t size_a = ABS(Py_SIZE(a));
2344 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002345 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002346
Tim Peters5af4e6c2002-08-12 02:31:19 +00002347 z = _PyLong_New(size_a + size_b);
2348 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002349 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002350
Christian Heimese93237d2007-12-19 02:37:44 +00002351 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002352 if (a == b) {
2353 /* Efficient squaring per HAC, Algorithm 14.16:
2354 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2355 * Gives slightly less than a 2x speedup when a == b,
2356 * via exploiting that each entry in the multiplication
2357 * pyramid appears twice (except for the size_a squares).
2358 */
2359 for (i = 0; i < size_a; ++i) {
2360 twodigits carry;
2361 twodigits f = a->ob_digit[i];
2362 digit *pz = z->ob_digit + (i << 1);
2363 digit *pa = a->ob_digit + i + 1;
2364 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002365
Tim Peters0973b992004-08-29 22:16:50 +00002366 SIGCHECK({
2367 Py_DECREF(z);
2368 return NULL;
2369 })
2370
2371 carry = *pz + f * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002372 *pz++ = (digit)(carry & PyLong_MASK);
2373 carry >>= PyLong_SHIFT;
2374 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002375
2376 /* Now f is added in twice in each column of the
2377 * pyramid it appears. Same as adding f<<1 once.
2378 */
2379 f <<= 1;
2380 while (pa < paend) {
2381 carry += *pz + *pa++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002382 *pz++ = (digit)(carry & PyLong_MASK);
2383 carry >>= PyLong_SHIFT;
2384 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002385 }
2386 if (carry) {
2387 carry += *pz;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002388 *pz++ = (digit)(carry & PyLong_MASK);
2389 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002390 }
2391 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002392 *pz += (digit)(carry & PyLong_MASK);
2393 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002394 }
Tim Peters0973b992004-08-29 22:16:50 +00002395 }
2396 else { /* a is not the same as b -- gradeschool long mult */
2397 for (i = 0; i < size_a; ++i) {
2398 twodigits carry = 0;
2399 twodigits f = a->ob_digit[i];
2400 digit *pz = z->ob_digit + i;
2401 digit *pb = b->ob_digit;
2402 digit *pbend = b->ob_digit + size_b;
2403
2404 SIGCHECK({
2405 Py_DECREF(z);
2406 return NULL;
2407 })
2408
2409 while (pb < pbend) {
2410 carry += *pz + *pb++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002411 *pz++ = (digit)(carry & PyLong_MASK);
2412 carry >>= PyLong_SHIFT;
2413 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002414 }
2415 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002416 *pz += (digit)(carry & PyLong_MASK);
2417 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002418 }
2419 }
Tim Peters44121a62002-08-12 06:17:58 +00002420 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002421}
2422
2423/* A helper for Karatsuba multiplication (k_mul).
2424 Takes a long "n" and an integer "size" representing the place to
2425 split, and sets low and high such that abs(n) == (high << size) + low,
2426 viewing the shift as being by digits. The sign bit is ignored, and
2427 the return values are >= 0.
2428 Returns 0 on success, -1 on failure.
2429*/
2430static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002431kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002432{
2433 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002434 Py_ssize_t size_lo, size_hi;
Christian Heimese93237d2007-12-19 02:37:44 +00002435 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002436
2437 size_lo = MIN(size_n, size);
2438 size_hi = size_n - size_lo;
2439
2440 if ((hi = _PyLong_New(size_hi)) == NULL)
2441 return -1;
2442 if ((lo = _PyLong_New(size_lo)) == NULL) {
2443 Py_DECREF(hi);
2444 return -1;
2445 }
2446
2447 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2448 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2449
2450 *high = long_normalize(hi);
2451 *low = long_normalize(lo);
2452 return 0;
2453}
2454
Tim Peters60004642002-08-12 22:01:34 +00002455static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2456
Tim Peters5af4e6c2002-08-12 02:31:19 +00002457/* Karatsuba multiplication. Ignores the input signs, and returns the
2458 * absolute value of the product (or NULL if error).
2459 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2460 */
2461static PyLongObject *
2462k_mul(PyLongObject *a, PyLongObject *b)
2463{
Christian Heimese93237d2007-12-19 02:37:44 +00002464 Py_ssize_t asize = ABS(Py_SIZE(a));
2465 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002466 PyLongObject *ah = NULL;
2467 PyLongObject *al = NULL;
2468 PyLongObject *bh = NULL;
2469 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002470 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002471 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002472 Py_ssize_t shift; /* the number of digits we split off */
2473 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002474
Tim Peters5af4e6c2002-08-12 02:31:19 +00002475 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2476 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2477 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002478 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002479 * By picking X to be a power of 2, "*X" is just shifting, and it's
2480 * been reduced to 3 multiplies on numbers half the size.
2481 */
2482
Tim Petersfc07e562002-08-12 02:54:10 +00002483 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002484 * is largest.
2485 */
Tim Peters738eda72002-08-12 15:08:20 +00002486 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002487 t1 = a;
2488 a = b;
2489 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002490
2491 i = asize;
2492 asize = bsize;
2493 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002494 }
2495
2496 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002497 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2498 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002499 if (asize == 0)
Tim Peters44121a62002-08-12 06:17:58 +00002500 return _PyLong_New(0);
2501 else
2502 return x_mul(a, b);
2503 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002504
Tim Peters60004642002-08-12 22:01:34 +00002505 /* If a is small compared to b, splitting on b gives a degenerate
2506 * case with ah==0, and Karatsuba may be (even much) less efficient
2507 * than "grade school" then. However, we can still win, by viewing
2508 * b as a string of "big digits", each of width a->ob_size. That
2509 * leads to a sequence of balanced calls to k_mul.
2510 */
2511 if (2 * asize <= bsize)
2512 return k_lopsided_mul(a, b);
2513
Tim Petersd6974a52002-08-13 20:37:51 +00002514 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002515 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002516 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002517 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002518
Tim Peters0973b992004-08-29 22:16:50 +00002519 if (a == b) {
2520 bh = ah;
2521 bl = al;
2522 Py_INCREF(bh);
2523 Py_INCREF(bl);
2524 }
2525 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002526
Tim Petersd64c1de2002-08-12 17:36:03 +00002527 /* The plan:
2528 * 1. Allocate result space (asize + bsize digits: that's always
2529 * enough).
2530 * 2. Compute ah*bh, and copy into result at 2*shift.
2531 * 3. Compute al*bl, and copy into result at 0. Note that this
2532 * can't overlap with #2.
2533 * 4. Subtract al*bl from the result, starting at shift. This may
2534 * underflow (borrow out of the high digit), but we don't care:
2535 * we're effectively doing unsigned arithmetic mod
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002536 * PyLong_BASE**(sizea + sizeb), and so long as the *final* result fits,
Tim Petersd64c1de2002-08-12 17:36:03 +00002537 * borrows and carries out of the high digit can be ignored.
2538 * 5. Subtract ah*bh from the result, starting at shift.
2539 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2540 * at shift.
2541 */
2542
2543 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002544 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002545 if (ret == NULL) goto fail;
2546#ifdef Py_DEBUG
2547 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002548 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002549#endif
Tim Peters44121a62002-08-12 06:17:58 +00002550
Tim Petersd64c1de2002-08-12 17:36:03 +00002551 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002552 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002553 assert(Py_SIZE(t1) >= 0);
2554 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002555 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimese93237d2007-12-19 02:37:44 +00002556 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002557
2558 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimese93237d2007-12-19 02:37:44 +00002559 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002560 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002561 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002562 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002563
Tim Petersd64c1de2002-08-12 17:36:03 +00002564 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002565 if ((t2 = k_mul(al, bl)) == NULL) {
2566 Py_DECREF(t1);
2567 goto fail;
2568 }
Christian Heimese93237d2007-12-19 02:37:44 +00002569 assert(Py_SIZE(t2) >= 0);
2570 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2571 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002572
2573 /* Zero out remaining digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002574 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002575 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002576 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002577
Tim Petersd64c1de2002-08-12 17:36:03 +00002578 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2579 * because it's fresher in cache.
2580 */
Christian Heimese93237d2007-12-19 02:37:44 +00002581 i = Py_SIZE(ret) - shift; /* # digits after shift */
2582 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002583 Py_DECREF(t2);
2584
Christian Heimese93237d2007-12-19 02:37:44 +00002585 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002586 Py_DECREF(t1);
2587
Tim Petersd64c1de2002-08-12 17:36:03 +00002588 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002589 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2590 Py_DECREF(ah);
2591 Py_DECREF(al);
2592 ah = al = NULL;
2593
Tim Peters0973b992004-08-29 22:16:50 +00002594 if (a == b) {
2595 t2 = t1;
2596 Py_INCREF(t2);
2597 }
2598 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002599 Py_DECREF(t1);
2600 goto fail;
2601 }
2602 Py_DECREF(bh);
2603 Py_DECREF(bl);
2604 bh = bl = NULL;
2605
Tim Peters738eda72002-08-12 15:08:20 +00002606 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002607 Py_DECREF(t1);
2608 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002609 if (t3 == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002610 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002611
Tim Petersd6974a52002-08-13 20:37:51 +00002612 /* Add t3. It's not obvious why we can't run out of room here.
2613 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002614 */
Christian Heimese93237d2007-12-19 02:37:44 +00002615 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002616 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002617
Tim Peters5af4e6c2002-08-12 02:31:19 +00002618 return long_normalize(ret);
2619
2620 fail:
2621 Py_XDECREF(ret);
2622 Py_XDECREF(ah);
2623 Py_XDECREF(al);
2624 Py_XDECREF(bh);
2625 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002626 return NULL;
2627}
2628
Tim Petersd6974a52002-08-13 20:37:51 +00002629/* (*) Why adding t3 can't "run out of room" above.
2630
Tim Petersab86c2b2002-08-15 20:06:00 +00002631Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
2632to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00002633
Tim Petersab86c2b2002-08-15 20:06:00 +000026341. For any integer i, i = c(i/2) + f(i/2). In particular,
2635 bsize = c(bsize/2) + f(bsize/2).
26362. shift = f(bsize/2)
26373. asize <= bsize
26384. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
2639 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00002640
Tim Petersab86c2b2002-08-15 20:06:00 +00002641We allocated asize + bsize result digits, and add t3 into them at an offset
2642of shift. This leaves asize+bsize-shift allocated digit positions for t3
2643to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
2644asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00002645
Tim Petersab86c2b2002-08-15 20:06:00 +00002646bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
2647at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002648
Tim Petersab86c2b2002-08-15 20:06:00 +00002649If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
2650digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
2651most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002652
Tim Petersab86c2b2002-08-15 20:06:00 +00002653The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00002654
Tim Petersab86c2b2002-08-15 20:06:00 +00002655 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00002656
Tim Petersab86c2b2002-08-15 20:06:00 +00002657and we have asize + c(bsize/2) available digit positions. We need to show
2658this is always enough. An instance of c(bsize/2) cancels out in both, so
2659the question reduces to whether asize digits is enough to hold
2660(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
2661then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
2662asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002663digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00002664asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00002665c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
2666is enough to hold 2 bits. This is so if bsize >= 2, which holds because
2667bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00002668
Tim Peters48d52c02002-08-14 17:07:32 +00002669Note that since there's always enough room for (ah+al)*(bh+bl), and that's
2670clearly >= each of ah*bh and al*bl, there's always enough room to subtract
2671ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00002672*/
2673
Tim Peters60004642002-08-12 22:01:34 +00002674/* b has at least twice the digits of a, and a is big enough that Karatsuba
2675 * would pay off *if* the inputs had balanced sizes. View b as a sequence
2676 * of slices, each with a->ob_size digits, and multiply the slices by a,
2677 * one at a time. This gives k_mul balanced inputs to work with, and is
2678 * also cache-friendly (we compute one double-width slice of the result
2679 * at a time, then move on, never bactracking except for the helpful
2680 * single-width slice overlap between successive partial sums).
2681 */
2682static PyLongObject *
2683k_lopsided_mul(PyLongObject *a, PyLongObject *b)
2684{
Christian Heimese93237d2007-12-19 02:37:44 +00002685 const Py_ssize_t asize = ABS(Py_SIZE(a));
2686 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002687 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00002688 PyLongObject *ret;
2689 PyLongObject *bslice = NULL;
2690
2691 assert(asize > KARATSUBA_CUTOFF);
2692 assert(2 * asize <= bsize);
2693
2694 /* Allocate result space, and zero it out. */
2695 ret = _PyLong_New(asize + bsize);
2696 if (ret == NULL)
2697 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00002698 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00002699
2700 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00002701 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00002702 if (bslice == NULL)
2703 goto fail;
2704
2705 nbdone = 0;
2706 while (bsize > 0) {
2707 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002708 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00002709
2710 /* Multiply the next slice of b by a. */
2711 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
2712 nbtouse * sizeof(digit));
Christian Heimese93237d2007-12-19 02:37:44 +00002713 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00002714 product = k_mul(a, bslice);
2715 if (product == NULL)
2716 goto fail;
2717
2718 /* Add into result. */
Christian Heimese93237d2007-12-19 02:37:44 +00002719 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
2720 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00002721 Py_DECREF(product);
2722
2723 bsize -= nbtouse;
2724 nbdone += nbtouse;
2725 }
2726
2727 Py_DECREF(bslice);
2728 return long_normalize(ret);
2729
2730 fail:
2731 Py_DECREF(ret);
2732 Py_XDECREF(bslice);
2733 return NULL;
2734}
Tim Peters5af4e6c2002-08-12 02:31:19 +00002735
2736static PyObject *
2737long_mul(PyLongObject *v, PyLongObject *w)
2738{
2739 PyLongObject *a, *b, *z;
2740
2741 if (!convert_binop((PyObject *)v, (PyObject *)w, &a, &b)) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002742 Py_INCREF(Py_NotImplemented);
2743 return Py_NotImplemented;
2744 }
2745
Tim Petersd64c1de2002-08-12 17:36:03 +00002746 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00002747 /* Negate if exactly one of the inputs is negative. */
2748 if (((a->ob_size ^ b->ob_size) < 0) && z)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002749 z->ob_size = -(z->ob_size);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002750 Py_DECREF(a);
2751 Py_DECREF(b);
Tim Peters9973d742002-08-15 19:41:06 +00002752 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002753}
2754
Guido van Rossume32e0141992-01-19 16:31:05 +00002755/* The / and % operators are now defined in terms of divmod().
2756 The expression a mod b has the value a - b*floor(a/b).
2757 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002758 |a| by |b|, with the sign of a. This is also expressed
2759 as a - b*trunc(a/b), if trunc truncates towards zero.
2760 Some examples:
2761 a b a rem b a mod b
2762 13 10 3 3
2763 -13 10 -3 7
2764 13 -10 3 -7
2765 -13 -10 -3 -3
2766 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002767 have different signs. We then subtract one from the 'div'
2768 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002769
Tim Peters47e52ee2004-08-30 02:44:38 +00002770/* Compute
2771 * *pdiv, *pmod = divmod(v, w)
2772 * NULL can be passed for pdiv or pmod, in which case that part of
2773 * the result is simply thrown away. The caller owns a reference to
2774 * each of these it requests (does not pass NULL for).
2775 */
Guido van Rossume32e0141992-01-19 16:31:05 +00002776static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00002777l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00002778 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00002779{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002780 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002781
Guido van Rossume32e0141992-01-19 16:31:05 +00002782 if (long_divrem(v, w, &div, &mod) < 0)
2783 return -1;
Christian Heimese93237d2007-12-19 02:37:44 +00002784 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
2785 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002786 PyLongObject *temp;
2787 PyLongObject *one;
2788 temp = (PyLongObject *) long_add(mod, w);
2789 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00002790 mod = temp;
2791 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002792 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002793 return -1;
2794 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002795 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00002796 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002797 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
2798 Py_DECREF(mod);
2799 Py_DECREF(div);
2800 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00002801 return -1;
2802 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002803 Py_DECREF(one);
2804 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002805 div = temp;
2806 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002807 if (pdiv != NULL)
2808 *pdiv = div;
2809 else
2810 Py_DECREF(div);
2811
2812 if (pmod != NULL)
2813 *pmod = mod;
2814 else
2815 Py_DECREF(mod);
2816
Guido van Rossume32e0141992-01-19 16:31:05 +00002817 return 0;
2818}
2819
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002820static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002821long_div(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00002822{
Tim Peters47e52ee2004-08-30 02:44:38 +00002823 PyLongObject *a, *b, *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002824
2825 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00002826 if (l_divmod(a, b, &div, NULL) < 0)
2827 div = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002828 Py_DECREF(a);
2829 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002830 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00002831}
2832
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002833static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +00002834long_classic_div(PyObject *v, PyObject *w)
2835{
Tim Peters47e52ee2004-08-30 02:44:38 +00002836 PyLongObject *a, *b, *div;
Guido van Rossum393661d2001-08-31 17:40:15 +00002837
2838 CONVERT_BINOP(v, w, &a, &b);
Guido van Rossum393661d2001-08-31 17:40:15 +00002839 if (Py_DivisionWarningFlag &&
2840 PyErr_Warn(PyExc_DeprecationWarning, "classic long division") < 0)
2841 div = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00002842 else if (l_divmod(a, b, &div, NULL) < 0)
Guido van Rossum393661d2001-08-31 17:40:15 +00002843 div = NULL;
Guido van Rossum393661d2001-08-31 17:40:15 +00002844 Py_DECREF(a);
2845 Py_DECREF(b);
2846 return (PyObject *)div;
2847}
2848
2849static PyObject *
Tim Peters20dab9f2001-09-04 05:31:47 +00002850long_true_divide(PyObject *v, PyObject *w)
2851{
Tim Peterse2a60002001-09-04 06:17:36 +00002852 PyLongObject *a, *b;
2853 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00002854 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00002855
2856 CONVERT_BINOP(v, w, &a, &b);
2857 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
2858 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00002859 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
2860 Py_DECREF(a);
2861 Py_DECREF(b);
2862 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00002863 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00002864 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
2865 but should really be set correctly after sucessful calls to
2866 _PyLong_AsScaledDouble() */
2867 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00002868
2869 if (bd == 0.0) {
2870 PyErr_SetString(PyExc_ZeroDivisionError,
2871 "long division or modulo by zero");
2872 return NULL;
2873 }
2874
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002875 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00002876 ad /= bd; /* overflow/underflow impossible here */
2877 aexp -= bexp;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002878 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00002879 goto overflow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002880 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00002881 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00002882 errno = 0;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002883 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00002884 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00002885 goto overflow;
2886 return PyFloat_FromDouble(ad);
2887
2888overflow:
2889 PyErr_SetString(PyExc_OverflowError,
2890 "long/long too large for a float");
2891 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002892
Tim Peters20dab9f2001-09-04 05:31:47 +00002893}
2894
2895static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002896long_mod(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00002897{
Tim Peters47e52ee2004-08-30 02:44:38 +00002898 PyLongObject *a, *b, *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002899
2900 CONVERT_BINOP(v, w, &a, &b);
2901
Tim Peters47e52ee2004-08-30 02:44:38 +00002902 if (l_divmod(a, b, NULL, &mod) < 0)
2903 mod = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002904 Py_DECREF(a);
2905 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002906 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00002907}
2908
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002909static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002910long_divmod(PyObject *v, PyObject *w)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002911{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002912 PyLongObject *a, *b, *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002913 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002914
2915 CONVERT_BINOP(v, w, &a, &b);
2916
2917 if (l_divmod(a, b, &div, &mod) < 0) {
2918 Py_DECREF(a);
2919 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002920 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002921 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002922 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002923 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002924 PyTuple_SetItem(z, 0, (PyObject *) div);
2925 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002926 }
2927 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002928 Py_DECREF(div);
2929 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002930 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002931 Py_DECREF(a);
2932 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002933 return z;
2934}
2935
Tim Peters47e52ee2004-08-30 02:44:38 +00002936/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002937static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002938long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002939{
Tim Peters47e52ee2004-08-30 02:44:38 +00002940 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
2941 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00002942
Tim Peters47e52ee2004-08-30 02:44:38 +00002943 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00002944 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00002945 PyLongObject *temp = NULL;
2946
2947 /* 5-ary values. If the exponent is large enough, table is
2948 * precomputed so that table[i] == a**i % c for i in range(32).
2949 */
2950 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
2951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
2952
2953 /* a, b, c = v, w, x */
Neil Schemenauerba872e22001-01-04 01:46:03 +00002954 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00002955 if (PyLong_Check(x)) {
2956 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002957 Py_INCREF(x);
2958 }
Tim Petersde7990b2005-07-17 23:45:23 +00002959 else if (PyInt_Check(x)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00002960 c = (PyLongObject *)PyLong_FromLong(PyInt_AS_LONG(x));
Tim Petersde7990b2005-07-17 23:45:23 +00002961 if (c == NULL)
2962 goto Error;
2963 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002964 else if (x == Py_None)
2965 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002966 else {
2967 Py_DECREF(a);
2968 Py_DECREF(b);
2969 Py_INCREF(Py_NotImplemented);
2970 return Py_NotImplemented;
2971 }
Tim Peters4c483c42001-09-05 06:24:58 +00002972
Christian Heimese93237d2007-12-19 02:37:44 +00002973 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00002974 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00002975 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00002976 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00002977 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00002978 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00002979 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00002980 /* else return a float. This works because we know
2981 that this calls float_pow() which converts its
2982 arguments to double. */
2983 Py_DECREF(a);
2984 Py_DECREF(b);
2985 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00002986 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002987 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002988
2989 if (c) {
2990 /* if modulus == 0:
2991 raise ValueError() */
Christian Heimese93237d2007-12-19 02:37:44 +00002992 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00002993 PyErr_SetString(PyExc_ValueError,
2994 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00002995 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00002996 }
2997
2998 /* if modulus < 0:
2999 negativeOutput = True
3000 modulus = -modulus */
Christian Heimese93237d2007-12-19 02:37:44 +00003001 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003002 negativeOutput = 1;
3003 temp = (PyLongObject *)_PyLong_Copy(c);
3004 if (temp == NULL)
3005 goto Error;
3006 Py_DECREF(c);
3007 c = temp;
3008 temp = NULL;
3009 c->ob_size = - c->ob_size;
3010 }
3011
3012 /* if modulus == 1:
3013 return 0 */
Christian Heimese93237d2007-12-19 02:37:44 +00003014 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003015 z = (PyLongObject *)PyLong_FromLong(0L);
3016 goto Done;
3017 }
3018
3019 /* if base < 0:
3020 base = base % modulus
3021 Having the base positive just makes things easier. */
Christian Heimese93237d2007-12-19 02:37:44 +00003022 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003023 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003024 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003025 Py_DECREF(a);
3026 a = temp;
3027 temp = NULL;
3028 }
3029 }
3030
3031 /* At this point a, b, and c are guaranteed non-negative UNLESS
3032 c is NULL, in which case a may be negative. */
3033
3034 z = (PyLongObject *)PyLong_FromLong(1L);
3035 if (z == NULL)
3036 goto Error;
3037
3038 /* Perform a modular reduction, X = X % c, but leave X alone if c
3039 * is NULL.
3040 */
3041#define REDUCE(X) \
3042 if (c != NULL) { \
3043 if (l_divmod(X, c, NULL, &temp) < 0) \
3044 goto Error; \
3045 Py_XDECREF(X); \
3046 X = temp; \
3047 temp = NULL; \
3048 }
3049
3050 /* Multiply two values, then reduce the result:
3051 result = X*Y % c. If c is NULL, skip the mod. */
3052#define MULT(X, Y, result) \
3053{ \
3054 temp = (PyLongObject *)long_mul(X, Y); \
3055 if (temp == NULL) \
3056 goto Error; \
3057 Py_XDECREF(result); \
3058 result = temp; \
3059 temp = NULL; \
3060 REDUCE(result) \
3061}
3062
Christian Heimese93237d2007-12-19 02:37:44 +00003063 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003064 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3065 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimese93237d2007-12-19 02:37:44 +00003066 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003067 digit bi = b->ob_digit[i];
3068
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003069 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003070 MULT(z, z, z)
3071 if (bi & j)
3072 MULT(z, a, z)
3073 }
3074 }
3075 }
3076 else {
3077 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3078 Py_INCREF(z); /* still holds 1L */
3079 table[0] = z;
3080 for (i = 1; i < 32; ++i)
3081 MULT(table[i-1], a, table[i])
3082
Christian Heimese93237d2007-12-19 02:37:44 +00003083 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003084 const digit bi = b->ob_digit[i];
3085
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003086 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003087 const int index = (bi >> j) & 0x1f;
3088 for (k = 0; k < 5; ++k)
3089 MULT(z, z, z)
3090 if (index)
3091 MULT(z, table[index], z)
3092 }
3093 }
3094 }
3095
Christian Heimese93237d2007-12-19 02:37:44 +00003096 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003097 temp = (PyLongObject *)long_sub(z, c);
3098 if (temp == NULL)
3099 goto Error;
3100 Py_DECREF(z);
3101 z = temp;
3102 temp = NULL;
3103 }
3104 goto Done;
3105
3106 Error:
3107 if (z != NULL) {
3108 Py_DECREF(z);
3109 z = NULL;
3110 }
3111 /* fall through */
3112 Done:
Christian Heimese93237d2007-12-19 02:37:44 +00003113 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003114 for (i = 0; i < 32; ++i)
3115 Py_XDECREF(table[i]);
3116 }
Tim Petersde7990b2005-07-17 23:45:23 +00003117 Py_DECREF(a);
3118 Py_DECREF(b);
3119 Py_XDECREF(c);
3120 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003121 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003122}
3123
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003124static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003125long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003126{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003127 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003128 PyLongObject *x;
3129 PyLongObject *w;
3130 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003131 if (w == NULL)
3132 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003133 x = (PyLongObject *) long_add(v, w);
3134 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003135 if (x == NULL)
3136 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00003137 Py_SIZE(x) = -(Py_SIZE(x));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003138 return (PyObject *)x;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003139}
3140
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003141static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003142long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003143{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003144 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00003145 if (v->ob_size == 0 && PyLong_CheckExact(v)) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003146 /* -0 == 0 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003147 Py_INCREF(v);
3148 return (PyObject *) v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003149 }
Tim Peters69c2de32001-09-11 22:31:33 +00003150 z = (PyLongObject *)_PyLong_Copy(v);
3151 if (z != NULL)
3152 z->ob_size = -(v->ob_size);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003153 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003154}
3155
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003156static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003157long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003158{
3159 if (v->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003160 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003161 else
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003162 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003163}
3164
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003165static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003166long_nonzero(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003167{
Christian Heimese93237d2007-12-19 02:37:44 +00003168 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003169}
3170
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003171static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003172long_rshift(PyLongObject *v, PyLongObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003173{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003174 PyLongObject *a, *b;
3175 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003176 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003177 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003178 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003179
Neil Schemenauerba872e22001-01-04 01:46:03 +00003180 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
3181
Christian Heimese93237d2007-12-19 02:37:44 +00003182 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003183 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003184 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003185 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003186 if (a1 == NULL)
3187 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003188 a2 = (PyLongObject *) long_rshift(a1, b);
3189 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003190 if (a2 == NULL)
3191 goto rshift_error;
3192 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003193 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003194 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003195 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003196
Neil Schemenauerba872e22001-01-04 01:46:03 +00003197 shiftby = PyLong_AsLong((PyObject *)b);
3198 if (shiftby == -1L && PyErr_Occurred())
3199 goto rshift_error;
3200 if (shiftby < 0) {
3201 PyErr_SetString(PyExc_ValueError,
3202 "negative shift count");
3203 goto rshift_error;
3204 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003205 wordshift = shiftby / PyLong_SHIFT;
Christian Heimese93237d2007-12-19 02:37:44 +00003206 newsize = ABS(Py_SIZE(a)) - wordshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003207 if (newsize <= 0) {
3208 z = _PyLong_New(0);
3209 Py_DECREF(a);
3210 Py_DECREF(b);
3211 return (PyObject *)z;
3212 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003213 loshift = shiftby % PyLong_SHIFT;
3214 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003215 lomask = ((digit)1 << hishift) - 1;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003216 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003217 z = _PyLong_New(newsize);
3218 if (z == NULL)
3219 goto rshift_error;
Christian Heimese93237d2007-12-19 02:37:44 +00003220 if (Py_SIZE(a) < 0)
3221 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003222 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3223 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3224 if (i+1 < newsize)
3225 z->ob_digit[i] |=
3226 (a->ob_digit[j+1] << hishift) & himask;
3227 }
3228 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003229 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003230rshift_error:
3231 Py_DECREF(a);
3232 Py_DECREF(b);
3233 return (PyObject *) z;
3234
Guido van Rossumc6913e71991-11-19 20:26:46 +00003235}
3236
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003237static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003238long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003239{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003240 /* This version due to Tim Peters */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003241 PyLongObject *a, *b;
3242 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003243 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003244 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003245 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003246
Neil Schemenauerba872e22001-01-04 01:46:03 +00003247 CONVERT_BINOP(v, w, &a, &b);
3248
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003249 shiftby = PyLong_AsLong((PyObject *)b);
3250 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003251 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003252 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003253 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003254 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003255 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003256 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003257 PyErr_SetString(PyExc_ValueError,
3258 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003259 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003260 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003261 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3262 wordshift = (int)shiftby / PyLong_SHIFT;
3263 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003264
3265 oldsize = ABS(a->ob_size);
3266 newsize = oldsize + wordshift;
3267 if (remshift)
3268 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003269 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003270 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003271 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003272 if (a->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003273 z->ob_size = -(z->ob_size);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003274 for (i = 0; i < wordshift; i++)
3275 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003276 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003277 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003278 accum |= (twodigits)a->ob_digit[j] << remshift;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003279 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3280 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003281 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003282 if (remshift)
3283 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003284 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003285 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003286 z = long_normalize(z);
3287lshift_error:
3288 Py_DECREF(a);
3289 Py_DECREF(b);
3290 return (PyObject *) z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003291}
3292
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003293
3294/* Bitwise and/xor/or operations */
3295
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003296static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003297long_bitwise(PyLongObject *a,
3298 int op, /* '&', '|', '^' */
3299 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003300{
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003301 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003302 int negz;
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003303 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003304 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003305 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003306 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003307
Christian Heimese93237d2007-12-19 02:37:44 +00003308 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003309 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003310 if (a == NULL)
3311 return NULL;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003312 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003313 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003314 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003315 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003316 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003317 }
Christian Heimese93237d2007-12-19 02:37:44 +00003318 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003319 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003320 if (b == NULL) {
3321 Py_DECREF(a);
3322 return NULL;
3323 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003324 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003325 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003326 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003327 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003328 maskb = 0;
3329 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003330
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003331 negz = 0;
3332 switch (op) {
3333 case '^':
3334 if (maska != maskb) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003335 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003336 negz = -1;
3337 }
3338 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003339 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003340 if (maska && maskb) {
3341 op = '|';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003342 maska ^= PyLong_MASK;
3343 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003344 negz = -1;
3345 }
3346 break;
3347 case '|':
3348 if (maska || maskb) {
3349 op = '&';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003350 maska ^= PyLong_MASK;
3351 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003352 negz = -1;
3353 }
3354 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003355 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003356
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003357 /* JRH: The original logic here was to allocate the result value (z)
3358 as the longer of the two operands. However, there are some cases
3359 where the result is guaranteed to be shorter than that: AND of two
3360 positives, OR of two negatives: use the shorter number. AND with
3361 mixed signs: use the positive number. OR with mixed signs: use the
3362 negative number. After the transformations above, op will be '&'
3363 iff one of these cases applies, and mask will be non-0 for operands
3364 whose length should be ignored.
3365 */
3366
Christian Heimese93237d2007-12-19 02:37:44 +00003367 size_a = Py_SIZE(a);
3368 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003369 size_z = op == '&'
3370 ? (maska
3371 ? size_b
3372 : (maskb ? size_a : MIN(size_a, size_b)))
3373 : MAX(size_a, size_b);
3374 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003375 if (z == NULL) {
Neal Norwitzef02b9e2006-07-16 02:00:32 +00003376 Py_DECREF(a);
3377 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003378 return NULL;
3379 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003380
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003381 for (i = 0; i < size_z; ++i) {
3382 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3383 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3384 switch (op) {
3385 case '&': z->ob_digit[i] = diga & digb; break;
3386 case '|': z->ob_digit[i] = diga | digb; break;
3387 case '^': z->ob_digit[i] = diga ^ digb; break;
3388 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003389 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003390
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003391 Py_DECREF(a);
3392 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003393 z = long_normalize(z);
3394 if (negz == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003395 return (PyObject *) z;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003396 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003397 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003398 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003399}
3400
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003401static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003402long_and(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003403{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003404 PyLongObject *a, *b;
3405 PyObject *c;
3406 CONVERT_BINOP(v, w, &a, &b);
3407 c = long_bitwise(a, '&', b);
3408 Py_DECREF(a);
3409 Py_DECREF(b);
3410 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003411}
3412
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003413static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003414long_xor(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003415{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003416 PyLongObject *a, *b;
3417 PyObject *c;
3418 CONVERT_BINOP(v, w, &a, &b);
3419 c = long_bitwise(a, '^', b);
3420 Py_DECREF(a);
3421 Py_DECREF(b);
3422 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003423}
3424
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003425static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003426long_or(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003427{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003428 PyLongObject *a, *b;
3429 PyObject *c;
3430 CONVERT_BINOP(v, w, &a, &b);
3431 c = long_bitwise(a, '|', b);
3432 Py_DECREF(a);
3433 Py_DECREF(b);
3434 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003435}
3436
Guido van Rossum234f9421993-06-17 12:35:49 +00003437static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003438long_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +00003439{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003440 if (PyInt_Check(*pw)) {
Neil Schemenauerba872e22001-01-04 01:46:03 +00003441 *pw = PyLong_FromLong(PyInt_AS_LONG(*pw));
Georg Brandlc02e1312007-04-11 17:16:24 +00003442 if (*pw == NULL)
3443 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003444 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +00003445 return 0;
3446 }
Guido van Rossum1952e382001-09-19 01:25:16 +00003447 else if (PyLong_Check(*pw)) {
3448 Py_INCREF(*pv);
3449 Py_INCREF(*pw);
3450 return 0;
3451 }
Guido van Rossume6eefc21992-08-14 12:06:52 +00003452 return 1; /* Can't do it */
3453}
3454
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003455static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003456long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003457{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003458 if (PyLong_CheckExact(v))
3459 Py_INCREF(v);
3460 else
3461 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003462 return v;
3463}
3464
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003465static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +00003466long_int(PyObject *v)
3467{
3468 long x;
3469 x = PyLong_AsLong(v);
3470 if (PyErr_Occurred()) {
3471 if (PyErr_ExceptionMatches(PyExc_OverflowError)) {
3472 PyErr_Clear();
3473 if (PyLong_CheckExact(v)) {
3474 Py_INCREF(v);
3475 return v;
3476 }
3477 else
3478 return _PyLong_Copy((PyLongObject *)v);
3479 }
3480 else
3481 return NULL;
3482 }
3483 return PyInt_FromLong(x);
3484}
3485
3486static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003487long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003488{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003489 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003490 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003491 if (result == -1.0 && PyErr_Occurred())
3492 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003493 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003494}
3495
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003496static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003497long_oct(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003498{
Eric Smith5e527eb2008-02-10 01:36:53 +00003499 return _PyLong_Format(v, 8, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003500}
3501
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003502static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003503long_hex(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003504{
Eric Smith5e527eb2008-02-10 01:36:53 +00003505 return _PyLong_Format(v, 16, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003506}
Jeremy Hylton938ace62002-07-17 16:30:39 +00003507
3508static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003509long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003510
Tim Peters6d6c1a32001-08-02 04:15:00 +00003511static PyObject *
3512long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3513{
3514 PyObject *x = NULL;
3515 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003516 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003517
Guido van Rossumbef14172001-08-29 15:47:46 +00003518 if (type != &PyLong_Type)
3519 return long_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003520 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:long", kwlist,
3521 &x, &base))
3522 return NULL;
3523 if (x == NULL)
3524 return PyLong_FromLong(0L);
3525 if (base == -909)
3526 return PyNumber_Long(x);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003527 else if (PyString_Check(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003528 /* Since PyLong_FromString doesn't have a length parameter,
3529 * check here for possible NULs in the string. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003530 char *string = PyString_AS_STRING(x);
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003531 if (strlen(string) != (size_t)PyString_Size(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003532 /* create a repr() of the input string,
3533 * just like PyLong_FromString does. */
3534 PyObject *srepr;
3535 srepr = PyObject_Repr(x);
3536 if (srepr == NULL)
3537 return NULL;
3538 PyErr_Format(PyExc_ValueError,
3539 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003540 base, PyString_AS_STRING(srepr));
Georg Brandl00cd8182007-03-06 18:41:12 +00003541 Py_DECREF(srepr);
3542 return NULL;
3543 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003544 return PyLong_FromString(PyString_AS_STRING(x), NULL, base);
Georg Brandl00cd8182007-03-06 18:41:12 +00003545 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003546#ifdef Py_USING_UNICODE
Tim Peters6d6c1a32001-08-02 04:15:00 +00003547 else if (PyUnicode_Check(x))
3548 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3549 PyUnicode_GET_SIZE(x),
3550 base);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003551#endif
Tim Peters6d6c1a32001-08-02 04:15:00 +00003552 else {
3553 PyErr_SetString(PyExc_TypeError,
3554 "long() can't convert non-string with explicit base");
3555 return NULL;
3556 }
3557}
3558
Guido van Rossumbef14172001-08-29 15:47:46 +00003559/* Wimpy, slow approach to tp_new calls for subtypes of long:
3560 first create a regular long from whatever arguments we got,
3561 then allocate a subtype instance and initialize it from
3562 the regular long. The regular long is then thrown away.
3563*/
3564static PyObject *
3565long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3566{
Anthony Baxter377be112006-04-11 06:54:30 +00003567 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003568 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003569
3570 assert(PyType_IsSubtype(type, &PyLong_Type));
3571 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3572 if (tmp == NULL)
3573 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003574 assert(PyLong_CheckExact(tmp));
Christian Heimese93237d2007-12-19 02:37:44 +00003575 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003576 if (n < 0)
3577 n = -n;
Anthony Baxter377be112006-04-11 06:54:30 +00003578 newobj = (PyLongObject *)type->tp_alloc(type, n);
3579 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003580 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003581 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003582 }
Anthony Baxter377be112006-04-11 06:54:30 +00003583 assert(PyLong_Check(newobj));
Christian Heimese93237d2007-12-19 02:37:44 +00003584 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003585 for (i = 0; i < n; i++)
Anthony Baxter377be112006-04-11 06:54:30 +00003586 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003587 Py_DECREF(tmp);
Anthony Baxter377be112006-04-11 06:54:30 +00003588 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003589}
3590
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003591static PyObject *
3592long_getnewargs(PyLongObject *v)
3593{
3594 return Py_BuildValue("(N)", _PyLong_Copy(v));
3595}
3596
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003597static PyObject *
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003598long_get0(PyLongObject *v, void *context) {
3599 return PyLong_FromLong(0L);
3600}
3601
3602static PyObject *
3603long_get1(PyLongObject *v, void *context) {
3604 return PyLong_FromLong(1L);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003605}
3606
Eric Smitha9f7d622008-02-17 19:46:49 +00003607static PyObject *
3608long__format__(PyObject *self, PyObject *args)
3609{
3610 PyObject *format_spec;
3611
3612 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
3613 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00003614 if (PyBytes_Check(format_spec))
Eric Smithdc13b792008-05-30 18:10:04 +00003615 return _PyLong_FormatAdvanced(self,
3616 PyBytes_AS_STRING(format_spec),
3617 PyBytes_GET_SIZE(format_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003618 if (PyUnicode_Check(format_spec)) {
3619 /* Convert format_spec to a str */
Eric Smithdc13b792008-05-30 18:10:04 +00003620 PyObject *result;
3621 PyObject *str_spec = PyObject_Str(format_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003622
Eric Smithdc13b792008-05-30 18:10:04 +00003623 if (str_spec == NULL)
3624 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00003625
Eric Smithdc13b792008-05-30 18:10:04 +00003626 result = _PyLong_FormatAdvanced(self,
3627 PyBytes_AS_STRING(str_spec),
3628 PyBytes_GET_SIZE(str_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003629
Eric Smithdc13b792008-05-30 18:10:04 +00003630 Py_DECREF(str_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003631 return result;
3632 }
3633 PyErr_SetString(PyExc_TypeError, "__format__ requires str or unicode");
3634 return NULL;
3635}
3636
Robert Schuppenies51df0642008-06-01 16:16:17 +00003637static PyObject *
3638long_sizeof(PyLongObject *v)
3639{
3640 Py_ssize_t res;
3641
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003642 res = v->ob_type->tp_basicsize + ABS(Py_SIZE(v))*sizeof(digit);
Robert Schuppenies51df0642008-06-01 16:16:17 +00003643 return PyInt_FromSsize_t(res);
3644}
3645
Mark Dickinson1a707982008-12-17 16:14:37 +00003646static PyObject *
3647long_bit_length(PyLongObject *v)
3648{
3649 PyLongObject *result, *x, *y;
3650 Py_ssize_t ndigits, msd_bits = 0;
3651 digit msd;
3652
3653 assert(v != NULL);
3654 assert(PyLong_Check(v));
3655
3656 ndigits = ABS(Py_SIZE(v));
3657 if (ndigits == 0)
3658 return PyInt_FromLong(0);
3659
3660 msd = v->ob_digit[ndigits-1];
3661 while (msd >= 32) {
3662 msd_bits += 6;
3663 msd >>= 6;
3664 }
3665 msd_bits += (long)(BitLengthTable[msd]);
3666
3667 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
3668 return PyInt_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
3669
3670 /* expression above may overflow; use Python integers instead */
3671 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
3672 if (result == NULL)
3673 return NULL;
3674 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
3675 if (x == NULL)
3676 goto error;
3677 y = (PyLongObject *)long_mul(result, x);
3678 Py_DECREF(x);
3679 if (y == NULL)
3680 goto error;
3681 Py_DECREF(result);
3682 result = y;
3683
3684 x = (PyLongObject *)PyLong_FromLong(msd_bits);
3685 if (x == NULL)
3686 goto error;
3687 y = (PyLongObject *)long_add(result, x);
3688 Py_DECREF(x);
3689 if (y == NULL)
3690 goto error;
3691 Py_DECREF(result);
3692 result = y;
3693
3694 return (PyObject *)result;
3695
3696error:
3697 Py_DECREF(result);
3698 return NULL;
3699}
3700
3701PyDoc_STRVAR(long_bit_length_doc,
3702"long.bit_length() -> int or long\n\
3703\n\
3704Number of bits necessary to represent self in binary.\n\
3705>>> bin(37L)\n\
3706'0b100101'\n\
3707>>> (37L).bit_length()\n\
37086");
3709
Christian Heimes6f341092008-04-18 23:13:07 +00003710#if 0
3711static PyObject *
3712long_is_finite(PyObject *v)
3713{
3714 Py_RETURN_TRUE;
3715}
3716#endif
3717
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003718static PyMethodDef long_methods[] = {
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003719 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
3720 "Returns self, the complex conjugate of any long."},
Mark Dickinson1a707982008-12-17 16:14:37 +00003721 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
3722 long_bit_length_doc},
Christian Heimes6f341092008-04-18 23:13:07 +00003723#if 0
3724 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
3725 "Returns always True."},
3726#endif
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003727 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
3728 "Truncating an Integral returns itself."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003729 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smitha9f7d622008-02-17 19:46:49 +00003730 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Robert Schuppenies51df0642008-06-01 16:16:17 +00003731 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
Georg Brandl7a6de8b2008-06-01 16:42:16 +00003732 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003733 {NULL, NULL} /* sentinel */
3734};
3735
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003736static PyGetSetDef long_getset[] = {
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003737 {"real",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003738 (getter)long_long, (setter)NULL,
3739 "the real part of a complex number",
3740 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003741 {"imag",
3742 (getter)long_get0, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003743 "the imaginary part of a complex number",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003744 NULL},
3745 {"numerator",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003746 (getter)long_long, (setter)NULL,
3747 "the numerator of a rational number in lowest terms",
3748 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003749 {"denominator",
3750 (getter)long_get1, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003751 "the denominator of a rational number in lowest terms",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003752 NULL},
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003753 {NULL} /* Sentinel */
3754};
3755
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003756PyDoc_STRVAR(long_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003757"long(x[, base]) -> integer\n\
3758\n\
3759Convert a string or number to a long integer, if possible. A floating\n\
3760point argument will be truncated towards zero (this does not include a\n\
3761string representation of a floating point number!) When converting a\n\
3762string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003763converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003764
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003765static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00003766 (binaryfunc) long_add, /*nb_add*/
3767 (binaryfunc) long_sub, /*nb_subtract*/
3768 (binaryfunc) long_mul, /*nb_multiply*/
Georg Brandl347b3002006-03-30 11:57:00 +00003769 long_classic_div, /*nb_divide*/
3770 long_mod, /*nb_remainder*/
3771 long_divmod, /*nb_divmod*/
3772 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003773 (unaryfunc) long_neg, /*nb_negative*/
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003774 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003775 (unaryfunc) long_abs, /*tp_absolute*/
3776 (inquiry) long_nonzero, /*tp_nonzero*/
3777 (unaryfunc) long_invert, /*nb_invert*/
Georg Brandl347b3002006-03-30 11:57:00 +00003778 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003779 (binaryfunc) long_rshift, /*nb_rshift*/
Georg Brandl347b3002006-03-30 11:57:00 +00003780 long_and, /*nb_and*/
3781 long_xor, /*nb_xor*/
3782 long_or, /*nb_or*/
3783 long_coerce, /*nb_coerce*/
3784 long_int, /*nb_int*/
3785 long_long, /*nb_long*/
3786 long_float, /*nb_float*/
3787 long_oct, /*nb_oct*/
3788 long_hex, /*nb_hex*/
Guido van Rossum4668b002001-08-08 05:00:18 +00003789 0, /* nb_inplace_add */
3790 0, /* nb_inplace_subtract */
3791 0, /* nb_inplace_multiply */
3792 0, /* nb_inplace_divide */
3793 0, /* nb_inplace_remainder */
3794 0, /* nb_inplace_power */
3795 0, /* nb_inplace_lshift */
3796 0, /* nb_inplace_rshift */
3797 0, /* nb_inplace_and */
3798 0, /* nb_inplace_xor */
3799 0, /* nb_inplace_or */
Georg Brandl347b3002006-03-30 11:57:00 +00003800 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00003801 long_true_divide, /* nb_true_divide */
3802 0, /* nb_inplace_floor_divide */
3803 0, /* nb_inplace_true_divide */
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003804 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003805};
3806
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003807PyTypeObject PyLong_Type = {
3808 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003809 0, /* ob_size */
3810 "long", /* tp_name */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003811 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003812 sizeof(digit), /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003813 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003814 0, /* tp_print */
3815 0, /* tp_getattr */
3816 0, /* tp_setattr */
3817 (cmpfunc)long_compare, /* tp_compare */
Georg Brandl347b3002006-03-30 11:57:00 +00003818 long_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003819 &long_as_number, /* tp_as_number */
3820 0, /* tp_as_sequence */
3821 0, /* tp_as_mapping */
3822 (hashfunc)long_hash, /* tp_hash */
3823 0, /* tp_call */
Georg Brandl347b3002006-03-30 11:57:00 +00003824 long_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003825 PyObject_GenericGetAttr, /* tp_getattro */
3826 0, /* tp_setattro */
3827 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00003828 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003829 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003830 long_doc, /* tp_doc */
3831 0, /* tp_traverse */
3832 0, /* tp_clear */
3833 0, /* tp_richcompare */
3834 0, /* tp_weaklistoffset */
3835 0, /* tp_iter */
3836 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003837 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003838 0, /* tp_members */
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003839 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003840 0, /* tp_base */
3841 0, /* tp_dict */
3842 0, /* tp_descr_get */
3843 0, /* tp_descr_set */
3844 0, /* tp_dictoffset */
3845 0, /* tp_init */
3846 0, /* tp_alloc */
3847 long_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00003848 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003849};
Mark Dickinsonefc82f72009-03-20 15:51:55 +00003850
3851static PyTypeObject Long_InfoType;
3852
3853PyDoc_STRVAR(long_info__doc__,
3854"sys.long_info\n\
3855\n\
3856A struct sequence that holds information about Python's\n\
3857internal representation of integers. The attributes are read only.");
3858
3859static PyStructSequence_Field long_info_fields[] = {
3860 {"bits_per_digit", "size of a digit in bits"},
3861 {"sizeof_digit", "size in bytes of the C type used to "
3862 "represent a digit"},
3863 {NULL, NULL}
3864};
3865
3866static PyStructSequence_Desc long_info_desc = {
3867 "sys.long_info", /* name */
3868 long_info__doc__, /* doc */
3869 long_info_fields, /* fields */
3870 2 /* number of fields */
3871};
3872
3873PyObject *
3874PyLong_GetInfo(void)
3875{
3876 PyObject* long_info;
3877 int field = 0;
3878 long_info = PyStructSequence_New(&Long_InfoType);
3879 if (long_info == NULL)
3880 return NULL;
Mark Dickinson48e3fd22009-04-02 18:39:37 +00003881 PyStructSequence_SET_ITEM(long_info, field++,
3882 PyInt_FromLong(PyLong_SHIFT));
3883 PyStructSequence_SET_ITEM(long_info, field++,
3884 PyInt_FromLong(sizeof(digit)));
Mark Dickinsonefc82f72009-03-20 15:51:55 +00003885 if (PyErr_Occurred()) {
3886 Py_CLEAR(long_info);
3887 return NULL;
3888 }
3889 return long_info;
3890}
3891
3892int
3893_PyLong_Init(void)
3894{
3895 /* initialize long_info */
3896 if (Long_InfoType.tp_name == 0)
3897 PyStructSequence_InitType(&Long_InfoType, &long_info_desc);
3898 return 1;
3899}