blob: f5a63de78188aca91f1d2246ce54c9bd2b9aee58 [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 */
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001582 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001583 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001584 *str = p;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001585 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1586 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001587 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001588 PyErr_SetString(PyExc_ValueError,
1589 "long string too large to convert");
1590 return NULL;
1591 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001592 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001593 z = _PyLong_New(n);
1594 if (z == NULL)
1595 return NULL;
1596 /* Read string from right, and fill in long from left; i.e.,
1597 * from least to most significant in both.
1598 */
1599 accum = 0;
1600 bits_in_accum = 0;
1601 pdigit = z->ob_digit;
1602 while (--p >= start) {
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001603 int k = _PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001604 assert(k >= 0 && k < base);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001605 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001606 bits_in_accum += bits_per_char;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001607 if (bits_in_accum >= PyLong_SHIFT) {
1608 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001609 assert(pdigit - z->ob_digit <= n);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001610 accum >>= PyLong_SHIFT;
1611 bits_in_accum -= PyLong_SHIFT;
1612 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001613 }
1614 }
1615 if (bits_in_accum) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001616 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001617 *pdigit++ = (digit)accum;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00001618 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001619 }
1620 while (pdigit - z->ob_digit < n)
1621 *pdigit++ = 0;
1622 return long_normalize(z);
1623}
1624
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001625PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001626PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001627{
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001628 int sign = 1;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001629 char *start, *orig_str = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 PyLongObject *z;
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001631 PyObject *strobj, *strrepr;
1632 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001633
Guido van Rossum472c04f1996-12-05 21:57:21 +00001634 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001635 PyErr_SetString(PyExc_ValueError,
Fred Drake661ea262000-10-24 19:57:45 +00001636 "long() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001637 return NULL;
1638 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001639 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001640 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001641 if (*str == '+')
1642 ++str;
1643 else if (*str == '-') {
1644 ++str;
1645 sign = -1;
1646 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001647 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001648 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001649 if (base == 0) {
Eric Smith9ff19b52008-03-17 17:32:20 +00001650 /* No base given. Deduce the base from the contents
1651 of the string */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001652 if (str[0] != '0')
1653 base = 10;
1654 else if (str[1] == 'x' || str[1] == 'X')
1655 base = 16;
Eric Smith9ff19b52008-03-17 17:32:20 +00001656 else if (str[1] == 'o' || str[1] == 'O')
1657 base = 8;
1658 else if (str[1] == 'b' || str[1] == 'B')
1659 base = 2;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001660 else
Eric Smith9ff19b52008-03-17 17:32:20 +00001661 /* "old" (C-style) octal literal, still valid in
1662 2.x, although illegal in 3.x */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001663 base = 8;
1664 }
Eric Smith9ff19b52008-03-17 17:32:20 +00001665 /* Whether or not we were deducing the base, skip leading chars
1666 as needed */
1667 if (str[0] == '0' &&
1668 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1669 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1670 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001671 str += 2;
Tim Peters696cf432006-05-24 21:10:40 +00001672
Guido van Rossume6762971998-06-22 03:54:46 +00001673 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00001674 if ((base & (base - 1)) == 0)
1675 z = long_from_binary_base(&str, base);
1676 else {
Tim Peters696cf432006-05-24 21:10:40 +00001677/***
1678Binary bases can be converted in time linear in the number of digits, because
1679Python's representation base is binary. Other bases (including decimal!) use
1680the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001681
Tim Peters696cf432006-05-24 21:10:40 +00001682First some math: the largest integer that can be expressed in N base-B digits
1683is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1684case number of Python digits needed to hold it is the smallest integer n s.t.
1685
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001686 PyLong_BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1687 PyLong_BASE**n >= B**N [taking logs to base PyLong_BASE]
1688 n >= log(B**N)/log(PyLong_BASE) = N * log(B)/log(PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001689
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001690The static array log_base_PyLong_BASE[base] == log(base)/log(PyLong_BASE) so we can compute
Tim Peters696cf432006-05-24 21:10:40 +00001691this quickly. A Python long with that much space is reserved near the start,
1692and the result is computed into it.
1693
1694The input string is actually treated as being in base base**i (i.e., i digits
1695are processed at a time), where two more static arrays hold:
1696
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001697 convwidth_base[base] = the largest integer i such that base**i <= PyLong_BASE
Tim Peters696cf432006-05-24 21:10:40 +00001698 convmultmax_base[base] = base ** convwidth_base[base]
1699
1700The first of these is the largest i such that i consecutive input digits
1701must fit in a single Python digit. The second is effectively the input
1702base we're really using.
1703
1704Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1705convmultmax_base[base], the result is "simply"
1706
1707 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1708
1709where B = convmultmax_base[base].
Tim Peters9faa3ed2006-05-30 15:53:34 +00001710
1711Error analysis: as above, the number of Python digits `n` needed is worst-
1712case
1713
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001714 n >= N * log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001715
1716where `N` is the number of input digits in base `B`. This is computed via
1717
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001718 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001719
1720below. Two numeric concerns are how much space this can waste, and whether
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001721the computed result can be too small. To be concrete, assume PyLong_BASE = 2**15,
Tim Peters9faa3ed2006-05-30 15:53:34 +00001722which is the default (and it's unlikely anyone changes that).
1723
1724Waste isn't a problem: provided the first input digit isn't 0, the difference
1725between the worst-case input with N digits and the smallest input with N
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001726digits is about a factor of B, but B is small compared to PyLong_BASE so at most
Tim Peters9faa3ed2006-05-30 15:53:34 +00001727one allocated Python digit can remain unused on that count. If
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001728N*log(B)/log(PyLong_BASE) is mathematically an exact integer, then truncating that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001729and adding 1 returns a result 1 larger than necessary. However, that can't
1730happen: whenever B is a power of 2, long_from_binary_base() is called
1731instead, and it's impossible for B**i to be an integer power of 2**15 when
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001732B 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 +00001733an exact integer when B is not a power of 2, since B**i has a prime factor
1734other than 2 in that case, but (2**15)**j's only prime factor is 2).
1735
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001736The computed result can be too small if the true value of N*log(B)/log(PyLong_BASE)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001737is a little bit larger than an exact integer, but due to roundoff errors (in
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001738computing log(B), log(PyLong_BASE), their quotient, and/or multiplying that by N)
Tim Peters9faa3ed2006-05-30 15:53:34 +00001739yields a numeric result a little less than that integer. Unfortunately, "how
1740close can a transcendental function get to an integer over some range?"
1741questions are generally theoretically intractable. Computer analysis via
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001742continued fractions is practical: expand log(B)/log(PyLong_BASE) via continued
Tim Peters9faa3ed2006-05-30 15:53:34 +00001743fractions, giving a sequence i/j of "the best" rational approximations. Then
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001744j*log(B)/log(PyLong_BASE) is approximately equal to (the integer) i. This shows that
Tim Peters9faa3ed2006-05-30 15:53:34 +00001745we can get very close to being in trouble, but very rarely. For example,
174676573 is a denominator in one of the continued-fraction approximations to
1747log(10)/log(2**15), and indeed:
1748
1749 >>> log(10)/log(2**15)*76573
1750 16958.000000654003
1751
1752is very close to an integer. If we were working with IEEE single-precision,
1753rounding errors could kill us. Finding worst cases in IEEE double-precision
1754requires better-than-double-precision log() functions, and Tim didn't bother.
1755Instead the code checks to see whether the allocated space is enough as each
1756new Python digit is added, and copies the whole thing to a larger long if not.
1757This should happen extremely rarely, and in fact I don't have a test case
1758that triggers it(!). Instead the code was tested by artificially allocating
1759just 1 digit at the start, so that the copying code was exercised for every
1760digit beyond the first.
Tim Peters696cf432006-05-24 21:10:40 +00001761***/
1762 register twodigits c; /* current input character */
1763 Py_ssize_t size_z;
1764 int i;
1765 int convwidth;
1766 twodigits convmultmax, convmult;
1767 digit *pz, *pzstop;
1768 char* scan;
1769
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001770 static double log_base_PyLong_BASE[37] = {0.0e0,};
Tim Peters696cf432006-05-24 21:10:40 +00001771 static int convwidth_base[37] = {0,};
1772 static twodigits convmultmax_base[37] = {0,};
1773
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001774 if (log_base_PyLong_BASE[base] == 0.0) {
Tim Peters696cf432006-05-24 21:10:40 +00001775 twodigits convmax = base;
1776 int i = 1;
1777
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001778 log_base_PyLong_BASE[base] = log((double)base) /
1779 log((double)PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001780 for (;;) {
1781 twodigits next = convmax * base;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001782 if (next > PyLong_BASE)
Tim Peters696cf432006-05-24 21:10:40 +00001783 break;
1784 convmax = next;
1785 ++i;
1786 }
1787 convmultmax_base[base] = convmax;
1788 assert(i > 0);
1789 convwidth_base[base] = i;
1790 }
1791
1792 /* Find length of the string of numeric characters. */
1793 scan = str;
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001794 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Tim Peters696cf432006-05-24 21:10:40 +00001795 ++scan;
1796
1797 /* Create a long object that can contain the largest possible
1798 * integer with this base and length. Note that there's no
1799 * need to initialize z->ob_digit -- no slot is read up before
1800 * being stored into.
1801 */
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001802 size_z = (Py_ssize_t)((scan - str) * log_base_PyLong_BASE[base]) + 1;
Tim Peters9faa3ed2006-05-30 15:53:34 +00001803 /* Uncomment next line to test exceedingly rare copy code */
1804 /* size_z = 1; */
Tim Peters696cf432006-05-24 21:10:40 +00001805 assert(size_z > 0);
1806 z = _PyLong_New(size_z);
1807 if (z == NULL)
1808 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00001809 Py_SIZE(z) = 0;
Tim Peters696cf432006-05-24 21:10:40 +00001810
1811 /* `convwidth` consecutive input digits are treated as a single
1812 * digit in base `convmultmax`.
1813 */
1814 convwidth = convwidth_base[base];
1815 convmultmax = convmultmax_base[base];
1816
1817 /* Work ;-) */
1818 while (str < scan) {
1819 /* grab up to convwidth digits from the input string */
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001820 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Tim Peters696cf432006-05-24 21:10:40 +00001821 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
1822 c = (twodigits)(c * base +
Neal Norwitzd183bdd2008-03-28 04:58:51 +00001823 _PyLong_DigitValue[Py_CHARMASK(*str)]);
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001824 assert(c < PyLong_BASE);
Tim Peters696cf432006-05-24 21:10:40 +00001825 }
1826
1827 convmult = convmultmax;
1828 /* Calculate the shift only if we couldn't get
1829 * convwidth digits.
1830 */
1831 if (i != convwidth) {
1832 convmult = base;
1833 for ( ; i > 1; --i)
1834 convmult *= base;
1835 }
1836
1837 /* Multiply z by convmult, and add c. */
1838 pz = z->ob_digit;
Christian Heimese93237d2007-12-19 02:37:44 +00001839 pzstop = pz + Py_SIZE(z);
Tim Peters696cf432006-05-24 21:10:40 +00001840 for (; pz < pzstop; ++pz) {
1841 c += (twodigits)*pz * convmult;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001842 *pz = (digit)(c & PyLong_MASK);
1843 c >>= PyLong_SHIFT;
Tim Peters696cf432006-05-24 21:10:40 +00001844 }
1845 /* carry off the current end? */
1846 if (c) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00001847 assert(c < PyLong_BASE);
Christian Heimese93237d2007-12-19 02:37:44 +00001848 if (Py_SIZE(z) < size_z) {
Tim Peters9faa3ed2006-05-30 15:53:34 +00001849 *pz = (digit)c;
Christian Heimese93237d2007-12-19 02:37:44 +00001850 ++Py_SIZE(z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001851 }
1852 else {
1853 PyLongObject *tmp;
1854 /* Extremely rare. Get more space. */
Christian Heimese93237d2007-12-19 02:37:44 +00001855 assert(Py_SIZE(z) == size_z);
Tim Peters9faa3ed2006-05-30 15:53:34 +00001856 tmp = _PyLong_New(size_z + 1);
1857 if (tmp == NULL) {
1858 Py_DECREF(z);
1859 return NULL;
1860 }
1861 memcpy(tmp->ob_digit,
1862 z->ob_digit,
1863 sizeof(digit) * size_z);
1864 Py_DECREF(z);
1865 z = tmp;
1866 z->ob_digit[size_z] = (digit)c;
1867 ++size_z;
1868 }
Tim Peters696cf432006-05-24 21:10:40 +00001869 }
Tim Petersbf2674b2003-02-02 07:51:32 +00001870 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001871 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00001872 if (z == NULL)
1873 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001874 if (str == start)
1875 goto onError;
Tim Peters696cf432006-05-24 21:10:40 +00001876 if (sign < 0)
Christian Heimese93237d2007-12-19 02:37:44 +00001877 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001878 if (*str == 'L' || *str == 'l')
1879 str++;
1880 while (*str && isspace(Py_CHARMASK(*str)))
1881 str++;
1882 if (*str != '\0')
1883 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001884 if (pend)
1885 *pend = str;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001886 return (PyObject *) z;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001887
1888 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00001889 Py_XDECREF(z);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001890 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001891 strobj = PyString_FromStringAndSize(orig_str, slen);
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001892 if (strobj == NULL)
1893 return NULL;
1894 strrepr = PyObject_Repr(strobj);
1895 Py_DECREF(strobj);
1896 if (strrepr == NULL)
1897 return NULL;
1898 PyErr_Format(PyExc_ValueError,
1899 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001900 base, PyString_AS_STRING(strrepr));
Thomas Wouters9cb28bea2006-04-11 23:50:33 +00001901 Py_DECREF(strrepr);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001902 return NULL;
1903}
1904
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001905#ifdef Py_USING_UNICODE
Guido van Rossum9e896b32000-04-05 20:11:21 +00001906PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001907PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00001908{
Walter Dörwald07e14762002-11-06 16:15:14 +00001909 PyObject *result;
Anthony Baxter377be112006-04-11 06:54:30 +00001910 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001911
Walter Dörwald07e14762002-11-06 16:15:14 +00001912 if (buffer == NULL)
1913 return NULL;
1914
1915 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
1916 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001917 return NULL;
1918 }
Walter Dörwald07e14762002-11-06 16:15:14 +00001919 result = PyLong_FromString(buffer, NULL, base);
1920 PyMem_FREE(buffer);
1921 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001922}
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001923#endif
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001924
Tim Peters9f688bf2000-07-07 15:53:28 +00001925/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001926static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00001927 (PyLongObject *, PyLongObject *, PyLongObject **);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00001928static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001929
1930/* Long division with remainder, top-level routine */
1931
Guido van Rossume32e0141992-01-19 16:31:05 +00001932static int
Tim Peters9f688bf2000-07-07 15:53:28 +00001933long_divrem(PyLongObject *a, PyLongObject *b,
1934 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001935{
Christian Heimese93237d2007-12-19 02:37:44 +00001936 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001937 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001938
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001939 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001940 PyErr_SetString(PyExc_ZeroDivisionError,
Fred Drake661ea262000-10-24 19:57:45 +00001941 "long division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00001942 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001943 }
1944 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00001945 (size_a == size_b &&
1946 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001947 /* |a| < |b|. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001948 *pdiv = _PyLong_New(0);
Georg Brandlc02e1312007-04-11 17:16:24 +00001949 if (*pdiv == NULL)
1950 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001951 Py_INCREF(a);
1952 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00001953 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001954 }
1955 if (size_b == 1) {
1956 digit rem = 0;
1957 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00001958 if (z == NULL)
1959 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001960 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Georg Brandlc02e1312007-04-11 17:16:24 +00001961 if (*prem == NULL) {
1962 Py_DECREF(z);
1963 return -1;
1964 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001965 }
Guido van Rossume32e0141992-01-19 16:31:05 +00001966 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001967 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00001968 if (z == NULL)
1969 return -1;
1970 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001971 /* Set the signs.
1972 The quotient z has the sign of a*b;
1973 the remainder r has the sign of a,
1974 so a = b*z + r. */
Guido van Rossume32e0141992-01-19 16:31:05 +00001975 if ((a->ob_size < 0) != (b->ob_size < 0))
1976 z->ob_size = -(z->ob_size);
1977 if (a->ob_size < 0 && (*prem)->ob_size != 0)
1978 (*prem)->ob_size = -((*prem)->ob_size);
1979 *pdiv = z;
1980 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001981}
1982
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001983/* Unsigned long division with remainder -- the algorithm. The arguments v1
1984 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001985
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001986static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001987x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001988{
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001989 PyLongObject *v, *w, *a;
1990 Py_ssize_t i, k, size_v, size_w;
1991 int d;
1992 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
1993 twodigits vv;
1994 sdigit zhi;
1995 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001996
Mark Dickinson0b666bf2009-03-23 18:25:13 +00001997 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
1998 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
1999 handle the special case when the initial estimate q for a quotient
2000 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2001 that won't overflow a digit. */
2002
2003 /* allocate space; w will also be used to hold the final remainder */
2004 size_v = ABS(Py_SIZE(v1));
2005 size_w = ABS(Py_SIZE(w1));
2006 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2007 v = _PyLong_New(size_v+1);
2008 if (v == NULL) {
2009 *prem = NULL;
2010 return NULL;
2011 }
2012 w = _PyLong_New(size_w);
2013 if (w == NULL) {
2014 Py_DECREF(v);
2015 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002016 return NULL;
2017 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002018
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002019 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2020 shift v1 left by the same amount. Results go into w and v. */
2021 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2022 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2023 assert(carry == 0);
2024 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2025 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2026 v->ob_digit[size_v] = carry;
2027 size_v++;
2028 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002029
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002030 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2031 at most (and usually exactly) k = size_v - size_w digits. */
Neal Norwitzc6a989a2006-05-10 06:57:58 +00002032 k = size_v - size_w;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002033 assert(k >= 0);
2034 a = _PyLong_New(k);
2035 if (a == NULL) {
2036 Py_DECREF(w);
2037 Py_DECREF(v);
2038 *prem = NULL;
2039 return NULL;
2040 }
2041 v0 = v->ob_digit;
2042 w0 = w->ob_digit;
2043 wm1 = w0[size_w-1];
2044 wm2 = w0[size_w-2];
2045 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2046 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2047 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002048
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002049 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002050 Py_DECREF(a);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002051 Py_DECREF(w);
2052 Py_DECREF(v);
2053 *prem = NULL;
2054 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002055 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002056
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002057 /* estimate quotient digit q; may overestimate by 1 (rare) */
2058 vtop = vk[size_w];
2059 assert(vtop <= wm1);
2060 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2061 q = (digit)(vv / wm1);
2062 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2063 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2064 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002065 --q;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002066 r += wm1;
2067 if (r >= PyLong_BASE)
2068 break;
2069 }
2070 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002071
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002072 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2073 zhi = 0;
2074 for (i = 0; i < size_w; ++i) {
2075 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2076 -PyLong_BASE * q <= z < PyLong_BASE */
2077 z = (sdigit)vk[i] + zhi -
2078 (stwodigits)q * (stwodigits)w0[i];
2079 vk[i] = (digit)z & PyLong_MASK;
2080 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2081 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002082 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002083
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002084 /* add w back if q was too large (this branch taken rarely) */
2085 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2086 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002087 carry = 0;
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002088 for (i = 0; i < size_w; ++i) {
2089 carry += vk[i] + w0[i];
2090 vk[i] = carry & PyLong_MASK;
2091 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002092 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002093 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002094 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002095
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002096 /* store quotient digit */
2097 assert(q < PyLong_BASE);
2098 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002099 }
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002100
2101 /* unshift remainder; we reuse w to store the result */
2102 carry = v_rshift(w0, v0, size_w, d);
2103 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002104 Py_DECREF(v);
Mark Dickinson0b666bf2009-03-23 18:25:13 +00002105
2106 *prem = long_normalize(w);
2107 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002108}
2109
2110/* Methods */
2111
2112static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002113long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002114{
Christian Heimese93237d2007-12-19 02:37:44 +00002115 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002116}
2117
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002118static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002119long_repr(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002120{
Eric Smith5e527eb2008-02-10 01:36:53 +00002121 return _PyLong_Format(v, 10, 1, 0);
Fred Drake121ee271999-12-23 15:41:28 +00002122}
2123
2124static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002125long_str(PyObject *v)
Fred Drake121ee271999-12-23 15:41:28 +00002126{
Eric Smith5e527eb2008-02-10 01:36:53 +00002127 return _PyLong_Format(v, 10, 0, 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002128}
2129
2130static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002131long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002132{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002133 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002134
Christian Heimese93237d2007-12-19 02:37:44 +00002135 if (Py_SIZE(a) != Py_SIZE(b)) {
2136 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002137 sign = 0;
2138 else
Christian Heimese93237d2007-12-19 02:37:44 +00002139 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002140 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002141 else {
Christian Heimese93237d2007-12-19 02:37:44 +00002142 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002143 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2144 ;
2145 if (i < 0)
2146 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002147 else {
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00002148 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimese93237d2007-12-19 02:37:44 +00002149 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002150 sign = -sign;
2151 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002152 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002153 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002154}
2155
Guido van Rossum9bfef441993-03-29 10:43:31 +00002156static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002157long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002158{
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002159 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002160 Py_ssize_t i;
2161 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002162
2163 /* This is designed so that Python ints and longs with the
2164 same value hash to the same value, otherwise comparisons
2165 of mapping keys will turn out weird */
2166 i = v->ob_size;
2167 sign = 1;
2168 x = 0;
2169 if (i < 0) {
2170 sign = -1;
2171 i = -(i);
2172 }
Mark Dickinsona0eae032009-01-26 21:40:08 +00002173 /* The following loop produces a C unsigned long x such that x is
2174 congruent to the absolute value of v modulo ULONG_MAX. The
2175 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002176 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002177 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002178 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002179 x += v->ob_digit[i];
Mark Dickinson6ffa4a22009-01-26 21:36:30 +00002180 /* If the addition above overflowed we compensate by
2181 incrementing. This preserves the value modulo
2182 ULONG_MAX. */
2183 if (x < v->ob_digit[i])
Facundo Batistad544df72007-09-19 15:10:06 +00002184 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002185 }
2186 x = x * sign;
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00002187 if (x == (unsigned long)-1)
2188 x = (unsigned long)-2;
2189 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002190}
2191
2192
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002193/* Add the absolute values of two long integers. */
2194
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002195static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002196x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002197{
Christian Heimese93237d2007-12-19 02:37:44 +00002198 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002199 PyLongObject *z;
Mark Dickinsonff84aa82009-01-24 15:27:44 +00002200 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002201 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002202
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002203 /* Ensure a is the larger of the two: */
2204 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002205 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002206 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002207 size_a = size_b;
2208 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002209 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002210 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002211 if (z == NULL)
2212 return NULL;
2213 for (i = 0; i < size_b; ++i) {
2214 carry += a->ob_digit[i] + b->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002215 z->ob_digit[i] = carry & PyLong_MASK;
2216 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002217 }
2218 for (; i < size_a; ++i) {
2219 carry += a->ob_digit[i];
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002220 z->ob_digit[i] = carry & PyLong_MASK;
2221 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002222 }
2223 z->ob_digit[i] = carry;
2224 return long_normalize(z);
2225}
2226
2227/* Subtract the absolute values of two integers. */
2228
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002229static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002230x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002231{
Christian Heimese93237d2007-12-19 02:37:44 +00002232 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002233 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002234 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002235 int sign = 1;
2236 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002237
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002238 /* Ensure a is the larger of the two: */
2239 if (size_a < size_b) {
2240 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002241 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002242 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002243 size_a = size_b;
2244 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002245 }
2246 else if (size_a == size_b) {
2247 /* Find highest digit where a and b differ: */
2248 i = size_a;
2249 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2250 ;
2251 if (i < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002252 return _PyLong_New(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002253 if (a->ob_digit[i] < b->ob_digit[i]) {
2254 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002255 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002256 }
2257 size_a = size_b = i+1;
2258 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002259 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002260 if (z == NULL)
2261 return NULL;
2262 for (i = 0; i < size_b; ++i) {
2263 /* The following assumes unsigned arithmetic
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002264 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002265 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002266 z->ob_digit[i] = borrow & PyLong_MASK;
2267 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002268 borrow &= 1; /* Keep only one sign bit */
2269 }
2270 for (; i < size_a; ++i) {
2271 borrow = a->ob_digit[i] - borrow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002272 z->ob_digit[i] = borrow & PyLong_MASK;
2273 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002274 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002275 }
2276 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002277 if (sign < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002278 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002279 return long_normalize(z);
2280}
2281
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002282static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002283long_add(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002284{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002285 PyLongObject *a, *b, *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002286
Neil Schemenauerba872e22001-01-04 01:46:03 +00002287 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2288
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002289 if (a->ob_size < 0) {
2290 if (b->ob_size < 0) {
2291 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002292 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002293 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002294 }
2295 else
2296 z = x_sub(b, a);
2297 }
2298 else {
2299 if (b->ob_size < 0)
2300 z = x_sub(a, b);
2301 else
2302 z = x_add(a, b);
2303 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002304 Py_DECREF(a);
2305 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002306 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002307}
2308
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002309static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002310long_sub(PyLongObject *v, PyLongObject *w)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002311{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002312 PyLongObject *a, *b, *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002313
Neil Schemenauerba872e22001-01-04 01:46:03 +00002314 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
2315
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002316 if (a->ob_size < 0) {
2317 if (b->ob_size < 0)
2318 z = x_sub(a, b);
2319 else
2320 z = x_add(a, b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002321 if (z != NULL && z->ob_size != 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002322 z->ob_size = -(z->ob_size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002323 }
2324 else {
2325 if (b->ob_size < 0)
2326 z = x_add(a, b);
2327 else
2328 z = x_sub(a, b);
2329 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002330 Py_DECREF(a);
2331 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002332 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002333}
2334
Tim Peters5af4e6c2002-08-12 02:31:19 +00002335/* Grade school multiplication, ignoring the signs.
2336 * Returns the absolute value of the product, or NULL if error.
2337 */
2338static PyLongObject *
2339x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002340{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002341 PyLongObject *z;
Christian Heimese93237d2007-12-19 02:37:44 +00002342 Py_ssize_t size_a = ABS(Py_SIZE(a));
2343 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002344 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002345
Tim Peters5af4e6c2002-08-12 02:31:19 +00002346 z = _PyLong_New(size_a + size_b);
2347 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002348 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002349
Christian Heimese93237d2007-12-19 02:37:44 +00002350 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002351 if (a == b) {
2352 /* Efficient squaring per HAC, Algorithm 14.16:
2353 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2354 * Gives slightly less than a 2x speedup when a == b,
2355 * via exploiting that each entry in the multiplication
2356 * pyramid appears twice (except for the size_a squares).
2357 */
2358 for (i = 0; i < size_a; ++i) {
2359 twodigits carry;
2360 twodigits f = a->ob_digit[i];
2361 digit *pz = z->ob_digit + (i << 1);
2362 digit *pa = a->ob_digit + i + 1;
2363 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002364
Tim Peters0973b992004-08-29 22:16:50 +00002365 SIGCHECK({
2366 Py_DECREF(z);
2367 return NULL;
2368 })
2369
2370 carry = *pz + f * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002371 *pz++ = (digit)(carry & PyLong_MASK);
2372 carry >>= PyLong_SHIFT;
2373 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002374
2375 /* Now f is added in twice in each column of the
2376 * pyramid it appears. Same as adding f<<1 once.
2377 */
2378 f <<= 1;
2379 while (pa < paend) {
2380 carry += *pz + *pa++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002381 *pz++ = (digit)(carry & PyLong_MASK);
2382 carry >>= PyLong_SHIFT;
2383 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002384 }
2385 if (carry) {
2386 carry += *pz;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002387 *pz++ = (digit)(carry & PyLong_MASK);
2388 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002389 }
2390 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002391 *pz += (digit)(carry & PyLong_MASK);
2392 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002393 }
Tim Peters0973b992004-08-29 22:16:50 +00002394 }
2395 else { /* a is not the same as b -- gradeschool long mult */
2396 for (i = 0; i < size_a; ++i) {
2397 twodigits carry = 0;
2398 twodigits f = a->ob_digit[i];
2399 digit *pz = z->ob_digit + i;
2400 digit *pb = b->ob_digit;
2401 digit *pbend = b->ob_digit + size_b;
2402
2403 SIGCHECK({
2404 Py_DECREF(z);
2405 return NULL;
2406 })
2407
2408 while (pb < pbend) {
2409 carry += *pz + *pb++ * f;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002410 *pz++ = (digit)(carry & PyLong_MASK);
2411 carry >>= PyLong_SHIFT;
2412 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002413 }
2414 if (carry)
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002415 *pz += (digit)(carry & PyLong_MASK);
2416 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002417 }
2418 }
Tim Peters44121a62002-08-12 06:17:58 +00002419 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002420}
2421
2422/* A helper for Karatsuba multiplication (k_mul).
2423 Takes a long "n" and an integer "size" representing the place to
2424 split, and sets low and high such that abs(n) == (high << size) + low,
2425 viewing the shift as being by digits. The sign bit is ignored, and
2426 the return values are >= 0.
2427 Returns 0 on success, -1 on failure.
2428*/
2429static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002430kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002431{
2432 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002433 Py_ssize_t size_lo, size_hi;
Christian Heimese93237d2007-12-19 02:37:44 +00002434 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002435
2436 size_lo = MIN(size_n, size);
2437 size_hi = size_n - size_lo;
2438
2439 if ((hi = _PyLong_New(size_hi)) == NULL)
2440 return -1;
2441 if ((lo = _PyLong_New(size_lo)) == NULL) {
2442 Py_DECREF(hi);
2443 return -1;
2444 }
2445
2446 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2447 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2448
2449 *high = long_normalize(hi);
2450 *low = long_normalize(lo);
2451 return 0;
2452}
2453
Tim Peters60004642002-08-12 22:01:34 +00002454static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2455
Tim Peters5af4e6c2002-08-12 02:31:19 +00002456/* Karatsuba multiplication. Ignores the input signs, and returns the
2457 * absolute value of the product (or NULL if error).
2458 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2459 */
2460static PyLongObject *
2461k_mul(PyLongObject *a, PyLongObject *b)
2462{
Christian Heimese93237d2007-12-19 02:37:44 +00002463 Py_ssize_t asize = ABS(Py_SIZE(a));
2464 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002465 PyLongObject *ah = NULL;
2466 PyLongObject *al = NULL;
2467 PyLongObject *bh = NULL;
2468 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002469 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002470 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002471 Py_ssize_t shift; /* the number of digits we split off */
2472 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002473
Tim Peters5af4e6c2002-08-12 02:31:19 +00002474 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2475 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2476 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002477 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002478 * By picking X to be a power of 2, "*X" is just shifting, and it's
2479 * been reduced to 3 multiplies on numbers half the size.
2480 */
2481
Tim Petersfc07e562002-08-12 02:54:10 +00002482 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002483 * is largest.
2484 */
Tim Peters738eda72002-08-12 15:08:20 +00002485 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002486 t1 = a;
2487 a = b;
2488 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002489
2490 i = asize;
2491 asize = bsize;
2492 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002493 }
2494
2495 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002496 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2497 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002498 if (asize == 0)
Tim Peters44121a62002-08-12 06:17:58 +00002499 return _PyLong_New(0);
2500 else
2501 return x_mul(a, b);
2502 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002503
Tim Peters60004642002-08-12 22:01:34 +00002504 /* If a is small compared to b, splitting on b gives a degenerate
2505 * case with ah==0, and Karatsuba may be (even much) less efficient
2506 * than "grade school" then. However, we can still win, by viewing
2507 * b as a string of "big digits", each of width a->ob_size. That
2508 * leads to a sequence of balanced calls to k_mul.
2509 */
2510 if (2 * asize <= bsize)
2511 return k_lopsided_mul(a, b);
2512
Tim Petersd6974a52002-08-13 20:37:51 +00002513 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002514 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002515 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002516 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002517
Tim Peters0973b992004-08-29 22:16:50 +00002518 if (a == b) {
2519 bh = ah;
2520 bl = al;
2521 Py_INCREF(bh);
2522 Py_INCREF(bl);
2523 }
2524 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002525
Tim Petersd64c1de2002-08-12 17:36:03 +00002526 /* The plan:
2527 * 1. Allocate result space (asize + bsize digits: that's always
2528 * enough).
2529 * 2. Compute ah*bh, and copy into result at 2*shift.
2530 * 3. Compute al*bl, and copy into result at 0. Note that this
2531 * can't overlap with #2.
2532 * 4. Subtract al*bl from the result, starting at shift. This may
2533 * underflow (borrow out of the high digit), but we don't care:
2534 * we're effectively doing unsigned arithmetic mod
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002535 * PyLong_BASE**(sizea + sizeb), and so long as the *final* result fits,
Tim Petersd64c1de2002-08-12 17:36:03 +00002536 * borrows and carries out of the high digit can be ignored.
2537 * 5. Subtract ah*bh from the result, starting at shift.
2538 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2539 * at shift.
2540 */
2541
2542 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002543 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002544 if (ret == NULL) goto fail;
2545#ifdef Py_DEBUG
2546 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002547 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002548#endif
Tim Peters44121a62002-08-12 06:17:58 +00002549
Tim Petersd64c1de2002-08-12 17:36:03 +00002550 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002551 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002552 assert(Py_SIZE(t1) >= 0);
2553 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002554 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimese93237d2007-12-19 02:37:44 +00002555 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002556
2557 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimese93237d2007-12-19 02:37:44 +00002558 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002559 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002560 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002561 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002562
Tim Petersd64c1de2002-08-12 17:36:03 +00002563 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002564 if ((t2 = k_mul(al, bl)) == NULL) {
2565 Py_DECREF(t1);
2566 goto fail;
2567 }
Christian Heimese93237d2007-12-19 02:37:44 +00002568 assert(Py_SIZE(t2) >= 0);
2569 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2570 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002571
2572 /* Zero out remaining digits. */
Christian Heimese93237d2007-12-19 02:37:44 +00002573 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002574 if (i)
Christian Heimese93237d2007-12-19 02:37:44 +00002575 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002576
Tim Petersd64c1de2002-08-12 17:36:03 +00002577 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2578 * because it's fresher in cache.
2579 */
Christian Heimese93237d2007-12-19 02:37:44 +00002580 i = Py_SIZE(ret) - shift; /* # digits after shift */
2581 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002582 Py_DECREF(t2);
2583
Christian Heimese93237d2007-12-19 02:37:44 +00002584 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002585 Py_DECREF(t1);
2586
Tim Petersd64c1de2002-08-12 17:36:03 +00002587 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002588 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2589 Py_DECREF(ah);
2590 Py_DECREF(al);
2591 ah = al = NULL;
2592
Tim Peters0973b992004-08-29 22:16:50 +00002593 if (a == b) {
2594 t2 = t1;
2595 Py_INCREF(t2);
2596 }
2597 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002598 Py_DECREF(t1);
2599 goto fail;
2600 }
2601 Py_DECREF(bh);
2602 Py_DECREF(bl);
2603 bh = bl = NULL;
2604
Tim Peters738eda72002-08-12 15:08:20 +00002605 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002606 Py_DECREF(t1);
2607 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002608 if (t3 == NULL) goto fail;
Christian Heimese93237d2007-12-19 02:37:44 +00002609 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002610
Tim Petersd6974a52002-08-13 20:37:51 +00002611 /* Add t3. It's not obvious why we can't run out of room here.
2612 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002613 */
Christian Heimese93237d2007-12-19 02:37:44 +00002614 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002615 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002616
Tim Peters5af4e6c2002-08-12 02:31:19 +00002617 return long_normalize(ret);
2618
2619 fail:
2620 Py_XDECREF(ret);
2621 Py_XDECREF(ah);
2622 Py_XDECREF(al);
2623 Py_XDECREF(bh);
2624 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002625 return NULL;
2626}
2627
Tim Petersd6974a52002-08-13 20:37:51 +00002628/* (*) Why adding t3 can't "run out of room" above.
2629
Tim Petersab86c2b2002-08-15 20:06:00 +00002630Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
2631to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00002632
Tim Petersab86c2b2002-08-15 20:06:00 +000026331. For any integer i, i = c(i/2) + f(i/2). In particular,
2634 bsize = c(bsize/2) + f(bsize/2).
26352. shift = f(bsize/2)
26363. asize <= bsize
26374. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
2638 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00002639
Tim Petersab86c2b2002-08-15 20:06:00 +00002640We allocated asize + bsize result digits, and add t3 into them at an offset
2641of shift. This leaves asize+bsize-shift allocated digit positions for t3
2642to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
2643asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00002644
Tim Petersab86c2b2002-08-15 20:06:00 +00002645bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
2646at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002647
Tim Petersab86c2b2002-08-15 20:06:00 +00002648If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
2649digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
2650most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002651
Tim Petersab86c2b2002-08-15 20:06:00 +00002652The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00002653
Tim Petersab86c2b2002-08-15 20:06:00 +00002654 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00002655
Tim Petersab86c2b2002-08-15 20:06:00 +00002656and we have asize + c(bsize/2) available digit positions. We need to show
2657this is always enough. An instance of c(bsize/2) cancels out in both, so
2658the question reduces to whether asize digits is enough to hold
2659(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
2660then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
2661asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002662digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00002663asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00002664c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
2665is enough to hold 2 bits. This is so if bsize >= 2, which holds because
2666bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00002667
Tim Peters48d52c02002-08-14 17:07:32 +00002668Note that since there's always enough room for (ah+al)*(bh+bl), and that's
2669clearly >= each of ah*bh and al*bl, there's always enough room to subtract
2670ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00002671*/
2672
Tim Peters60004642002-08-12 22:01:34 +00002673/* b has at least twice the digits of a, and a is big enough that Karatsuba
2674 * would pay off *if* the inputs had balanced sizes. View b as a sequence
2675 * of slices, each with a->ob_size digits, and multiply the slices by a,
2676 * one at a time. This gives k_mul balanced inputs to work with, and is
2677 * also cache-friendly (we compute one double-width slice of the result
2678 * at a time, then move on, never bactracking except for the helpful
2679 * single-width slice overlap between successive partial sums).
2680 */
2681static PyLongObject *
2682k_lopsided_mul(PyLongObject *a, PyLongObject *b)
2683{
Christian Heimese93237d2007-12-19 02:37:44 +00002684 const Py_ssize_t asize = ABS(Py_SIZE(a));
2685 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002686 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00002687 PyLongObject *ret;
2688 PyLongObject *bslice = NULL;
2689
2690 assert(asize > KARATSUBA_CUTOFF);
2691 assert(2 * asize <= bsize);
2692
2693 /* Allocate result space, and zero it out. */
2694 ret = _PyLong_New(asize + bsize);
2695 if (ret == NULL)
2696 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00002697 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00002698
2699 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00002700 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00002701 if (bslice == NULL)
2702 goto fail;
2703
2704 nbdone = 0;
2705 while (bsize > 0) {
2706 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002707 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00002708
2709 /* Multiply the next slice of b by a. */
2710 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
2711 nbtouse * sizeof(digit));
Christian Heimese93237d2007-12-19 02:37:44 +00002712 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00002713 product = k_mul(a, bslice);
2714 if (product == NULL)
2715 goto fail;
2716
2717 /* Add into result. */
Christian Heimese93237d2007-12-19 02:37:44 +00002718 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
2719 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00002720 Py_DECREF(product);
2721
2722 bsize -= nbtouse;
2723 nbdone += nbtouse;
2724 }
2725
2726 Py_DECREF(bslice);
2727 return long_normalize(ret);
2728
2729 fail:
2730 Py_DECREF(ret);
2731 Py_XDECREF(bslice);
2732 return NULL;
2733}
Tim Peters5af4e6c2002-08-12 02:31:19 +00002734
2735static PyObject *
2736long_mul(PyLongObject *v, PyLongObject *w)
2737{
2738 PyLongObject *a, *b, *z;
2739
2740 if (!convert_binop((PyObject *)v, (PyObject *)w, &a, &b)) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002741 Py_INCREF(Py_NotImplemented);
2742 return Py_NotImplemented;
2743 }
2744
Tim Petersd64c1de2002-08-12 17:36:03 +00002745 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00002746 /* Negate if exactly one of the inputs is negative. */
2747 if (((a->ob_size ^ b->ob_size) < 0) && z)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002748 z->ob_size = -(z->ob_size);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002749 Py_DECREF(a);
2750 Py_DECREF(b);
Tim Peters9973d742002-08-15 19:41:06 +00002751 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002752}
2753
Guido van Rossume32e0141992-01-19 16:31:05 +00002754/* The / and % operators are now defined in terms of divmod().
2755 The expression a mod b has the value a - b*floor(a/b).
2756 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002757 |a| by |b|, with the sign of a. This is also expressed
2758 as a - b*trunc(a/b), if trunc truncates towards zero.
2759 Some examples:
2760 a b a rem b a mod b
2761 13 10 3 3
2762 -13 10 -3 7
2763 13 -10 3 -7
2764 -13 -10 -3 -3
2765 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002766 have different signs. We then subtract one from the 'div'
2767 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002768
Tim Peters47e52ee2004-08-30 02:44:38 +00002769/* Compute
2770 * *pdiv, *pmod = divmod(v, w)
2771 * NULL can be passed for pdiv or pmod, in which case that part of
2772 * the result is simply thrown away. The caller owns a reference to
2773 * each of these it requests (does not pass NULL for).
2774 */
Guido van Rossume32e0141992-01-19 16:31:05 +00002775static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00002776l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00002777 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00002778{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002779 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002780
Guido van Rossume32e0141992-01-19 16:31:05 +00002781 if (long_divrem(v, w, &div, &mod) < 0)
2782 return -1;
Christian Heimese93237d2007-12-19 02:37:44 +00002783 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
2784 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002785 PyLongObject *temp;
2786 PyLongObject *one;
2787 temp = (PyLongObject *) long_add(mod, w);
2788 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00002789 mod = temp;
2790 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002791 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002792 return -1;
2793 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002794 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00002795 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002796 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
2797 Py_DECREF(mod);
2798 Py_DECREF(div);
2799 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00002800 return -1;
2801 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002802 Py_DECREF(one);
2803 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00002804 div = temp;
2805 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002806 if (pdiv != NULL)
2807 *pdiv = div;
2808 else
2809 Py_DECREF(div);
2810
2811 if (pmod != NULL)
2812 *pmod = mod;
2813 else
2814 Py_DECREF(mod);
2815
Guido van Rossume32e0141992-01-19 16:31:05 +00002816 return 0;
2817}
2818
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002819static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002820long_div(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00002821{
Tim Peters47e52ee2004-08-30 02:44:38 +00002822 PyLongObject *a, *b, *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002823
2824 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00002825 if (l_divmod(a, b, &div, NULL) < 0)
2826 div = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002827 Py_DECREF(a);
2828 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002829 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00002830}
2831
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002832static PyObject *
Guido van Rossum393661d2001-08-31 17:40:15 +00002833long_classic_div(PyObject *v, PyObject *w)
2834{
Tim Peters47e52ee2004-08-30 02:44:38 +00002835 PyLongObject *a, *b, *div;
Guido van Rossum393661d2001-08-31 17:40:15 +00002836
2837 CONVERT_BINOP(v, w, &a, &b);
Guido van Rossum393661d2001-08-31 17:40:15 +00002838 if (Py_DivisionWarningFlag &&
2839 PyErr_Warn(PyExc_DeprecationWarning, "classic long division") < 0)
2840 div = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00002841 else if (l_divmod(a, b, &div, NULL) < 0)
Guido van Rossum393661d2001-08-31 17:40:15 +00002842 div = NULL;
Guido van Rossum393661d2001-08-31 17:40:15 +00002843 Py_DECREF(a);
2844 Py_DECREF(b);
2845 return (PyObject *)div;
2846}
2847
2848static PyObject *
Tim Peters20dab9f2001-09-04 05:31:47 +00002849long_true_divide(PyObject *v, PyObject *w)
2850{
Tim Peterse2a60002001-09-04 06:17:36 +00002851 PyLongObject *a, *b;
2852 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00002853 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00002854
2855 CONVERT_BINOP(v, w, &a, &b);
2856 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
2857 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00002858 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
2859 Py_DECREF(a);
2860 Py_DECREF(b);
2861 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00002862 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00002863 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
2864 but should really be set correctly after sucessful calls to
2865 _PyLong_AsScaledDouble() */
2866 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00002867
2868 if (bd == 0.0) {
2869 PyErr_SetString(PyExc_ZeroDivisionError,
2870 "long division or modulo by zero");
2871 return NULL;
2872 }
2873
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002874 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00002875 ad /= bd; /* overflow/underflow impossible here */
2876 aexp -= bexp;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002877 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00002878 goto overflow;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002879 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00002880 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00002881 errno = 0;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00002882 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00002883 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00002884 goto overflow;
2885 return PyFloat_FromDouble(ad);
2886
2887overflow:
2888 PyErr_SetString(PyExc_OverflowError,
2889 "long/long too large for a float");
2890 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002891
Tim Peters20dab9f2001-09-04 05:31:47 +00002892}
2893
2894static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002895long_mod(PyObject *v, PyObject *w)
Guido van Rossume32e0141992-01-19 16:31:05 +00002896{
Tim Peters47e52ee2004-08-30 02:44:38 +00002897 PyLongObject *a, *b, *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002898
2899 CONVERT_BINOP(v, w, &a, &b);
2900
Tim Peters47e52ee2004-08-30 02:44:38 +00002901 if (l_divmod(a, b, NULL, &mod) < 0)
2902 mod = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002903 Py_DECREF(a);
2904 Py_DECREF(b);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002905 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00002906}
2907
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002908static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002909long_divmod(PyObject *v, PyObject *w)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002910{
Neil Schemenauerba872e22001-01-04 01:46:03 +00002911 PyLongObject *a, *b, *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002912 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002913
2914 CONVERT_BINOP(v, w, &a, &b);
2915
2916 if (l_divmod(a, b, &div, &mod) < 0) {
2917 Py_DECREF(a);
2918 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002919 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002920 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002921 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002922 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002923 PyTuple_SetItem(z, 0, (PyObject *) div);
2924 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002925 }
2926 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002927 Py_DECREF(div);
2928 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002929 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00002930 Py_DECREF(a);
2931 Py_DECREF(b);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002932 return z;
2933}
2934
Tim Peters47e52ee2004-08-30 02:44:38 +00002935/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002936static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00002937long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002938{
Tim Peters47e52ee2004-08-30 02:44:38 +00002939 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
2940 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00002941
Tim Peters47e52ee2004-08-30 02:44:38 +00002942 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00002943 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00002944 PyLongObject *temp = NULL;
2945
2946 /* 5-ary values. If the exponent is large enough, table is
2947 * precomputed so that table[i] == a**i % c for i in range(32).
2948 */
2949 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
2950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
2951
2952 /* a, b, c = v, w, x */
Neil Schemenauerba872e22001-01-04 01:46:03 +00002953 CONVERT_BINOP(v, w, &a, &b);
Tim Peters47e52ee2004-08-30 02:44:38 +00002954 if (PyLong_Check(x)) {
2955 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002956 Py_INCREF(x);
2957 }
Tim Petersde7990b2005-07-17 23:45:23 +00002958 else if (PyInt_Check(x)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00002959 c = (PyLongObject *)PyLong_FromLong(PyInt_AS_LONG(x));
Tim Petersde7990b2005-07-17 23:45:23 +00002960 if (c == NULL)
2961 goto Error;
2962 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002963 else if (x == Py_None)
2964 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002965 else {
2966 Py_DECREF(a);
2967 Py_DECREF(b);
2968 Py_INCREF(Py_NotImplemented);
2969 return Py_NotImplemented;
2970 }
Tim Peters4c483c42001-09-05 06:24:58 +00002971
Christian Heimese93237d2007-12-19 02:37:44 +00002972 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00002973 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00002974 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00002975 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00002976 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00002977 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00002978 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00002979 /* else return a float. This works because we know
2980 that this calls float_pow() which converts its
2981 arguments to double. */
2982 Py_DECREF(a);
2983 Py_DECREF(b);
2984 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00002985 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002986 }
Tim Peters47e52ee2004-08-30 02:44:38 +00002987
2988 if (c) {
2989 /* if modulus == 0:
2990 raise ValueError() */
Christian Heimese93237d2007-12-19 02:37:44 +00002991 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00002992 PyErr_SetString(PyExc_ValueError,
2993 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00002994 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00002995 }
2996
2997 /* if modulus < 0:
2998 negativeOutput = True
2999 modulus = -modulus */
Christian Heimese93237d2007-12-19 02:37:44 +00003000 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003001 negativeOutput = 1;
3002 temp = (PyLongObject *)_PyLong_Copy(c);
3003 if (temp == NULL)
3004 goto Error;
3005 Py_DECREF(c);
3006 c = temp;
3007 temp = NULL;
3008 c->ob_size = - c->ob_size;
3009 }
3010
3011 /* if modulus == 1:
3012 return 0 */
Christian Heimese93237d2007-12-19 02:37:44 +00003013 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003014 z = (PyLongObject *)PyLong_FromLong(0L);
3015 goto Done;
3016 }
3017
3018 /* if base < 0:
3019 base = base % modulus
3020 Having the base positive just makes things easier. */
Christian Heimese93237d2007-12-19 02:37:44 +00003021 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003022 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003023 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003024 Py_DECREF(a);
3025 a = temp;
3026 temp = NULL;
3027 }
3028 }
3029
3030 /* At this point a, b, and c are guaranteed non-negative UNLESS
3031 c is NULL, in which case a may be negative. */
3032
3033 z = (PyLongObject *)PyLong_FromLong(1L);
3034 if (z == NULL)
3035 goto Error;
3036
3037 /* Perform a modular reduction, X = X % c, but leave X alone if c
3038 * is NULL.
3039 */
3040#define REDUCE(X) \
3041 if (c != NULL) { \
3042 if (l_divmod(X, c, NULL, &temp) < 0) \
3043 goto Error; \
3044 Py_XDECREF(X); \
3045 X = temp; \
3046 temp = NULL; \
3047 }
3048
3049 /* Multiply two values, then reduce the result:
3050 result = X*Y % c. If c is NULL, skip the mod. */
3051#define MULT(X, Y, result) \
3052{ \
3053 temp = (PyLongObject *)long_mul(X, Y); \
3054 if (temp == NULL) \
3055 goto Error; \
3056 Py_XDECREF(result); \
3057 result = temp; \
3058 temp = NULL; \
3059 REDUCE(result) \
3060}
3061
Christian Heimese93237d2007-12-19 02:37:44 +00003062 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003063 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3064 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimese93237d2007-12-19 02:37:44 +00003065 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003066 digit bi = b->ob_digit[i];
3067
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003068 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003069 MULT(z, z, z)
3070 if (bi & j)
3071 MULT(z, a, z)
3072 }
3073 }
3074 }
3075 else {
3076 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3077 Py_INCREF(z); /* still holds 1L */
3078 table[0] = z;
3079 for (i = 1; i < 32; ++i)
3080 MULT(table[i-1], a, table[i])
3081
Christian Heimese93237d2007-12-19 02:37:44 +00003082 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003083 const digit bi = b->ob_digit[i];
3084
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003085 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003086 const int index = (bi >> j) & 0x1f;
3087 for (k = 0; k < 5; ++k)
3088 MULT(z, z, z)
3089 if (index)
3090 MULT(z, table[index], z)
3091 }
3092 }
3093 }
3094
Christian Heimese93237d2007-12-19 02:37:44 +00003095 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003096 temp = (PyLongObject *)long_sub(z, c);
3097 if (temp == NULL)
3098 goto Error;
3099 Py_DECREF(z);
3100 z = temp;
3101 temp = NULL;
3102 }
3103 goto Done;
3104
3105 Error:
3106 if (z != NULL) {
3107 Py_DECREF(z);
3108 z = NULL;
3109 }
3110 /* fall through */
3111 Done:
Christian Heimese93237d2007-12-19 02:37:44 +00003112 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003113 for (i = 0; i < 32; ++i)
3114 Py_XDECREF(table[i]);
3115 }
Tim Petersde7990b2005-07-17 23:45:23 +00003116 Py_DECREF(a);
3117 Py_DECREF(b);
3118 Py_XDECREF(c);
3119 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003120 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003121}
3122
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003123static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003124long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003125{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003126 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003127 PyLongObject *x;
3128 PyLongObject *w;
3129 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003130 if (w == NULL)
3131 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003132 x = (PyLongObject *) long_add(v, w);
3133 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003134 if (x == NULL)
3135 return NULL;
Christian Heimese93237d2007-12-19 02:37:44 +00003136 Py_SIZE(x) = -(Py_SIZE(x));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003137 return (PyObject *)x;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003138}
3139
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003140static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003141long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003142{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003143 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00003144 if (v->ob_size == 0 && PyLong_CheckExact(v)) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003145 /* -0 == 0 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003146 Py_INCREF(v);
3147 return (PyObject *) v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003148 }
Tim Peters69c2de32001-09-11 22:31:33 +00003149 z = (PyLongObject *)_PyLong_Copy(v);
3150 if (z != NULL)
3151 z->ob_size = -(v->ob_size);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003152 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003153}
3154
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003155static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003156long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003157{
3158 if (v->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003159 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003160 else
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003161 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003162}
3163
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003164static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003165long_nonzero(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003166{
Christian Heimese93237d2007-12-19 02:37:44 +00003167 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003168}
3169
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003170static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003171long_rshift(PyLongObject *v, PyLongObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003172{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003173 PyLongObject *a, *b;
3174 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003175 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003176 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003177 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003178
Neil Schemenauerba872e22001-01-04 01:46:03 +00003179 CONVERT_BINOP((PyObject *)v, (PyObject *)w, &a, &b);
3180
Christian Heimese93237d2007-12-19 02:37:44 +00003181 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003182 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003183 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003184 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003185 if (a1 == NULL)
3186 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003187 a2 = (PyLongObject *) long_rshift(a1, b);
3188 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003189 if (a2 == NULL)
3190 goto rshift_error;
3191 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003192 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003193 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003194 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003195
Neil Schemenauerba872e22001-01-04 01:46:03 +00003196 shiftby = PyLong_AsLong((PyObject *)b);
3197 if (shiftby == -1L && PyErr_Occurred())
3198 goto rshift_error;
3199 if (shiftby < 0) {
3200 PyErr_SetString(PyExc_ValueError,
3201 "negative shift count");
3202 goto rshift_error;
3203 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003204 wordshift = shiftby / PyLong_SHIFT;
Christian Heimese93237d2007-12-19 02:37:44 +00003205 newsize = ABS(Py_SIZE(a)) - wordshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003206 if (newsize <= 0) {
3207 z = _PyLong_New(0);
3208 Py_DECREF(a);
3209 Py_DECREF(b);
3210 return (PyObject *)z;
3211 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003212 loshift = shiftby % PyLong_SHIFT;
3213 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003214 lomask = ((digit)1 << hishift) - 1;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003215 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003216 z = _PyLong_New(newsize);
3217 if (z == NULL)
3218 goto rshift_error;
Christian Heimese93237d2007-12-19 02:37:44 +00003219 if (Py_SIZE(a) < 0)
3220 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003221 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3222 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3223 if (i+1 < newsize)
3224 z->ob_digit[i] |=
3225 (a->ob_digit[j+1] << hishift) & himask;
3226 }
3227 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003228 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003229rshift_error:
3230 Py_DECREF(a);
3231 Py_DECREF(b);
3232 return (PyObject *) z;
3233
Guido van Rossumc6913e71991-11-19 20:26:46 +00003234}
3235
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003236static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003237long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003238{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003239 /* This version due to Tim Peters */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003240 PyLongObject *a, *b;
3241 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003242 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003243 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003244 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003245
Neil Schemenauerba872e22001-01-04 01:46:03 +00003246 CONVERT_BINOP(v, w, &a, &b);
3247
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003248 shiftby = PyLong_AsLong((PyObject *)b);
3249 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003250 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003251 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003252 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003253 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003254 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003255 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003256 PyErr_SetString(PyExc_ValueError,
3257 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003258 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003259 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003260 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3261 wordshift = (int)shiftby / PyLong_SHIFT;
3262 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003263
3264 oldsize = ABS(a->ob_size);
3265 newsize = oldsize + wordshift;
3266 if (remshift)
3267 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003268 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003269 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003270 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003271 if (a->ob_size < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003272 z->ob_size = -(z->ob_size);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003273 for (i = 0; i < wordshift; i++)
3274 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003275 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003276 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003277 accum |= (twodigits)a->ob_digit[j] << remshift;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003278 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3279 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003280 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003281 if (remshift)
3282 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003283 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003284 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003285 z = long_normalize(z);
3286lshift_error:
3287 Py_DECREF(a);
3288 Py_DECREF(b);
3289 return (PyObject *) z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003290}
3291
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003292
3293/* Bitwise and/xor/or operations */
3294
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003295static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003296long_bitwise(PyLongObject *a,
3297 int op, /* '&', '|', '^' */
3298 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003299{
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003300 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003301 int negz;
Mark Dickinsonbcf6b182009-02-15 15:48:39 +00003302 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003303 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003304 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003305 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003306
Christian Heimese93237d2007-12-19 02:37:44 +00003307 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003308 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003309 if (a == NULL)
3310 return NULL;
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003311 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003312 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003313 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003314 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003315 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003316 }
Christian Heimese93237d2007-12-19 02:37:44 +00003317 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003318 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003319 if (b == NULL) {
3320 Py_DECREF(a);
3321 return NULL;
3322 }
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003323 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003324 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003325 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003326 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003327 maskb = 0;
3328 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003329
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003330 negz = 0;
3331 switch (op) {
3332 case '^':
3333 if (maska != maskb) {
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003334 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003335 negz = -1;
3336 }
3337 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003338 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003339 if (maska && maskb) {
3340 op = '|';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003341 maska ^= PyLong_MASK;
3342 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003343 negz = -1;
3344 }
3345 break;
3346 case '|':
3347 if (maska || maskb) {
3348 op = '&';
Christian Heimes7f39c9f2008-01-25 12:18:43 +00003349 maska ^= PyLong_MASK;
3350 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003351 negz = -1;
3352 }
3353 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003354 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003355
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003356 /* JRH: The original logic here was to allocate the result value (z)
3357 as the longer of the two operands. However, there are some cases
3358 where the result is guaranteed to be shorter than that: AND of two
3359 positives, OR of two negatives: use the shorter number. AND with
3360 mixed signs: use the positive number. OR with mixed signs: use the
3361 negative number. After the transformations above, op will be '&'
3362 iff one of these cases applies, and mask will be non-0 for operands
3363 whose length should be ignored.
3364 */
3365
Christian Heimese93237d2007-12-19 02:37:44 +00003366 size_a = Py_SIZE(a);
3367 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003368 size_z = op == '&'
3369 ? (maska
3370 ? size_b
3371 : (maskb ? size_a : MIN(size_a, size_b)))
3372 : MAX(size_a, size_b);
3373 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003374 if (z == NULL) {
Neal Norwitzef02b9e2006-07-16 02:00:32 +00003375 Py_DECREF(a);
3376 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003377 return NULL;
3378 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003379
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003380 for (i = 0; i < size_z; ++i) {
3381 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3382 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3383 switch (op) {
3384 case '&': z->ob_digit[i] = diga & digb; break;
3385 case '|': z->ob_digit[i] = diga | digb; break;
3386 case '^': z->ob_digit[i] = diga ^ digb; break;
3387 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003388 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003389
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003390 Py_DECREF(a);
3391 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003392 z = long_normalize(z);
3393 if (negz == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003394 return (PyObject *) z;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003395 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003396 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003397 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003398}
3399
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003400static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003401long_and(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003402{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003403 PyLongObject *a, *b;
3404 PyObject *c;
3405 CONVERT_BINOP(v, w, &a, &b);
3406 c = long_bitwise(a, '&', b);
3407 Py_DECREF(a);
3408 Py_DECREF(b);
3409 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003410}
3411
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003412static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003413long_xor(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003414{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003415 PyLongObject *a, *b;
3416 PyObject *c;
3417 CONVERT_BINOP(v, w, &a, &b);
3418 c = long_bitwise(a, '^', b);
3419 Py_DECREF(a);
3420 Py_DECREF(b);
3421 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003422}
3423
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003424static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003425long_or(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003426{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003427 PyLongObject *a, *b;
3428 PyObject *c;
3429 CONVERT_BINOP(v, w, &a, &b);
3430 c = long_bitwise(a, '|', b);
3431 Py_DECREF(a);
3432 Py_DECREF(b);
3433 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003434}
3435
Guido van Rossum234f9421993-06-17 12:35:49 +00003436static int
Tim Peters9f688bf2000-07-07 15:53:28 +00003437long_coerce(PyObject **pv, PyObject **pw)
Guido van Rossume6eefc21992-08-14 12:06:52 +00003438{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003439 if (PyInt_Check(*pw)) {
Neil Schemenauerba872e22001-01-04 01:46:03 +00003440 *pw = PyLong_FromLong(PyInt_AS_LONG(*pw));
Georg Brandlc02e1312007-04-11 17:16:24 +00003441 if (*pw == NULL)
3442 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003443 Py_INCREF(*pv);
Guido van Rossume6eefc21992-08-14 12:06:52 +00003444 return 0;
3445 }
Guido van Rossum1952e382001-09-19 01:25:16 +00003446 else if (PyLong_Check(*pw)) {
3447 Py_INCREF(*pv);
3448 Py_INCREF(*pw);
3449 return 0;
3450 }
Guido van Rossume6eefc21992-08-14 12:06:52 +00003451 return 1; /* Can't do it */
3452}
3453
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003454static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003455long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003456{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003457 if (PyLong_CheckExact(v))
3458 Py_INCREF(v);
3459 else
3460 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003461 return v;
3462}
3463
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003464static PyObject *
Walter Dörwaldf1715402002-11-19 20:49:15 +00003465long_int(PyObject *v)
3466{
3467 long x;
3468 x = PyLong_AsLong(v);
3469 if (PyErr_Occurred()) {
3470 if (PyErr_ExceptionMatches(PyExc_OverflowError)) {
3471 PyErr_Clear();
3472 if (PyLong_CheckExact(v)) {
3473 Py_INCREF(v);
3474 return v;
3475 }
3476 else
3477 return _PyLong_Copy((PyLongObject *)v);
3478 }
3479 else
3480 return NULL;
3481 }
3482 return PyInt_FromLong(x);
3483}
3484
3485static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003486long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003487{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003488 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003489 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003490 if (result == -1.0 && PyErr_Occurred())
3491 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003492 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003493}
3494
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003495static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003496long_oct(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003497{
Eric Smith5e527eb2008-02-10 01:36:53 +00003498 return _PyLong_Format(v, 8, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003499}
3500
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003501static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003502long_hex(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003503{
Eric Smith5e527eb2008-02-10 01:36:53 +00003504 return _PyLong_Format(v, 16, 1, 0);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003505}
Jeremy Hylton938ace62002-07-17 16:30:39 +00003506
3507static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003508long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003509
Tim Peters6d6c1a32001-08-02 04:15:00 +00003510static PyObject *
3511long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3512{
3513 PyObject *x = NULL;
3514 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003515 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003516
Guido van Rossumbef14172001-08-29 15:47:46 +00003517 if (type != &PyLong_Type)
3518 return long_subtype_new(type, args, kwds); /* Wimp out */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003519 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:long", kwlist,
3520 &x, &base))
3521 return NULL;
3522 if (x == NULL)
3523 return PyLong_FromLong(0L);
3524 if (base == -909)
3525 return PyNumber_Long(x);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003526 else if (PyString_Check(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003527 /* Since PyLong_FromString doesn't have a length parameter,
3528 * check here for possible NULs in the string. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003529 char *string = PyString_AS_STRING(x);
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003530 if (strlen(string) != (size_t)PyString_Size(x)) {
Georg Brandl00cd8182007-03-06 18:41:12 +00003531 /* create a repr() of the input string,
3532 * just like PyLong_FromString does. */
3533 PyObject *srepr;
3534 srepr = PyObject_Repr(x);
3535 if (srepr == NULL)
3536 return NULL;
3537 PyErr_Format(PyExc_ValueError,
3538 "invalid literal for long() with base %d: %s",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003539 base, PyString_AS_STRING(srepr));
Georg Brandl00cd8182007-03-06 18:41:12 +00003540 Py_DECREF(srepr);
3541 return NULL;
3542 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003543 return PyLong_FromString(PyString_AS_STRING(x), NULL, base);
Georg Brandl00cd8182007-03-06 18:41:12 +00003544 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003545#ifdef Py_USING_UNICODE
Tim Peters6d6c1a32001-08-02 04:15:00 +00003546 else if (PyUnicode_Check(x))
3547 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3548 PyUnicode_GET_SIZE(x),
3549 base);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00003550#endif
Tim Peters6d6c1a32001-08-02 04:15:00 +00003551 else {
3552 PyErr_SetString(PyExc_TypeError,
3553 "long() can't convert non-string with explicit base");
3554 return NULL;
3555 }
3556}
3557
Guido van Rossumbef14172001-08-29 15:47:46 +00003558/* Wimpy, slow approach to tp_new calls for subtypes of long:
3559 first create a regular long from whatever arguments we got,
3560 then allocate a subtype instance and initialize it from
3561 the regular long. The regular long is then thrown away.
3562*/
3563static PyObject *
3564long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3565{
Anthony Baxter377be112006-04-11 06:54:30 +00003566 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003567 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003568
3569 assert(PyType_IsSubtype(type, &PyLong_Type));
3570 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3571 if (tmp == NULL)
3572 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003573 assert(PyLong_CheckExact(tmp));
Christian Heimese93237d2007-12-19 02:37:44 +00003574 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003575 if (n < 0)
3576 n = -n;
Anthony Baxter377be112006-04-11 06:54:30 +00003577 newobj = (PyLongObject *)type->tp_alloc(type, n);
3578 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003579 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003580 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003581 }
Anthony Baxter377be112006-04-11 06:54:30 +00003582 assert(PyLong_Check(newobj));
Christian Heimese93237d2007-12-19 02:37:44 +00003583 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003584 for (i = 0; i < n; i++)
Anthony Baxter377be112006-04-11 06:54:30 +00003585 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003586 Py_DECREF(tmp);
Anthony Baxter377be112006-04-11 06:54:30 +00003587 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003588}
3589
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003590static PyObject *
3591long_getnewargs(PyLongObject *v)
3592{
3593 return Py_BuildValue("(N)", _PyLong_Copy(v));
3594}
3595
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003596static PyObject *
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003597long_get0(PyLongObject *v, void *context) {
3598 return PyLong_FromLong(0L);
3599}
3600
3601static PyObject *
3602long_get1(PyLongObject *v, void *context) {
3603 return PyLong_FromLong(1L);
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003604}
3605
Eric Smitha9f7d622008-02-17 19:46:49 +00003606static PyObject *
3607long__format__(PyObject *self, PyObject *args)
3608{
3609 PyObject *format_spec;
3610
3611 if (!PyArg_ParseTuple(args, "O:__format__", &format_spec))
3612 return NULL;
Christian Heimes593daf52008-05-26 12:51:38 +00003613 if (PyBytes_Check(format_spec))
Eric Smithdc13b792008-05-30 18:10:04 +00003614 return _PyLong_FormatAdvanced(self,
3615 PyBytes_AS_STRING(format_spec),
3616 PyBytes_GET_SIZE(format_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003617 if (PyUnicode_Check(format_spec)) {
3618 /* Convert format_spec to a str */
Eric Smithdc13b792008-05-30 18:10:04 +00003619 PyObject *result;
3620 PyObject *str_spec = PyObject_Str(format_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003621
Eric Smithdc13b792008-05-30 18:10:04 +00003622 if (str_spec == NULL)
3623 return NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +00003624
Eric Smithdc13b792008-05-30 18:10:04 +00003625 result = _PyLong_FormatAdvanced(self,
3626 PyBytes_AS_STRING(str_spec),
3627 PyBytes_GET_SIZE(str_spec));
Eric Smitha9f7d622008-02-17 19:46:49 +00003628
Eric Smithdc13b792008-05-30 18:10:04 +00003629 Py_DECREF(str_spec);
Eric Smitha9f7d622008-02-17 19:46:49 +00003630 return result;
3631 }
3632 PyErr_SetString(PyExc_TypeError, "__format__ requires str or unicode");
3633 return NULL;
3634}
3635
Robert Schuppenies51df0642008-06-01 16:16:17 +00003636static PyObject *
3637long_sizeof(PyLongObject *v)
3638{
3639 Py_ssize_t res;
3640
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003641 res = v->ob_type->tp_basicsize + ABS(Py_SIZE(v))*sizeof(digit);
Robert Schuppenies51df0642008-06-01 16:16:17 +00003642 return PyInt_FromSsize_t(res);
3643}
3644
Mark Dickinson1a707982008-12-17 16:14:37 +00003645static PyObject *
3646long_bit_length(PyLongObject *v)
3647{
3648 PyLongObject *result, *x, *y;
3649 Py_ssize_t ndigits, msd_bits = 0;
3650 digit msd;
3651
3652 assert(v != NULL);
3653 assert(PyLong_Check(v));
3654
3655 ndigits = ABS(Py_SIZE(v));
3656 if (ndigits == 0)
3657 return PyInt_FromLong(0);
3658
3659 msd = v->ob_digit[ndigits-1];
3660 while (msd >= 32) {
3661 msd_bits += 6;
3662 msd >>= 6;
3663 }
3664 msd_bits += (long)(BitLengthTable[msd]);
3665
3666 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
3667 return PyInt_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
3668
3669 /* expression above may overflow; use Python integers instead */
3670 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
3671 if (result == NULL)
3672 return NULL;
3673 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
3674 if (x == NULL)
3675 goto error;
3676 y = (PyLongObject *)long_mul(result, x);
3677 Py_DECREF(x);
3678 if (y == NULL)
3679 goto error;
3680 Py_DECREF(result);
3681 result = y;
3682
3683 x = (PyLongObject *)PyLong_FromLong(msd_bits);
3684 if (x == NULL)
3685 goto error;
3686 y = (PyLongObject *)long_add(result, x);
3687 Py_DECREF(x);
3688 if (y == NULL)
3689 goto error;
3690 Py_DECREF(result);
3691 result = y;
3692
3693 return (PyObject *)result;
3694
3695error:
3696 Py_DECREF(result);
3697 return NULL;
3698}
3699
3700PyDoc_STRVAR(long_bit_length_doc,
3701"long.bit_length() -> int or long\n\
3702\n\
3703Number of bits necessary to represent self in binary.\n\
3704>>> bin(37L)\n\
3705'0b100101'\n\
3706>>> (37L).bit_length()\n\
37076");
3708
Christian Heimes6f341092008-04-18 23:13:07 +00003709#if 0
3710static PyObject *
3711long_is_finite(PyObject *v)
3712{
3713 Py_RETURN_TRUE;
3714}
3715#endif
3716
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003717static PyMethodDef long_methods[] = {
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003718 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
3719 "Returns self, the complex conjugate of any long."},
Mark Dickinson1a707982008-12-17 16:14:37 +00003720 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
3721 long_bit_length_doc},
Christian Heimes6f341092008-04-18 23:13:07 +00003722#if 0
3723 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
3724 "Returns always True."},
3725#endif
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003726 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
3727 "Truncating an Integral returns itself."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003728 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smitha9f7d622008-02-17 19:46:49 +00003729 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Robert Schuppenies51df0642008-06-01 16:16:17 +00003730 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
Georg Brandl7a6de8b2008-06-01 16:42:16 +00003731 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003732 {NULL, NULL} /* sentinel */
3733};
3734
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003735static PyGetSetDef long_getset[] = {
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003736 {"real",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003737 (getter)long_long, (setter)NULL,
3738 "the real part of a complex number",
3739 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003740 {"imag",
3741 (getter)long_get0, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003742 "the imaginary part of a complex number",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003743 NULL},
3744 {"numerator",
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003745 (getter)long_long, (setter)NULL,
3746 "the numerator of a rational number in lowest terms",
3747 NULL},
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003748 {"denominator",
3749 (getter)long_get1, (setter)NULL,
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003750 "the denominator of a rational number in lowest terms",
Mark Dickinsond4b5c982009-05-02 17:55:01 +00003751 NULL},
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003752 {NULL} /* Sentinel */
3753};
3754
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003755PyDoc_STRVAR(long_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003756"long(x[, base]) -> integer\n\
3757\n\
3758Convert a string or number to a long integer, if possible. A floating\n\
3759point argument will be truncated towards zero (this does not include a\n\
3760string representation of a floating point number!) When converting a\n\
3761string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003762converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003763
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003764static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00003765 (binaryfunc) long_add, /*nb_add*/
3766 (binaryfunc) long_sub, /*nb_subtract*/
3767 (binaryfunc) long_mul, /*nb_multiply*/
Georg Brandl347b3002006-03-30 11:57:00 +00003768 long_classic_div, /*nb_divide*/
3769 long_mod, /*nb_remainder*/
3770 long_divmod, /*nb_divmod*/
3771 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003772 (unaryfunc) long_neg, /*nb_negative*/
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003773 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003774 (unaryfunc) long_abs, /*tp_absolute*/
3775 (inquiry) long_nonzero, /*tp_nonzero*/
3776 (unaryfunc) long_invert, /*nb_invert*/
Georg Brandl347b3002006-03-30 11:57:00 +00003777 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00003778 (binaryfunc) long_rshift, /*nb_rshift*/
Georg Brandl347b3002006-03-30 11:57:00 +00003779 long_and, /*nb_and*/
3780 long_xor, /*nb_xor*/
3781 long_or, /*nb_or*/
3782 long_coerce, /*nb_coerce*/
3783 long_int, /*nb_int*/
3784 long_long, /*nb_long*/
3785 long_float, /*nb_float*/
3786 long_oct, /*nb_oct*/
3787 long_hex, /*nb_hex*/
Guido van Rossum4668b002001-08-08 05:00:18 +00003788 0, /* nb_inplace_add */
3789 0, /* nb_inplace_subtract */
3790 0, /* nb_inplace_multiply */
3791 0, /* nb_inplace_divide */
3792 0, /* nb_inplace_remainder */
3793 0, /* nb_inplace_power */
3794 0, /* nb_inplace_lshift */
3795 0, /* nb_inplace_rshift */
3796 0, /* nb_inplace_and */
3797 0, /* nb_inplace_xor */
3798 0, /* nb_inplace_or */
Georg Brandl347b3002006-03-30 11:57:00 +00003799 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00003800 long_true_divide, /* nb_true_divide */
3801 0, /* nb_inplace_floor_divide */
3802 0, /* nb_inplace_true_divide */
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00003803 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003804};
3805
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003806PyTypeObject PyLong_Type = {
3807 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003808 0, /* ob_size */
3809 "long", /* tp_name */
Mark Dickinson2ffb26f2009-02-15 10:13:41 +00003810 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003811 sizeof(digit), /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00003812 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003813 0, /* tp_print */
3814 0, /* tp_getattr */
3815 0, /* tp_setattr */
3816 (cmpfunc)long_compare, /* tp_compare */
Georg Brandl347b3002006-03-30 11:57:00 +00003817 long_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003818 &long_as_number, /* tp_as_number */
3819 0, /* tp_as_sequence */
3820 0, /* tp_as_mapping */
3821 (hashfunc)long_hash, /* tp_hash */
3822 0, /* tp_call */
Georg Brandl347b3002006-03-30 11:57:00 +00003823 long_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003824 PyObject_GenericGetAttr, /* tp_getattro */
3825 0, /* tp_setattro */
3826 0, /* tp_as_buffer */
Guido van Rossumbef14172001-08-29 15:47:46 +00003827 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
Neal Norwitzee3a1b52007-02-25 19:44:48 +00003828 Py_TPFLAGS_BASETYPE | Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003829 long_doc, /* tp_doc */
3830 0, /* tp_traverse */
3831 0, /* tp_clear */
3832 0, /* tp_richcompare */
3833 0, /* tp_weaklistoffset */
3834 0, /* tp_iter */
3835 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003836 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003837 0, /* tp_members */
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +00003838 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003839 0, /* tp_base */
3840 0, /* tp_dict */
3841 0, /* tp_descr_get */
3842 0, /* tp_descr_set */
3843 0, /* tp_dictoffset */
3844 0, /* tp_init */
3845 0, /* tp_alloc */
3846 long_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00003847 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003848};
Mark Dickinsonefc82f72009-03-20 15:51:55 +00003849
3850static PyTypeObject Long_InfoType;
3851
3852PyDoc_STRVAR(long_info__doc__,
3853"sys.long_info\n\
3854\n\
3855A struct sequence that holds information about Python's\n\
3856internal representation of integers. The attributes are read only.");
3857
3858static PyStructSequence_Field long_info_fields[] = {
3859 {"bits_per_digit", "size of a digit in bits"},
3860 {"sizeof_digit", "size in bytes of the C type used to "
3861 "represent a digit"},
3862 {NULL, NULL}
3863};
3864
3865static PyStructSequence_Desc long_info_desc = {
3866 "sys.long_info", /* name */
3867 long_info__doc__, /* doc */
3868 long_info_fields, /* fields */
3869 2 /* number of fields */
3870};
3871
3872PyObject *
3873PyLong_GetInfo(void)
3874{
3875 PyObject* long_info;
3876 int field = 0;
3877 long_info = PyStructSequence_New(&Long_InfoType);
3878 if (long_info == NULL)
3879 return NULL;
Mark Dickinson48e3fd22009-04-02 18:39:37 +00003880 PyStructSequence_SET_ITEM(long_info, field++,
3881 PyInt_FromLong(PyLong_SHIFT));
3882 PyStructSequence_SET_ITEM(long_info, field++,
3883 PyInt_FromLong(sizeof(digit)));
Mark Dickinsonefc82f72009-03-20 15:51:55 +00003884 if (PyErr_Occurred()) {
3885 Py_CLEAR(long_info);
3886 return NULL;
3887 }
3888 return long_info;
3889}
3890
3891int
3892_PyLong_Init(void)
3893{
3894 /* initialize long_info */
3895 if (Long_InfoType.tp_name == 0)
3896 PyStructSequence_InitType(&Long_InfoType, &long_info_desc);
3897 return 1;
3898}