blob: f84b54e8d5de9c5a7be110b81f0cb217617fc99d [file] [log] [blame]
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001/* Long (arbitrary precision) integer object implementation */
2
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003/* XXX The functional organization of this file is terrible */
4
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005#include "Python.h"
Guido van Rossumedcc38a1991-05-05 20:09:44 +00006#include "longintrepr.h"
Mark Dickinsonbd792642009-03-18 20:06:12 +00007#include "structseq.h"
Guido van Rossumc0b618a1997-05-02 03:12:38 +00008
Mark Dickinsonc6300392009-04-20 21:38:00 +00009#include <float.h>
Guido van Rossumeb1fafc1994-08-29 12:47:19 +000010#include <ctype.h>
Mark Dickinson5a74bf62009-02-15 11:04:38 +000011#include <stddef.h>
Guido van Rossumedcc38a1991-05-05 20:09:44 +000012
Guido van Rossumddefaf32007-01-14 03:31:43 +000013#ifndef NSMALLPOSINTS
14#define NSMALLPOSINTS 257
15#endif
16#ifndef NSMALLNEGINTS
17#define NSMALLNEGINTS 5
18#endif
Facundo Batista6e6f59b2008-07-24 18:57:11 +000019
Mark Dickinsone4416742009-02-15 15:14:57 +000020/* convert a PyLong of size 1, 0 or -1 to an sdigit */
21#define MEDIUM_VALUE(x) (Py_SIZE(x) < 0 ? -(sdigit)(x)->ob_digit[0] : \
22 (Py_SIZE(x) == 0 ? (sdigit)0 : \
23 (sdigit)(x)->ob_digit[0]))
Facundo Batista6e6f59b2008-07-24 18:57:11 +000024#define ABS(x) ((x) < 0 ? -(x) : (x))
25
Guido van Rossumddefaf32007-01-14 03:31:43 +000026#if NSMALLNEGINTS + NSMALLPOSINTS > 0
27/* Small integers are preallocated in this array so that they
28 can be shared.
29 The integers that are preallocated are those in the range
30 -NSMALLNEGINTS (inclusive) to NSMALLPOSINTS (not inclusive).
31*/
32static PyLongObject small_ints[NSMALLNEGINTS + NSMALLPOSINTS];
33#ifdef COUNT_ALLOCS
34int quick_int_allocs, quick_neg_int_allocs;
35#endif
36
Guido van Rossum7eaf8222007-06-18 17:58:50 +000037static PyObject *
Mark Dickinsone4416742009-02-15 15:14:57 +000038get_small_int(sdigit ival)
Guido van Rossumddefaf32007-01-14 03:31:43 +000039{
40 PyObject *v = (PyObject*)(small_ints + ival + NSMALLNEGINTS);
41 Py_INCREF(v);
42#ifdef COUNT_ALLOCS
43 if (ival >= 0)
44 quick_int_allocs++;
45 else
46 quick_neg_int_allocs++;
47#endif
48 return v;
49}
50#define CHECK_SMALL_INT(ival) \
51 do if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) { \
Mark Dickinson0d4785b2009-02-15 17:27:41 +000052 return get_small_int((sdigit)ival); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000053 } while(0)
54
Facundo Batista6e6f59b2008-07-24 18:57:11 +000055static PyLongObject *
56maybe_small_long(PyLongObject *v)
57{
58 if (v && ABS(Py_SIZE(v)) <= 1) {
Mark Dickinsone4416742009-02-15 15:14:57 +000059 sdigit ival = MEDIUM_VALUE(v);
Facundo Batista6e6f59b2008-07-24 18:57:11 +000060 if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
61 Py_DECREF(v);
62 return (PyLongObject *)get_small_int(ival);
63 }
64 }
65 return v;
66}
Guido van Rossumddefaf32007-01-14 03:31:43 +000067#else
68#define CHECK_SMALL_INT(ival)
Facundo Batista6e6f59b2008-07-24 18:57:11 +000069#define maybe_small_long(val) (val)
Guido van Rossumddefaf32007-01-14 03:31:43 +000070#endif
71
Guido van Rossumddefaf32007-01-14 03:31:43 +000072/* If a freshly-allocated long is already shared, it must
73 be a small integer, so negating it must go to PyLong_FromLong */
74#define NEGATE(x) \
Christian Heimes90aa7642007-12-19 02:45:37 +000075 do if (Py_REFCNT(x) == 1) Py_SIZE(x) = -Py_SIZE(x); \
Christian Heimes217cfd12007-12-02 14:31:20 +000076 else { PyObject* tmp=PyLong_FromLong(-MEDIUM_VALUE(x)); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000077 Py_DECREF(x); (x) = (PyLongObject*)tmp; } \
78 while(0)
Tim Peters5af4e6c2002-08-12 02:31:19 +000079/* For long multiplication, use the O(N**2) school algorithm unless
80 * both operands contain more than KARATSUBA_CUTOFF digits (this
81 * being an internal Python long digit, in base BASE).
82 */
Tim Peters0973b992004-08-29 22:16:50 +000083#define KARATSUBA_CUTOFF 70
84#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000085
Tim Peters47e52ee2004-08-30 02:44:38 +000086/* For exponentiation, use the binary left-to-right algorithm
87 * unless the exponent contains more than FIVEARY_CUTOFF digits.
88 * In that case, do 5 bits at a time. The potential drawback is that
89 * a table of 2**5 intermediate results is computed.
90 */
91#define FIVEARY_CUTOFF 8
92
Tim Peters5af4e6c2002-08-12 02:31:19 +000093#undef MIN
94#undef MAX
95#define MAX(x, y) ((x) < (y) ? (y) : (x))
96#define MIN(x, y) ((x) > (y) ? (y) : (x))
97
Guido van Rossumc0b618a1997-05-02 03:12:38 +000098#define SIGCHECK(PyTryBlock) \
Skip Montanarod581d772002-09-03 20:10:45 +000099 if (--_Py_Ticker < 0) { \
100 _Py_Ticker = _Py_CheckInterval; \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000101 if (PyErr_CheckSignals()) PyTryBlock \
Guido van Rossum23d6f0e1991-05-14 12:06:49 +0000102 }
103
Mark Dickinsonc6300392009-04-20 21:38:00 +0000104/* forward declaration */
105static int bits_in_digit(digit d);
106
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000107/* Normalize (remove leading zeros from) a long int object.
108 Doesn't attempt to free the storage--in most cases, due to the nature
109 of the algorithms used, this could save at most be one word anyway. */
110
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000111static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000112long_normalize(register PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000113{
Christian Heimes90aa7642007-12-19 02:45:37 +0000114 Py_ssize_t j = ABS(Py_SIZE(v));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000115 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000116
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000117 while (i > 0 && v->ob_digit[i-1] == 0)
118 --i;
119 if (i != j)
Christian Heimes90aa7642007-12-19 02:45:37 +0000120 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000121 return v;
122}
123
124/* Allocate a new long int object with size digits.
125 Return NULL and set exception if we run out of memory. */
126
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000127#define MAX_LONG_DIGITS \
128 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
129
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000130PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000132{
Guido van Rossumddefaf32007-01-14 03:31:43 +0000133 PyLongObject *result;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000134 /* Number of bytes needed is: offsetof(PyLongObject, ob_digit) +
135 sizeof(digit)*size. Previous incarnations of this code used
136 sizeof(PyVarObject) instead of the offsetof, but this risks being
137 incorrect in the presence of padding between the PyVarObject header
138 and the digits. */
Mark Dickinsone4416742009-02-15 15:14:57 +0000139 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000140 PyErr_SetString(PyExc_OverflowError,
141 "too many digits in integer");
142 return NULL;
143 }
144 result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) +
Guido van Rossumddefaf32007-01-14 03:31:43 +0000145 size*sizeof(digit));
146 if (!result) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000147 PyErr_NoMemory();
148 return NULL;
149 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000150 return (PyLongObject*)PyObject_INIT_VAR(result, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000151}
152
Tim Peters64b5ce32001-09-10 20:52:51 +0000153PyObject *
154_PyLong_Copy(PyLongObject *src)
155{
156 PyLongObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000157 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +0000158
159 assert(src != NULL);
Christian Heimes90aa7642007-12-19 02:45:37 +0000160 i = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000161 if (i < 0)
162 i = -(i);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000163 if (i < 2) {
Mark Dickinsone4416742009-02-15 15:14:57 +0000164 sdigit ival = src->ob_digit[0];
Christian Heimes90aa7642007-12-19 02:45:37 +0000165 if (Py_SIZE(src) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000166 ival = -ival;
167 CHECK_SMALL_INT(ival);
168 }
Tim Peters64b5ce32001-09-10 20:52:51 +0000169 result = _PyLong_New(i);
170 if (result != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000171 Py_SIZE(result) = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000172 while (--i >= 0)
173 result->ob_digit[i] = src->ob_digit[i];
174 }
175 return (PyObject *)result;
176}
177
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000178/* Create a new long int object from a C long int */
179
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000180PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000181PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000182{
Tim Petersce9de2f2001-06-14 04:56:19 +0000183 PyLongObject *v;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000184 unsigned long abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000185 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
186 int ndigits = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000187 int sign = 1;
188
189 CHECK_SMALL_INT(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000190
191 if (ival < 0) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000192 /* negate: can't write this as abs_ival = -ival since that
193 invokes undefined behaviour when ival is LONG_MIN */
194 abs_ival = 0U-(unsigned long)ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000195 sign = -1;
Tim Petersce9de2f2001-06-14 04:56:19 +0000196 }
Christian Heimesdae2a892008-04-19 00:55:37 +0000197 else {
198 abs_ival = (unsigned long)ival;
199 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000200
Mark Dickinsond4624c32009-01-24 15:02:35 +0000201 /* Fast path for single-digit ints */
202 if (!(abs_ival >> PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000203 v = _PyLong_New(1);
204 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000205 Py_SIZE(v) = sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000206 v->ob_digit[0] = Py_SAFE_DOWNCAST(
207 abs_ival, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000208 }
209 return (PyObject*)v;
210 }
211
Mark Dickinson249b8982009-04-27 19:41:00 +0000212#if PyLong_SHIFT==15
Guido van Rossumddefaf32007-01-14 03:31:43 +0000213 /* 2 digits */
Mark Dickinsond4624c32009-01-24 15:02:35 +0000214 if (!(abs_ival >> 2*PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000215 v = _PyLong_New(2);
216 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_SIZE(v) = 2*sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000218 v->ob_digit[0] = Py_SAFE_DOWNCAST(
219 abs_ival & PyLong_MASK, unsigned long, digit);
220 v->ob_digit[1] = Py_SAFE_DOWNCAST(
221 abs_ival >> PyLong_SHIFT, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000222 }
223 return (PyObject*)v;
224 }
Mark Dickinsonbd792642009-03-18 20:06:12 +0000225#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +0000226
227 /* Larger numbers: loop to determine number of digits */
Christian Heimesdae2a892008-04-19 00:55:37 +0000228 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000229 while (t) {
230 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000231 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000232 }
233 v = _PyLong_New(ndigits);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000234 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000235 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000236 Py_SIZE(v) = ndigits*sign;
Christian Heimesdae2a892008-04-19 00:55:37 +0000237 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000238 while (t) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000239 *p++ = Py_SAFE_DOWNCAST(
240 t & PyLong_MASK, unsigned long, digit);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000241 t >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000242 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000243 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000245}
246
Guido van Rossum53756b11997-01-03 17:14:46 +0000247/* Create a new long int object from a C unsigned long int */
248
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000250PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000251{
Tim Petersce9de2f2001-06-14 04:56:19 +0000252 PyLongObject *v;
253 unsigned long t;
254 int ndigits = 0;
255
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000256 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000257 return PyLong_FromLong(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000258 /* Count the number of Python digits. */
259 t = (unsigned long)ival;
260 while (t) {
261 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000262 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000263 }
264 v = _PyLong_New(ndigits);
Guido van Rossum53756b11997-01-03 17:14:46 +0000265 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000266 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000267 Py_SIZE(v) = ndigits;
Tim Petersce9de2f2001-06-14 04:56:19 +0000268 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000269 *p++ = (digit)(ival & PyLong_MASK);
270 ival >>= PyLong_SHIFT;
Guido van Rossum53756b11997-01-03 17:14:46 +0000271 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000272 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000273 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000274}
275
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000276/* Create a new long int object from a C double */
277
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000278PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000279PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000280{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000281 PyLongObject *v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000282 double frac;
283 int i, ndig, expo, neg;
284 neg = 0;
Tim Peters39dce292000-08-15 03:34:48 +0000285 if (Py_IS_INFINITY(dval)) {
Guido van Rossum1a23c241999-09-27 17:11:52 +0000286 PyErr_SetString(PyExc_OverflowError,
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000287 "cannot convert float infinity to integer");
Guido van Rossum1a23c241999-09-27 17:11:52 +0000288 return NULL;
289 }
Christian Heimesa34706f2008-01-04 03:06:10 +0000290 if (Py_IS_NAN(dval)) {
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000291 PyErr_SetString(PyExc_ValueError,
292 "cannot convert float NaN to integer");
Christian Heimes386cd1e2008-01-15 02:01:20 +0000293 return NULL;
Christian Heimesa34706f2008-01-04 03:06:10 +0000294 }
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000295 if (dval < 0.0) {
296 neg = 1;
297 dval = -dval;
298 }
299 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
300 if (expo <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 return PyLong_FromLong(0L);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000302 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000303 v = _PyLong_New(ndig);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000304 if (v == NULL)
305 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000306 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000307 for (i = ndig; --i >= 0; ) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000308 digit bits = (digit)frac;
309 v->ob_digit[i] = bits;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000310 frac = frac - (double)bits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000311 frac = ldexp(frac, PyLong_SHIFT);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000312 }
313 if (neg)
Christian Heimes90aa7642007-12-19 02:45:37 +0000314 Py_SIZE(v) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000316}
317
Thomas Wouters89f507f2006-12-13 04:49:30 +0000318/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
319 * anything about what happens when a signed integer operation overflows,
320 * and some compilers think they're doing you a favor by being "clever"
321 * then. The bit pattern for the largest postive signed long is
322 * (unsigned long)LONG_MAX, and for the smallest negative signed long
323 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
324 * However, some other compilers warn about applying unary minus to an
325 * unsigned operand. Hence the weird "0-".
326 */
327#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
328#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
329
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000330/* Get a C long int from a long int object.
331 Returns -1 and sets an error condition if overflow occurs. */
332
333long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000334PyLong_AsLongAndOverflow(PyObject *vv, int *overflow)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000335{
Guido van Rossumf7531811998-05-26 14:33:37 +0000336 /* This version by Tim Peters */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000337 register PyLongObject *v;
Guido van Rossumf7531811998-05-26 14:33:37 +0000338 unsigned long x, prev;
Georg Brandl61c31b02007-02-26 14:46:30 +0000339 long res;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000340 Py_ssize_t i;
341 int sign;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000342 int do_decref = 0; /* if nb_int was called */
Guido van Rossumf7531811998-05-26 14:33:37 +0000343
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000344 *overflow = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000345 if (vv == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000346 PyErr_BadInternalCall();
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000347 return -1;
348 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000349
350 if (!PyLong_Check(vv)) {
351 PyNumberMethods *nb;
352 if ((nb = vv->ob_type->tp_as_number) == NULL ||
353 nb->nb_int == NULL) {
354 PyErr_SetString(PyExc_TypeError, "an integer is required");
355 return -1;
356 }
357 vv = (*nb->nb_int) (vv);
358 if (vv == NULL)
359 return -1;
360 do_decref = 1;
361 if (!PyLong_Check(vv)) {
362 Py_DECREF(vv);
363 PyErr_SetString(PyExc_TypeError,
364 "nb_int should return int object");
365 return -1;
366 }
367 }
368
Georg Brandl61c31b02007-02-26 14:46:30 +0000369 res = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000370 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000371 i = Py_SIZE(v);
Guido van Rossumf7531811998-05-26 14:33:37 +0000372
Georg Brandl61c31b02007-02-26 14:46:30 +0000373 switch (i) {
374 case -1:
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000375 res = -(sdigit)v->ob_digit[0];
Georg Brandl61c31b02007-02-26 14:46:30 +0000376 break;
377 case 0:
378 res = 0;
379 break;
380 case 1:
381 res = v->ob_digit[0];
382 break;
383 default:
384 sign = 1;
385 x = 0;
386 if (i < 0) {
387 sign = -1;
388 i = -(i);
389 }
390 while (--i >= 0) {
391 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000392 x = (x << PyLong_SHIFT) + v->ob_digit[i];
393 if ((x >> PyLong_SHIFT) != prev) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000394 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Georg Brandl61c31b02007-02-26 14:46:30 +0000395 goto exit;
396 }
397 }
398 /* Haven't lost any bits, but casting to long requires extra care
399 * (see comment above).
400 */
401 if (x <= (unsigned long)LONG_MAX) {
402 res = (long)x * sign;
403 }
404 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
405 res = LONG_MIN;
406 }
407 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000408 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000409 /* res is already set to -1 */
Georg Brandl61c31b02007-02-26 14:46:30 +0000410 }
411 }
412 exit:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000413 if (do_decref) {
414 Py_DECREF(vv);
415 }
Georg Brandl61c31b02007-02-26 14:46:30 +0000416 return res;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000417}
418
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000419long
420PyLong_AsLong(PyObject *obj)
421{
422 int overflow;
423 long result = PyLong_AsLongAndOverflow(obj, &overflow);
424 if (overflow) {
425 /* XXX: could be cute and give a different
426 message for overflow == -1 */
427 PyErr_SetString(PyExc_OverflowError,
428 "Python int too large to convert to C long");
429 }
430 return result;
431}
432
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000433/* Get a Py_ssize_t from a long int object.
434 Returns -1 and sets an error condition if overflow occurs. */
435
436Py_ssize_t
Guido van Rossumddefaf32007-01-14 03:31:43 +0000437PyLong_AsSsize_t(PyObject *vv) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000438 register PyLongObject *v;
439 size_t x, prev;
440 Py_ssize_t i;
441 int sign;
442
443 if (vv == NULL || !PyLong_Check(vv)) {
444 PyErr_BadInternalCall();
445 return -1;
446 }
447 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000448 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000449 switch (i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000450 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +0000451 case 0: return 0;
452 case 1: return v->ob_digit[0];
453 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000454 sign = 1;
455 x = 0;
456 if (i < 0) {
457 sign = -1;
458 i = -(i);
459 }
460 while (--i >= 0) {
461 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000462 x = (x << PyLong_SHIFT) + v->ob_digit[i];
463 if ((x >> PyLong_SHIFT) != prev)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000464 goto overflow;
465 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000466 /* Haven't lost any bits, but casting to a signed type requires
467 * extra care (see comment above).
Martin v. Löwis18e16552006-02-15 17:27:45 +0000468 */
Thomas Wouters89f507f2006-12-13 04:49:30 +0000469 if (x <= (size_t)PY_SSIZE_T_MAX) {
470 return (Py_ssize_t)x * sign;
471 }
472 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
473 return PY_SSIZE_T_MIN;
474 }
475 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000476
477 overflow:
478 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000479 "Python int too large to convert to C ssize_t");
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000480 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000481}
482
Guido van Rossumd8c80482002-08-13 00:24:58 +0000483/* Get a C unsigned long int from a long int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000484 Returns -1 and sets an error condition if overflow occurs. */
485
486unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000487PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000488{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000489 register PyLongObject *v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000490 unsigned long x, prev;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000491 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000492
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000493 if (vv == NULL || !PyLong_Check(vv)) {
494 PyErr_BadInternalCall();
Guido van Rossum53756b11997-01-03 17:14:46 +0000495 return (unsigned long) -1;
496 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000498 i = Py_SIZE(v);
Guido van Rossum53756b11997-01-03 17:14:46 +0000499 x = 0;
500 if (i < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000501 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000502 "can't convert negative value to unsigned int");
Guido van Rossum53756b11997-01-03 17:14:46 +0000503 return (unsigned long) -1;
504 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000505 switch (i) {
506 case 0: return 0;
507 case 1: return v->ob_digit[0];
508 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000509 while (--i >= 0) {
510 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000511 x = (x << PyLong_SHIFT) + v->ob_digit[i];
512 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000513 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000514 "python int too large to convert to C unsigned long");
Guido van Rossumddefaf32007-01-14 03:31:43 +0000515 return (unsigned long) -1;
516 }
517 }
518 return x;
519}
520
521/* Get a C unsigned long int from a long int object.
522 Returns -1 and sets an error condition if overflow occurs. */
523
524size_t
525PyLong_AsSize_t(PyObject *vv)
526{
527 register PyLongObject *v;
528 size_t x, prev;
529 Py_ssize_t i;
530
531 if (vv == NULL || !PyLong_Check(vv)) {
532 PyErr_BadInternalCall();
533 return (unsigned long) -1;
534 }
535 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000536 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000537 x = 0;
538 if (i < 0) {
539 PyErr_SetString(PyExc_OverflowError,
540 "can't convert negative value to size_t");
541 return (size_t) -1;
542 }
543 switch (i) {
544 case 0: return 0;
545 case 1: return v->ob_digit[0];
546 }
547 while (--i >= 0) {
548 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000549 x = (x << PyLong_SHIFT) + v->ob_digit[i];
550 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000551 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000552 "Python int too large to convert to C size_t");
Guido van Rossum53756b11997-01-03 17:14:46 +0000553 return (unsigned long) -1;
554 }
555 }
556 return x;
557}
558
Thomas Hellera4ea6032003-04-17 18:55:45 +0000559/* Get a C unsigned long int from a long int object, ignoring the high bits.
560 Returns -1 and sets an error condition if an error occurs. */
561
Guido van Rossumddefaf32007-01-14 03:31:43 +0000562static unsigned long
563_PyLong_AsUnsignedLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +0000564{
565 register PyLongObject *v;
566 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000567 Py_ssize_t i;
568 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000569
570 if (vv == NULL || !PyLong_Check(vv)) {
571 PyErr_BadInternalCall();
572 return (unsigned long) -1;
573 }
574 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000575 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000576 switch (i) {
577 case 0: return 0;
578 case 1: return v->ob_digit[0];
579 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000580 sign = 1;
581 x = 0;
582 if (i < 0) {
583 sign = -1;
584 i = -i;
585 }
586 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000587 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +0000588 }
589 return x * sign;
590}
591
Guido van Rossumddefaf32007-01-14 03:31:43 +0000592unsigned long
593PyLong_AsUnsignedLongMask(register PyObject *op)
594{
595 PyNumberMethods *nb;
596 PyLongObject *lo;
597 unsigned long val;
598
599 if (op && PyLong_Check(op))
600 return _PyLong_AsUnsignedLongMask(op);
601
602 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
603 nb->nb_int == NULL) {
604 PyErr_SetString(PyExc_TypeError, "an integer is required");
605 return (unsigned long)-1;
606 }
607
608 lo = (PyLongObject*) (*nb->nb_int) (op);
609 if (lo == NULL)
610 return (unsigned long)-1;
611 if (PyLong_Check(lo)) {
612 val = _PyLong_AsUnsignedLongMask((PyObject *)lo);
613 Py_DECREF(lo);
614 if (PyErr_Occurred())
615 return (unsigned long)-1;
616 return val;
617 }
618 else
619 {
620 Py_DECREF(lo);
621 PyErr_SetString(PyExc_TypeError,
622 "nb_int should return int object");
623 return (unsigned long)-1;
624 }
625}
626
Tim Peters5b8132f2003-01-31 15:52:05 +0000627int
628_PyLong_Sign(PyObject *vv)
629{
630 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000631
632 assert(v != NULL);
633 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000634
Christian Heimes90aa7642007-12-19 02:45:37 +0000635 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000636}
637
Tim Petersbaefd9e2003-01-28 20:37:45 +0000638size_t
639_PyLong_NumBits(PyObject *vv)
640{
641 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000642 size_t result = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000643 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000644
645 assert(v != NULL);
646 assert(PyLong_Check(v));
Christian Heimes90aa7642007-12-19 02:45:37 +0000647 ndigits = ABS(Py_SIZE(v));
Tim Petersbaefd9e2003-01-28 20:37:45 +0000648 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
649 if (ndigits > 0) {
Tim Petersbaefd9e2003-01-28 20:37:45 +0000650 digit msd = v->ob_digit[ndigits - 1];
651
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000652 result = (ndigits - 1) * PyLong_SHIFT;
653 if (result / PyLong_SHIFT != (size_t)(ndigits - 1))
Tim Petersbaefd9e2003-01-28 20:37:45 +0000654 goto Overflow;
655 do {
656 ++result;
657 if (result == 0)
658 goto Overflow;
659 msd >>= 1;
660 } while (msd);
661 }
662 return result;
663
664Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000665 PyErr_SetString(PyExc_OverflowError, "int has too many bits "
Tim Petersbaefd9e2003-01-28 20:37:45 +0000666 "to express in a platform size_t");
667 return (size_t)-1;
668}
669
Tim Peters2a9b3672001-06-11 21:23:58 +0000670PyObject *
671_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
672 int little_endian, int is_signed)
673{
674 const unsigned char* pstartbyte;/* LSB of bytes */
675 int incr; /* direction to move pstartbyte */
676 const unsigned char* pendbyte; /* MSB of bytes */
677 size_t numsignificantbytes; /* number of bytes that matter */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000678 Py_ssize_t ndigits; /* number of Python long digits */
Tim Peters2a9b3672001-06-11 21:23:58 +0000679 PyLongObject* v; /* result */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000680 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000681
682 if (n == 0)
683 return PyLong_FromLong(0L);
684
685 if (little_endian) {
686 pstartbyte = bytes;
687 pendbyte = bytes + n - 1;
688 incr = 1;
689 }
690 else {
691 pstartbyte = bytes + n - 1;
692 pendbyte = bytes;
693 incr = -1;
694 }
695
696 if (is_signed)
697 is_signed = *pendbyte >= 0x80;
698
699 /* Compute numsignificantbytes. This consists of finding the most
700 significant byte. Leading 0 bytes are insignficant if the number
701 is positive, and leading 0xff bytes if negative. */
702 {
703 size_t i;
704 const unsigned char* p = pendbyte;
705 const int pincr = -incr; /* search MSB to LSB */
706 const unsigned char insignficant = is_signed ? 0xff : 0x00;
707
708 for (i = 0; i < n; ++i, p += pincr) {
709 if (*p != insignficant)
710 break;
711 }
712 numsignificantbytes = n - i;
713 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
714 actually has 2 significant bytes. OTOH, 0xff0001 ==
715 -0x00ffff, so we wouldn't *need* to bump it there; but we
716 do for 0xffff = -0x0001. To be safe without bothering to
717 check every case, bump it regardless. */
718 if (is_signed && numsignificantbytes < n)
719 ++numsignificantbytes;
720 }
721
722 /* How many Python long digits do we need? We have
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000723 8*numsignificantbytes bits, and each Python long digit has
724 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
725 /* catch overflow before it happens */
726 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
727 PyErr_SetString(PyExc_OverflowError,
728 "byte array too long to convert to int");
729 return NULL;
730 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000731 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000732 v = _PyLong_New(ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000733 if (v == NULL)
734 return NULL;
735
736 /* Copy the bits over. The tricky parts are computing 2's-comp on
737 the fly for signed numbers, and dealing with the mismatch between
738 8-bit bytes and (probably) 15-bit Python digits.*/
739 {
740 size_t i;
Tim Petersf251d062001-06-13 21:09:15 +0000741 twodigits carry = 1; /* for 2's-comp calculation */
Tim Peters2a9b3672001-06-11 21:23:58 +0000742 twodigits accum = 0; /* sliding register */
743 unsigned int accumbits = 0; /* number of bits in accum */
744 const unsigned char* p = pstartbyte;
745
746 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
Tim Peters8bc84b42001-06-12 19:17:03 +0000747 twodigits thisbyte = *p;
Tim Peters2a9b3672001-06-11 21:23:58 +0000748 /* Compute correction for 2's comp, if needed. */
749 if (is_signed) {
750 thisbyte = (0xff ^ thisbyte) + carry;
751 carry = thisbyte >> 8;
752 thisbyte &= 0xff;
753 }
754 /* Because we're going LSB to MSB, thisbyte is
755 more significant than what's already in accum,
756 so needs to be prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000757 accum |= (twodigits)thisbyte << accumbits;
Tim Peters2a9b3672001-06-11 21:23:58 +0000758 accumbits += 8;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000759 if (accumbits >= PyLong_SHIFT) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000760 /* There's enough to fill a Python digit. */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000761 assert(idigit < ndigits);
762 v->ob_digit[idigit] = (digit)(accum &
763 PyLong_MASK);
Tim Peters2a9b3672001-06-11 21:23:58 +0000764 ++idigit;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000765 accum >>= PyLong_SHIFT;
766 accumbits -= PyLong_SHIFT;
767 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000768 }
769 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000770 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000771 if (accumbits) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000772 assert(idigit < ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000773 v->ob_digit[idigit] = (digit)accum;
774 ++idigit;
775 }
776 }
777
Christian Heimes90aa7642007-12-19 02:45:37 +0000778 Py_SIZE(v) = is_signed ? -idigit : idigit;
Tim Peters2a9b3672001-06-11 21:23:58 +0000779 return (PyObject *)long_normalize(v);
780}
781
782int
783_PyLong_AsByteArray(PyLongObject* v,
784 unsigned char* bytes, size_t n,
785 int little_endian, int is_signed)
786{
Mark Dickinson17e55872009-01-24 15:56:57 +0000787 Py_ssize_t i; /* index into v->ob_digit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000788 Py_ssize_t ndigits; /* |v->ob_size| */
Tim Peters2a9b3672001-06-11 21:23:58 +0000789 twodigits accum; /* sliding register */
790 unsigned int accumbits; /* # bits in accum */
791 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
Mark Dickinson1e2d8702009-01-25 22:25:06 +0000792 digit carry; /* for computing 2's-comp */
Tim Peters2a9b3672001-06-11 21:23:58 +0000793 size_t j; /* # bytes filled */
794 unsigned char* p; /* pointer to next byte in bytes */
795 int pincr; /* direction to move p */
796
797 assert(v != NULL && PyLong_Check(v));
798
Christian Heimes90aa7642007-12-19 02:45:37 +0000799 if (Py_SIZE(v) < 0) {
800 ndigits = -(Py_SIZE(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000801 if (!is_signed) {
Mark Dickinson21776072009-02-10 16:13:25 +0000802 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000803 "can't convert negative int to unsigned");
Tim Peters2a9b3672001-06-11 21:23:58 +0000804 return -1;
805 }
806 do_twos_comp = 1;
807 }
808 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000809 ndigits = Py_SIZE(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000810 do_twos_comp = 0;
811 }
812
813 if (little_endian) {
814 p = bytes;
815 pincr = 1;
816 }
817 else {
818 p = bytes + n - 1;
819 pincr = -1;
820 }
821
Tim Peters898cf852001-06-13 20:50:08 +0000822 /* Copy over all the Python digits.
823 It's crucial that every Python digit except for the MSD contribute
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000824 exactly PyLong_SHIFT bits to the total, so first assert that the long is
Tim Peters898cf852001-06-13 20:50:08 +0000825 normalized. */
826 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
Tim Peters2a9b3672001-06-11 21:23:58 +0000827 j = 0;
828 accum = 0;
829 accumbits = 0;
830 carry = do_twos_comp ? 1 : 0;
831 for (i = 0; i < ndigits; ++i) {
Mark Dickinson17e55872009-01-24 15:56:57 +0000832 digit thisdigit = v->ob_digit[i];
Tim Peters2a9b3672001-06-11 21:23:58 +0000833 if (do_twos_comp) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000834 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
835 carry = thisdigit >> PyLong_SHIFT;
836 thisdigit &= PyLong_MASK;
Tim Peters2a9b3672001-06-11 21:23:58 +0000837 }
Tim Peters8bc84b42001-06-12 19:17:03 +0000838 /* Because we're going LSB to MSB, thisdigit is more
839 significant than what's already in accum, so needs to be
840 prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000841 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000842
Tim Petersede05092001-06-14 08:53:38 +0000843 /* The most-significant digit may be (probably is) at least
844 partly empty. */
Tim Peters8bc84b42001-06-12 19:17:03 +0000845 if (i == ndigits - 1) {
Tim Petersede05092001-06-14 08:53:38 +0000846 /* Count # of sign bits -- they needn't be stored,
847 * although for signed conversion we need later to
Mark Dickinson17e55872009-01-24 15:56:57 +0000848 * make sure at least one sign bit gets stored. */
849 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK :
850 thisdigit;
851 while (s != 0) {
852 s >>= 1;
853 accumbits++;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000854 }
Tim Peters7a3bfc32001-06-12 01:22:22 +0000855 }
Mark Dickinson17e55872009-01-24 15:56:57 +0000856 else
857 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000858
Tim Peters2a9b3672001-06-11 21:23:58 +0000859 /* Store as many bytes as possible. */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000860 while (accumbits >= 8) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000861 if (j >= n)
862 goto Overflow;
863 ++j;
864 *p = (unsigned char)(accum & 0xff);
865 p += pincr;
866 accumbits -= 8;
867 accum >>= 8;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000868 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000869 }
870
871 /* Store the straggler (if any). */
872 assert(accumbits < 8);
873 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000874 if (accumbits > 0) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000875 if (j >= n)
876 goto Overflow;
877 ++j;
878 if (do_twos_comp) {
879 /* Fill leading bits of the byte with sign bits
880 (appropriately pretending that the long had an
881 infinite supply of sign bits). */
882 accum |= (~(twodigits)0) << accumbits;
883 }
884 *p = (unsigned char)(accum & 0xff);
885 p += pincr;
886 }
Tim Peters05607ad2001-06-13 21:01:27 +0000887 else if (j == n && n > 0 && is_signed) {
888 /* The main loop filled the byte array exactly, so the code
889 just above didn't get to ensure there's a sign bit, and the
890 loop below wouldn't add one either. Make sure a sign bit
891 exists. */
Tim Peters2a9b3672001-06-11 21:23:58 +0000892 unsigned char msb = *(p - pincr);
Tim Peters05607ad2001-06-13 21:01:27 +0000893 int sign_bit_set = msb >= 0x80;
894 assert(accumbits == 0);
895 if (sign_bit_set == do_twos_comp)
896 return 0;
897 else
Tim Peters2a9b3672001-06-11 21:23:58 +0000898 goto Overflow;
899 }
Tim Peters05607ad2001-06-13 21:01:27 +0000900
901 /* Fill remaining bytes with copies of the sign bit. */
902 {
903 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
904 for ( ; j < n; ++j, p += pincr)
905 *p = signbyte;
906 }
907
Tim Peters2a9b3672001-06-11 21:23:58 +0000908 return 0;
909
910Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000911 PyErr_SetString(PyExc_OverflowError, "int too big to convert");
Tim Peters2a9b3672001-06-11 21:23:58 +0000912 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000913
Tim Peters2a9b3672001-06-11 21:23:58 +0000914}
915
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000916double
917_PyLong_AsScaledDouble(PyObject *vv, int *exponent)
918{
919/* NBITS_WANTED should be > the number of bits in a double's precision,
920 but small enough so that 2**NBITS_WANTED is within the normal double
921 range. nbitsneeded is set to 1 less than that because the most-significant
922 Python digit contains at least 1 significant bit, but we don't want to
923 bother counting them (catering to the worst case cheaply).
924
925 57 is one more than VAX-D double precision; I (Tim) don't know of a double
926 format with more precision than that; it's 1 larger so that we add in at
927 least one round bit to stand in for the ignored least-significant bits.
928*/
929#define NBITS_WANTED 57
930 PyLongObject *v;
931 double x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000932 const double multiplier = (double)(1L << PyLong_SHIFT);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000933 Py_ssize_t i;
934 int sign;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000935 int nbitsneeded;
936
937 if (vv == NULL || !PyLong_Check(vv)) {
938 PyErr_BadInternalCall();
939 return -1;
940 }
941 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000942 i = Py_SIZE(v);
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000943 sign = 1;
944 if (i < 0) {
945 sign = -1;
946 i = -(i);
947 }
948 else if (i == 0) {
949 *exponent = 0;
950 return 0.0;
951 }
952 --i;
953 x = (double)v->ob_digit[i];
954 nbitsneeded = NBITS_WANTED - 1;
955 /* Invariant: i Python digits remain unaccounted for. */
956 while (i > 0 && nbitsneeded > 0) {
957 --i;
958 x = x * multiplier + (double)v->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000959 nbitsneeded -= PyLong_SHIFT;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000960 }
961 /* There are i digits we didn't shift in. Pretending they're all
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000962 zeroes, the true value is x * 2**(i*PyLong_SHIFT). */
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000963 *exponent = i;
964 assert(x > 0.0);
965 return x * sign;
966#undef NBITS_WANTED
967}
968
Mark Dickinsonc6300392009-04-20 21:38:00 +0000969/* Get a C double from a long int object. Rounds to the nearest double,
970 using the round-half-to-even rule in the case of a tie. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000971
972double
Tim Peters9f688bf2000-07-07 15:53:28 +0000973PyLong_AsDouble(PyObject *vv)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000974{
Mark Dickinsonc6300392009-04-20 21:38:00 +0000975 PyLongObject *v = (PyLongObject *)vv;
976 Py_ssize_t rnd_digit, rnd_bit, m, n;
977 digit lsb, *d;
978 int round_up = 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000979 double x;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000980
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000981 if (vv == NULL || !PyLong_Check(vv)) {
982 PyErr_BadInternalCall();
Tim Peters9fffa3e2001-09-04 05:14:19 +0000983 return -1.0;
Mark Dickinsonc6300392009-04-20 21:38:00 +0000984 }
Tim Peters9fffa3e2001-09-04 05:14:19 +0000985
Mark Dickinsonc6300392009-04-20 21:38:00 +0000986 /* Notes on the method: for simplicity, assume v is positive and >=
987 2**DBL_MANT_DIG. (For negative v we just ignore the sign until the
988 end; for small v no rounding is necessary.) Write n for the number
989 of bits in v, so that 2**(n-1) <= v < 2**n, and n > DBL_MANT_DIG.
990
991 Some terminology: the *rounding bit* of v is the 1st bit of v that
992 will be rounded away (bit n - DBL_MANT_DIG - 1); the *parity bit*
993 is the bit immediately above. The round-half-to-even rule says
994 that we round up if the rounding bit is set, unless v is exactly
995 halfway between two floats and the parity bit is zero.
996
997 Write d[0] ... d[m] for the digits of v, least to most significant.
998 Let rnd_bit be the index of the rounding bit, and rnd_digit the
999 index of the PyLong digit containing the rounding bit. Then the
1000 bits of the digit d[rnd_digit] look something like:
1001
1002 rounding bit
1003 |
1004 v
1005 msb -> sssssrttttttttt <- lsb
1006 ^
1007 |
1008 parity bit
1009
1010 where 's' represents a 'significant bit' that will be included in
1011 the mantissa of the result, 'r' is the rounding bit, and 't'
1012 represents a 'trailing bit' following the rounding bit. Note that
1013 if the rounding bit is at the top of d[rnd_digit] then the parity
1014 bit will be the lsb of d[rnd_digit+1]. If we set
1015
1016 lsb = 1 << (rnd_bit % PyLong_SHIFT)
1017
1018 then d[rnd_digit] & (PyLong_BASE - 2*lsb) selects just the
1019 significant bits of d[rnd_digit], d[rnd_digit] & (lsb-1) gets the
1020 trailing bits, and d[rnd_digit] & lsb gives the rounding bit.
1021
1022 We initialize the double x to the integer given by digits
1023 d[rnd_digit:m-1], but with the rounding bit and trailing bits of
1024 d[rnd_digit] masked out. So the value of x comes from the top
1025 DBL_MANT_DIG bits of v, multiplied by 2*lsb. Note that in the loop
1026 that produces x, all floating-point operations are exact (assuming
1027 that FLT_RADIX==2). Now if we're rounding down, the value we want
1028 to return is simply
1029
1030 x * 2**(PyLong_SHIFT * rnd_digit).
1031
1032 and if we're rounding up, it's
1033
1034 (x + 2*lsb) * 2**(PyLong_SHIFT * rnd_digit).
1035
1036 Under the round-half-to-even rule, we round up if, and only
1037 if, the rounding bit is set *and* at least one of the
1038 following three conditions is satisfied:
1039
1040 (1) the parity bit is set, or
1041 (2) at least one of the trailing bits of d[rnd_digit] is set, or
1042 (3) at least one of the digits d[i], 0 <= i < rnd_digit
1043 is nonzero.
1044
1045 Finally, we have to worry about overflow. If v >= 2**DBL_MAX_EXP,
1046 or equivalently n > DBL_MAX_EXP, then overflow occurs. If v <
1047 2**DBL_MAX_EXP then we're usually safe, but there's a corner case
1048 to consider: if v is very close to 2**DBL_MAX_EXP then it's
1049 possible that v is rounded up to exactly 2**DBL_MAX_EXP, and then
1050 again overflow occurs.
1051 */
1052
1053 if (Py_SIZE(v) == 0)
1054 return 0.0;
1055 m = ABS(Py_SIZE(v)) - 1;
1056 d = v->ob_digit;
1057 assert(d[m]); /* v should be normalized */
1058
1059 /* fast path for case where 0 < abs(v) < 2**DBL_MANT_DIG */
1060 if (m < DBL_MANT_DIG / PyLong_SHIFT ||
1061 (m == DBL_MANT_DIG / PyLong_SHIFT &&
1062 d[m] < (digit)1 << DBL_MANT_DIG%PyLong_SHIFT)) {
1063 x = d[m];
1064 while (--m >= 0)
1065 x = x*PyLong_BASE + d[m];
1066 return Py_SIZE(v) < 0 ? -x : x;
1067 }
1068
1069 /* if m is huge then overflow immediately; otherwise, compute the
1070 number of bits n in v. The condition below implies n (= #bits) >=
1071 m * PyLong_SHIFT + 1 > DBL_MAX_EXP, hence v >= 2**DBL_MAX_EXP. */
1072 if (m > (DBL_MAX_EXP-1)/PyLong_SHIFT)
1073 goto overflow;
1074 n = m * PyLong_SHIFT + bits_in_digit(d[m]);
1075 if (n > DBL_MAX_EXP)
1076 goto overflow;
1077
1078 /* find location of rounding bit */
1079 assert(n > DBL_MANT_DIG); /* dealt with |v| < 2**DBL_MANT_DIG above */
1080 rnd_bit = n - DBL_MANT_DIG - 1;
1081 rnd_digit = rnd_bit/PyLong_SHIFT;
1082 lsb = (digit)1 << (rnd_bit%PyLong_SHIFT);
1083
1084 /* Get top DBL_MANT_DIG bits of v. Assumes PyLong_SHIFT <
1085 DBL_MANT_DIG, so we'll need bits from at least 2 digits of v. */
1086 x = d[m];
1087 assert(m > rnd_digit);
1088 while (--m > rnd_digit)
1089 x = x*PyLong_BASE + d[m];
1090 x = x*PyLong_BASE + (d[m] & (PyLong_BASE-2*lsb));
1091
1092 /* decide whether to round up, using round-half-to-even */
1093 assert(m == rnd_digit);
1094 if (d[m] & lsb) { /* if (rounding bit is set) */
1095 digit parity_bit;
1096 if (lsb == PyLong_BASE/2)
1097 parity_bit = d[m+1] & 1;
1098 else
1099 parity_bit = d[m] & 2*lsb;
1100 if (parity_bit)
1101 round_up = 1;
1102 else if (d[m] & (lsb-1))
1103 round_up = 1;
1104 else {
1105 while (--m >= 0) {
1106 if (d[m]) {
1107 round_up = 1;
1108 break;
1109 }
1110 }
1111 }
1112 }
1113
1114 /* and round up if necessary */
1115 if (round_up) {
1116 x += 2*lsb;
1117 if (n == DBL_MAX_EXP &&
1118 x == ldexp((double)(2*lsb), DBL_MANT_DIG)) {
1119 /* overflow corner case */
1120 goto overflow;
1121 }
1122 }
1123
1124 /* shift, adjust for sign, and return */
1125 x = ldexp(x, rnd_digit*PyLong_SHIFT);
1126 return Py_SIZE(v) < 0 ? -x : x;
1127
1128 overflow:
Tim Peters9fffa3e2001-09-04 05:14:19 +00001129 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +00001130 "Python int too large to convert to C double");
Tim Peters9fffa3e2001-09-04 05:14:19 +00001131 return -1.0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001132}
1133
Guido van Rossum78694d91998-09-18 14:14:13 +00001134/* Create a new long (or int) object from a C pointer */
1135
1136PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001137PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +00001138{
Tim Peters70128a12001-06-16 08:48:40 +00001139#ifndef HAVE_LONG_LONG
1140# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1141#endif
1142#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001143# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001144#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +00001145 /* special-case null pointer */
1146 if (!p)
Christian Heimes217cfd12007-12-02 14:31:20 +00001147 return PyLong_FromLong(0);
Guido van Rossumddefaf32007-01-14 03:31:43 +00001148 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)(Py_uintptr_t)p);
Tim Peters70128a12001-06-16 08:48:40 +00001149
Guido van Rossum78694d91998-09-18 14:14:13 +00001150}
1151
1152/* Get a C pointer from a long object (or an int object in some cases) */
1153
1154void *
Tim Peters9f688bf2000-07-07 15:53:28 +00001155PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +00001156{
1157 /* This function will allow int or long objects. If vv is neither,
1158 then the PyLong_AsLong*() functions will raise the exception:
1159 PyExc_SystemError, "bad argument to internal function"
1160 */
Tim Peters70128a12001-06-16 08:48:40 +00001161#if SIZEOF_VOID_P <= SIZEOF_LONG
Guido van Rossum78694d91998-09-18 14:14:13 +00001162 long x;
1163
Guido van Rossumddefaf32007-01-14 03:31:43 +00001164 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001165 x = PyLong_AsLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001166 else
1167 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +00001168#else
Tim Peters70128a12001-06-16 08:48:40 +00001169
1170#ifndef HAVE_LONG_LONG
1171# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1172#endif
1173#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001174# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001175#endif
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001176 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001177
Guido van Rossumddefaf32007-01-14 03:31:43 +00001178 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001179 x = PyLong_AsLongLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001180 else
1181 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +00001182
1183#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +00001184
1185 if (x == -1 && PyErr_Occurred())
1186 return NULL;
1187 return (void *)x;
1188}
1189
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001190#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +00001191
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001192/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +00001193 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001194 */
1195
Tim Peterscf37dfc2001-06-14 18:42:50 +00001196#define IS_LITTLE_ENDIAN (int)*(unsigned char*)&one
Tim Petersd1a7da62001-06-13 00:35:57 +00001197
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001198/* Create a new long int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001199
1200PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001201PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001202{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001203 PyLongObject *v;
Christian Heimesdae2a892008-04-19 00:55:37 +00001204 unsigned PY_LONG_LONG abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
1206 int ndigits = 0;
1207 int negative = 0;
1208
Guido van Rossumddefaf32007-01-14 03:31:43 +00001209 CHECK_SMALL_INT(ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001210 if (ival < 0) {
Christian Heimesdae2a892008-04-19 00:55:37 +00001211 /* avoid signed overflow on negation; see comments
1212 in PyLong_FromLong above. */
1213 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001214 negative = 1;
1215 }
Christian Heimesdae2a892008-04-19 00:55:37 +00001216 else {
1217 abs_ival = (unsigned PY_LONG_LONG)ival;
1218 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001219
1220 /* Count the number of Python digits.
1221 We used to pick 5 ("big enough for anything"), but that's a
1222 waste of time and space given that 5*15 = 75 bits are rarely
1223 needed. */
Christian Heimesdae2a892008-04-19 00:55:37 +00001224 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001225 while (t) {
1226 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001227 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 }
1229 v = _PyLong_New(ndigits);
1230 if (v != NULL) {
1231 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001232 Py_SIZE(v) = negative ? -ndigits : ndigits;
Christian Heimesdae2a892008-04-19 00:55:37 +00001233 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 while (t) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001235 *p++ = (digit)(t & PyLong_MASK);
1236 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001237 }
1238 }
1239 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001240}
1241
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001242/* Create a new long int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001243
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001244PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001245PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001246{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001247 PyLongObject *v;
1248 unsigned PY_LONG_LONG t;
1249 int ndigits = 0;
1250
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001251 if (ival < PyLong_BASE)
Mark Dickinson50b2b6e2008-12-05 17:14:29 +00001252 return PyLong_FromLong((long)ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001253 /* Count the number of Python digits. */
1254 t = (unsigned PY_LONG_LONG)ival;
1255 while (t) {
1256 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001257 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001258 }
1259 v = _PyLong_New(ndigits);
1260 if (v != NULL) {
1261 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001262 Py_SIZE(v) = ndigits;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001263 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001264 *p++ = (digit)(ival & PyLong_MASK);
1265 ival >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 }
1267 }
1268 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001269}
1270
Martin v. Löwis18e16552006-02-15 17:27:45 +00001271/* Create a new long int object from a C Py_ssize_t. */
1272
1273PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001274PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001275{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001276 PyLongObject *v;
1277 size_t abs_ival;
1278 size_t t; /* unsigned so >> doesn't propagate sign bit */
1279 int ndigits = 0;
1280 int negative = 0;
1281
1282 CHECK_SMALL_INT(ival);
1283 if (ival < 0) {
1284 /* avoid signed overflow when ival = SIZE_T_MIN */
1285 abs_ival = (size_t)(-1-ival)+1;
1286 negative = 1;
1287 }
1288 else {
1289 abs_ival = (size_t)ival;
1290 }
1291
1292 /* Count the number of Python digits. */
1293 t = abs_ival;
1294 while (t) {
1295 ++ndigits;
1296 t >>= PyLong_SHIFT;
1297 }
1298 v = _PyLong_New(ndigits);
1299 if (v != NULL) {
1300 digit *p = v->ob_digit;
1301 Py_SIZE(v) = negative ? -ndigits : ndigits;
1302 t = abs_ival;
1303 while (t) {
1304 *p++ = (digit)(t & PyLong_MASK);
1305 t >>= PyLong_SHIFT;
1306 }
1307 }
1308 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001309}
1310
1311/* Create a new long int object from a C size_t. */
1312
1313PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001314PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001315{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001316 PyLongObject *v;
1317 size_t t;
1318 int ndigits = 0;
1319
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001320 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +00001321 return PyLong_FromLong(ival);
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001322 /* Count the number of Python digits. */
1323 t = ival;
1324 while (t) {
1325 ++ndigits;
1326 t >>= PyLong_SHIFT;
1327 }
1328 v = _PyLong_New(ndigits);
1329 if (v != NULL) {
1330 digit *p = v->ob_digit;
1331 Py_SIZE(v) = ndigits;
1332 while (ival) {
1333 *p++ = (digit)(ival & PyLong_MASK);
1334 ival >>= PyLong_SHIFT;
1335 }
1336 }
1337 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001338}
1339
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001340/* Get a C PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001341 Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001342
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001343PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001344PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001345{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001346 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001347 PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001348 int one = 1;
1349 int res;
1350
Tim Petersd38b1c72001-09-30 05:09:37 +00001351 if (vv == NULL) {
1352 PyErr_BadInternalCall();
1353 return -1;
1354 }
1355 if (!PyLong_Check(vv)) {
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001356 PyNumberMethods *nb;
1357 PyObject *io;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001358 if ((nb = vv->ob_type->tp_as_number) == NULL ||
1359 nb->nb_int == NULL) {
1360 PyErr_SetString(PyExc_TypeError, "an integer is required");
1361 return -1;
1362 }
1363 io = (*nb->nb_int) (vv);
1364 if (io == NULL)
1365 return -1;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001366 if (PyLong_Check(io)) {
1367 bytes = PyLong_AsLongLong(io);
1368 Py_DECREF(io);
1369 return bytes;
1370 }
1371 Py_DECREF(io);
1372 PyErr_SetString(PyExc_TypeError, "integer conversion failed");
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001373 return -1;
1374 }
1375
Guido van Rossumddefaf32007-01-14 03:31:43 +00001376 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001377 switch(Py_SIZE(v)) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00001378 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00001379 case 0: return 0;
1380 case 1: return v->ob_digit[0];
1381 }
Tim Petersd1a7da62001-06-13 00:35:57 +00001382 res = _PyLong_AsByteArray(
1383 (PyLongObject *)vv, (unsigned char *)&bytes,
1384 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 1);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001385
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001386 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001387 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001388 return (PY_LONG_LONG)-1;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001389 else
1390 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001391}
1392
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001393/* Get a C unsigned PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001394 Return -1 and set an error if overflow occurs. */
1395
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001396unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001397PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001398{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001399 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001400 unsigned PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001401 int one = 1;
1402 int res;
1403
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001404 if (vv == NULL || !PyLong_Check(vv)) {
1405 PyErr_BadInternalCall();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001406 return (unsigned PY_LONG_LONG)-1;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001407 }
1408
Guido van Rossumddefaf32007-01-14 03:31:43 +00001409 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001410 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001411 case 0: return 0;
1412 case 1: return v->ob_digit[0];
1413 }
1414
Tim Petersd1a7da62001-06-13 00:35:57 +00001415 res = _PyLong_AsByteArray(
1416 (PyLongObject *)vv, (unsigned char *)&bytes,
1417 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001418
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001419 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001420 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001421 return (unsigned PY_LONG_LONG)res;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001422 else
1423 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001424}
Tim Petersd1a7da62001-06-13 00:35:57 +00001425
Thomas Hellera4ea6032003-04-17 18:55:45 +00001426/* Get a C unsigned long int from a long int object, ignoring the high bits.
1427 Returns -1 and sets an error condition if an error occurs. */
1428
Guido van Rossumddefaf32007-01-14 03:31:43 +00001429static unsigned PY_LONG_LONG
1430_PyLong_AsUnsignedLongLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +00001431{
1432 register PyLongObject *v;
1433 unsigned PY_LONG_LONG x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001434 Py_ssize_t i;
1435 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001436
1437 if (vv == NULL || !PyLong_Check(vv)) {
1438 PyErr_BadInternalCall();
1439 return (unsigned long) -1;
1440 }
1441 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001442 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001443 case 0: return 0;
1444 case 1: return v->ob_digit[0];
1445 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001446 i = Py_SIZE(v);
Thomas Hellera4ea6032003-04-17 18:55:45 +00001447 sign = 1;
1448 x = 0;
1449 if (i < 0) {
1450 sign = -1;
1451 i = -i;
1452 }
1453 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001454 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +00001455 }
1456 return x * sign;
1457}
Guido van Rossumddefaf32007-01-14 03:31:43 +00001458
1459unsigned PY_LONG_LONG
1460PyLong_AsUnsignedLongLongMask(register PyObject *op)
1461{
1462 PyNumberMethods *nb;
1463 PyLongObject *lo;
1464 unsigned PY_LONG_LONG val;
1465
1466 if (op && PyLong_Check(op))
1467 return _PyLong_AsUnsignedLongLongMask(op);
1468
1469 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
1470 nb->nb_int == NULL) {
1471 PyErr_SetString(PyExc_TypeError, "an integer is required");
1472 return (unsigned PY_LONG_LONG)-1;
1473 }
1474
1475 lo = (PyLongObject*) (*nb->nb_int) (op);
1476 if (lo == NULL)
1477 return (unsigned PY_LONG_LONG)-1;
1478 if (PyLong_Check(lo)) {
1479 val = _PyLong_AsUnsignedLongLongMask((PyObject *)lo);
1480 Py_DECREF(lo);
1481 if (PyErr_Occurred())
1482 return (unsigned PY_LONG_LONG)-1;
1483 return val;
1484 }
1485 else
1486 {
1487 Py_DECREF(lo);
1488 PyErr_SetString(PyExc_TypeError,
1489 "nb_int should return int object");
1490 return (unsigned PY_LONG_LONG)-1;
1491 }
1492}
Tim Petersd1a7da62001-06-13 00:35:57 +00001493#undef IS_LITTLE_ENDIAN
1494
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001495#endif /* HAVE_LONG_LONG */
1496
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00001497#define CHECK_BINOP(v,w) \
1498 if (!PyLong_Check(v) || !PyLong_Check(w)) { \
Neil Schemenauerba872e22001-01-04 01:46:03 +00001499 Py_INCREF(Py_NotImplemented); \
1500 return Py_NotImplemented; \
1501 }
1502
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001503/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1504 2**k if d is nonzero, else 0. */
1505
1506static const unsigned char BitLengthTable[32] = {
1507 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1508 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
1509};
1510
1511static int
1512bits_in_digit(digit d)
1513{
1514 int d_bits = 0;
1515 while (d >= 32) {
1516 d_bits += 6;
1517 d >>= 6;
1518 }
1519 d_bits += (int)BitLengthTable[d];
1520 return d_bits;
1521}
1522
Tim Peters877a2122002-08-12 05:09:36 +00001523/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1524 * is modified in place, by adding y to it. Carries are propagated as far as
1525 * x[m-1], and the remaining carry (0 or 1) is returned.
1526 */
1527static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001528v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001529{
Mark Dickinson17e55872009-01-24 15:56:57 +00001530 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001531 digit carry = 0;
1532
1533 assert(m >= n);
1534 for (i = 0; i < n; ++i) {
1535 carry += x[i] + y[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001536 x[i] = carry & PyLong_MASK;
1537 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001538 assert((carry & 1) == carry);
1539 }
1540 for (; carry && i < m; ++i) {
1541 carry += x[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001542 x[i] = carry & PyLong_MASK;
1543 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001544 assert((carry & 1) == carry);
1545 }
1546 return carry;
1547}
1548
1549/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1550 * is modified in place, by subtracting y from it. Borrows are propagated as
1551 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1552 */
1553static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001555{
Mark Dickinson17e55872009-01-24 15:56:57 +00001556 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001557 digit borrow = 0;
1558
1559 assert(m >= n);
1560 for (i = 0; i < n; ++i) {
1561 borrow = x[i] - y[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001562 x[i] = borrow & PyLong_MASK;
1563 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001564 borrow &= 1; /* keep only 1 sign bit */
1565 }
1566 for (; borrow && i < m; ++i) {
1567 borrow = x[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001568 x[i] = borrow & PyLong_MASK;
1569 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001570 borrow &= 1;
1571 }
1572 return borrow;
1573}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001574
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001575/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1576 * result in z[0:m], and return the d bits shifted out of the top.
1577 */
1578static digit
1579v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001580{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581 Py_ssize_t i;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001582 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001583
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001584 assert(0 <= d && d < PyLong_SHIFT);
1585 for (i=0; i < m; i++) {
1586 twodigits acc = (twodigits)a[i] << d | carry;
1587 z[i] = (digit)acc & PyLong_MASK;
1588 carry = (digit)(acc >> PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001589 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001590 return carry;
1591}
1592
1593/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1594 * result in z[0:m], and return the d bits shifted out of the bottom.
1595 */
1596static digit
1597v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1598{
1599 Py_ssize_t i;
1600 digit carry = 0;
1601 digit mask = ((digit)1 << d) - 1U;
1602
1603 assert(0 <= d && d < PyLong_SHIFT);
1604 for (i=m; i-- > 0;) {
1605 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1606 carry = (digit)acc & mask;
1607 z[i] = (digit)(acc >> d);
1608 }
1609 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001610}
1611
Tim Peters212e6142001-07-14 12:23:19 +00001612/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1613 in pout, and returning the remainder. pin and pout point at the LSD.
1614 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001615 _PyLong_Format, but that should be done with great care since longs are
Tim Peters212e6142001-07-14 12:23:19 +00001616 immutable. */
1617
1618static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001619inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001620{
1621 twodigits rem = 0;
1622
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001623 assert(n > 0 && n <= PyLong_MASK);
Tim Peters212e6142001-07-14 12:23:19 +00001624 pin += size;
1625 pout += size;
1626 while (--size >= 0) {
1627 digit hi;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001628 rem = (rem << PyLong_SHIFT) + *--pin;
Tim Peters212e6142001-07-14 12:23:19 +00001629 *--pout = hi = (digit)(rem / n);
Mark Dickinson17e55872009-01-24 15:56:57 +00001630 rem -= (twodigits)hi * n;
Tim Peters212e6142001-07-14 12:23:19 +00001631 }
1632 return (digit)rem;
1633}
1634
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001635/* Divide a long integer by a digit, returning both the quotient
1636 (as function result) and the remainder (through *prem).
1637 The sign of a is ignored; n should not be zero. */
1638
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001640divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001641{
Christian Heimes90aa7642007-12-19 02:45:37 +00001642 const Py_ssize_t size = ABS(Py_SIZE(a));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001644
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001645 assert(n > 0 && n <= PyLong_MASK);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 z = _PyLong_New(size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001647 if (z == NULL)
1648 return NULL;
Tim Peters212e6142001-07-14 12:23:19 +00001649 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001650 return long_normalize(z);
1651}
1652
1653/* Convert a long int object to a string, using a given conversion base.
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001654 Return a string object.
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001655 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001656
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001657PyObject *
1658_PyLong_Format(PyObject *aa, int base)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001659{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001660 register PyLongObject *a = (PyLongObject *)aa;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001661 PyObject *str;
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001662 Py_ssize_t i, sz;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001663 Py_ssize_t size_a;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001664 Py_UNICODE *p;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001665 int bits;
1666 char sign = '\0';
Guido van Rossume32e0141992-01-19 16:31:05 +00001667
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001668 if (a == NULL || !PyLong_Check(a)) {
1669 PyErr_BadInternalCall();
Guido van Rossume32e0141992-01-19 16:31:05 +00001670 return NULL;
1671 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001672 assert(base >= 2 && base <= 36);
Christian Heimes90aa7642007-12-19 02:45:37 +00001673 size_a = ABS(Py_SIZE(a));
Tim Peters5af4e6c2002-08-12 02:31:19 +00001674
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001675 /* Compute a rough upper bound for the length of the string */
1676 i = base;
1677 bits = 0;
1678 while (i > 1) {
1679 ++bits;
1680 i >>= 1;
1681 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001682 i = 5;
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001683 /* ensure we don't get signed overflow in sz calculation */
1684 if (size_a > (PY_SSIZE_T_MAX - i) / PyLong_SHIFT) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001685 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001686 "int is too large to format");
Thomas Wouters89f507f2006-12-13 04:49:30 +00001687 return NULL;
1688 }
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001689 sz = i + 1 + (size_a * PyLong_SHIFT - 1) / bits;
1690 assert(sz >= 0);
Walter Dörwald1ab83302007-05-18 17:15:44 +00001691 str = PyUnicode_FromUnicode(NULL, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001692 if (str == NULL)
1693 return NULL;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001694 p = PyUnicode_AS_UNICODE(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001695 *p = '\0';
Christian Heimes90aa7642007-12-19 02:45:37 +00001696 if (Py_SIZE(a) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00001697 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001698
Christian Heimes90aa7642007-12-19 02:45:37 +00001699 if (Py_SIZE(a) == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001700 *--p = '0';
1701 }
1702 else if ((base & (base - 1)) == 0) {
1703 /* JRH: special case for power-of-2 bases */
Tim Peters586b2e32001-07-15 09:11:14 +00001704 twodigits accum = 0;
1705 int accumbits = 0; /* # of bits in accum */
1706 int basebits = 1; /* # of bits in base-1 */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001707 i = base;
Tim Peters7d3a5112000-07-08 04:17:21 +00001708 while ((i >>= 1) > 1)
1709 ++basebits;
Tim Peters586b2e32001-07-15 09:11:14 +00001710
1711 for (i = 0; i < size_a; ++i) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00001712 accum |= (twodigits)a->ob_digit[i] << accumbits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001713 accumbits += PyLong_SHIFT;
Tim Peters586b2e32001-07-15 09:11:14 +00001714 assert(accumbits >= basebits);
1715 do {
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001716 char cdigit = (char)(accum & (base - 1));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001717 cdigit += (cdigit < 10) ? '0' : 'a'-10;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001718 assert(p > PyUnicode_AS_UNICODE(str));
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001719 *--p = cdigit;
Tim Peters586b2e32001-07-15 09:11:14 +00001720 accumbits -= basebits;
1721 accum >>= basebits;
1722 } while (i < size_a-1 ? accumbits >= basebits :
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001723 accum > 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001724 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001725 }
1726 else {
Tim Petersfad225f2001-07-13 02:59:26 +00001727 /* Not 0, and base not a power of 2. Divide repeatedly by
1728 base, but for speed use the highest power of base that
1729 fits in a digit. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001730 Py_ssize_t size = size_a;
Tim Peters212e6142001-07-14 12:23:19 +00001731 digit *pin = a->ob_digit;
1732 PyLongObject *scratch;
1733 /* powbasw <- largest power of base that fits in a digit. */
Tim Petersfad225f2001-07-13 02:59:26 +00001734 digit powbase = base; /* powbase == base ** power */
1735 int power = 1;
1736 for (;;) {
Mark Dickinson134708a2009-02-25 20:33:49 +00001737 twodigits newpow = powbase * (twodigits)base;
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001738 if (newpow >> PyLong_SHIFT)
1739 /* doesn't fit in a digit */
Tim Petersfad225f2001-07-13 02:59:26 +00001740 break;
1741 powbase = (digit)newpow;
1742 ++power;
1743 }
Tim Peters212e6142001-07-14 12:23:19 +00001744
1745 /* Get a scratch area for repeated division. */
1746 scratch = _PyLong_New(size);
1747 if (scratch == NULL) {
1748 Py_DECREF(str);
1749 return NULL;
1750 }
1751
1752 /* Repeatedly divide by powbase. */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001753 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001754 int ntostore = power;
Tim Peters212e6142001-07-14 12:23:19 +00001755 digit rem = inplace_divrem1(scratch->ob_digit,
1756 pin, size, powbase);
1757 pin = scratch->ob_digit; /* no need to use a again */
1758 if (pin[size - 1] == 0)
1759 --size;
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001760 SIGCHECK({
Tim Peters212e6142001-07-14 12:23:19 +00001761 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001762 Py_DECREF(str);
1763 return NULL;
1764 })
Tim Peters212e6142001-07-14 12:23:19 +00001765
1766 /* Break rem into digits. */
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001767 assert(ntostore > 0);
1768 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001769 digit nextrem = (digit)(rem / base);
1770 char c = (char)(rem - nextrem * base);
Walter Dörwald1ab83302007-05-18 17:15:44 +00001771 assert(p > PyUnicode_AS_UNICODE(str));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001772 c += (c < 10) ? '0' : 'a'-10;
Tim Petersfad225f2001-07-13 02:59:26 +00001773 *--p = c;
1774 rem = nextrem;
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001775 --ntostore;
1776 /* Termination is a bit delicate: must not
1777 store leading zeroes, so must get out if
Tim Peters212e6142001-07-14 12:23:19 +00001778 remaining quotient and rem are both 0. */
1779 } while (ntostore && (size || rem));
1780 } while (size != 0);
1781 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001782 }
1783
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001784 if (base == 16) {
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001785 *--p = 'x';
1786 *--p = '0';
1787 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001788 else if (base == 8) {
1789 *--p = 'o';
1790 *--p = '0';
1791 }
1792 else if (base == 2) {
1793 *--p = 'b';
1794 *--p = '0';
1795 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00001796 else if (base != 10) {
1797 *--p = '#';
1798 *--p = '0' + base%10;
1799 if (base > 10)
1800 *--p = '0' + base/10;
1801 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001802 if (sign)
1803 *--p = sign;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001804 if (p != PyUnicode_AS_UNICODE(str)) {
1805 Py_UNICODE *q = PyUnicode_AS_UNICODE(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001806 assert(p > q);
1807 do {
1808 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001809 q--;
Mark Dickinson3ad91d02009-09-13 12:08:21 +00001810 if (PyUnicode_Resize(&str,(Py_ssize_t) (q -
1811 PyUnicode_AS_UNICODE(str)))) {
Walter Dörwald1ab83302007-05-18 17:15:44 +00001812 Py_DECREF(str);
1813 return NULL;
1814 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001815 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001816 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001817}
1818
Thomas Wouters477c8d52006-05-27 19:21:47 +00001819/* Table of digit values for 8-bit string -> integer conversion.
1820 * '0' maps to 0, ..., '9' maps to 9.
1821 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1822 * All other indices map to 37.
1823 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001824 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001825 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001826unsigned char _PyLong_DigitValue[256] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001827 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1828 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1829 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1830 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1831 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1832 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1833 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1834 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1835 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1836 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1837 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1838 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1839 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1840 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1841 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1842 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1843};
1844
1845/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001846 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1847 * non-digit (which may be *str!). A normalized long is returned.
1848 * The point to this routine is that it takes time linear in the number of
1849 * string characters.
1850 */
1851static PyLongObject *
1852long_from_binary_base(char **str, int base)
1853{
1854 char *p = *str;
1855 char *start = p;
1856 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001857 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001858 PyLongObject *z;
1859 twodigits accum;
1860 int bits_in_accum;
1861 digit *pdigit;
1862
1863 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1864 n = base;
1865 for (bits_per_char = -1; n; ++bits_per_char)
1866 n >>= 1;
1867 /* n <- total # of bits needed, while setting p to end-of-string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00001868 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001869 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001870 *str = p;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001871 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1872 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001873 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001874 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001875 "int string too large to convert");
Tim Peters1a3b19a2003-02-02 17:33:53 +00001876 return NULL;
1877 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001878 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001879 z = _PyLong_New(n);
1880 if (z == NULL)
1881 return NULL;
1882 /* Read string from right, and fill in long from left; i.e.,
1883 * from least to most significant in both.
1884 */
1885 accum = 0;
1886 bits_in_accum = 0;
1887 pdigit = z->ob_digit;
1888 while (--p >= start) {
Raymond Hettinger35631532009-01-09 03:58:09 +00001889 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001890 assert(k >= 0 && k < base);
Mark Dickinson17e55872009-01-24 15:56:57 +00001891 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001892 bits_in_accum += bits_per_char;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001893 if (bits_in_accum >= PyLong_SHIFT) {
1894 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinson17e55872009-01-24 15:56:57 +00001895 assert(pdigit - z->ob_digit <= n);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001896 accum >>= PyLong_SHIFT;
1897 bits_in_accum -= PyLong_SHIFT;
1898 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001899 }
1900 }
1901 if (bits_in_accum) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001902 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001903 *pdigit++ = (digit)accum;
Mark Dickinson17e55872009-01-24 15:56:57 +00001904 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001905 }
1906 while (pdigit - z->ob_digit < n)
1907 *pdigit++ = 0;
1908 return long_normalize(z);
1909}
1910
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001911PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001912PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001913{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001914 int sign = 1, error_if_nonzero = 0;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001915 char *start, *orig_str = str;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001916 PyLongObject *z = NULL;
Guido van Rossum25236212007-08-22 23:28:23 +00001917 PyObject *strobj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001918 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001919
Guido van Rossum472c04f1996-12-05 21:57:21 +00001920 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001921 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001922 "int() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001923 return NULL;
1924 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001925 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001926 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001927 if (*str == '+')
1928 ++str;
1929 else if (*str == '-') {
1930 ++str;
1931 sign = -1;
1932 }
1933 if (base == 0) {
1934 if (str[0] != '0')
1935 base = 10;
1936 else if (str[1] == 'x' || str[1] == 'X')
1937 base = 16;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001938 else if (str[1] == 'o' || str[1] == 'O')
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001939 base = 8;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001940 else if (str[1] == 'b' || str[1] == 'B')
1941 base = 2;
1942 else {
1943 /* "old" (C-style) octal literal, now invalid.
1944 it might still be zero though */
1945 error_if_nonzero = 1;
1946 base = 10;
1947 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001948 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001949 if (str[0] == '0' &&
1950 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1951 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1952 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001953 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001954
Guido van Rossume6762971998-06-22 03:54:46 +00001955 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00001956 if ((base & (base - 1)) == 0)
1957 z = long_from_binary_base(&str, base);
1958 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001959/***
1960Binary bases can be converted in time linear in the number of digits, because
1961Python's representation base is binary. Other bases (including decimal!) use
1962the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001963
Thomas Wouters477c8d52006-05-27 19:21:47 +00001964First some math: the largest integer that can be expressed in N base-B digits
1965is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1966case number of Python digits needed to hold it is the smallest integer n s.t.
1967
1968 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1969 BASE**n >= B**N [taking logs to base BASE]
1970 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
1971
1972The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
1973this quickly. A Python long with that much space is reserved near the start,
1974and the result is computed into it.
1975
1976The input string is actually treated as being in base base**i (i.e., i digits
1977are processed at a time), where two more static arrays hold:
1978
1979 convwidth_base[base] = the largest integer i such that base**i <= BASE
1980 convmultmax_base[base] = base ** convwidth_base[base]
1981
1982The first of these is the largest i such that i consecutive input digits
1983must fit in a single Python digit. The second is effectively the input
1984base we're really using.
1985
1986Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1987convmultmax_base[base], the result is "simply"
1988
1989 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1990
1991where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001992
1993Error analysis: as above, the number of Python digits `n` needed is worst-
1994case
1995
1996 n >= N * log(B)/log(BASE)
1997
1998where `N` is the number of input digits in base `B`. This is computed via
1999
2000 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2001
2002below. Two numeric concerns are how much space this can waste, and whether
2003the computed result can be too small. To be concrete, assume BASE = 2**15,
2004which is the default (and it's unlikely anyone changes that).
2005
2006Waste isn't a problem: provided the first input digit isn't 0, the difference
2007between the worst-case input with N digits and the smallest input with N
2008digits is about a factor of B, but B is small compared to BASE so at most
2009one allocated Python digit can remain unused on that count. If
2010N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
2011and adding 1 returns a result 1 larger than necessary. However, that can't
2012happen: whenever B is a power of 2, long_from_binary_base() is called
2013instead, and it's impossible for B**i to be an integer power of 2**15 when
2014B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
2015an exact integer when B is not a power of 2, since B**i has a prime factor
2016other than 2 in that case, but (2**15)**j's only prime factor is 2).
2017
2018The computed result can be too small if the true value of N*log(B)/log(BASE)
2019is a little bit larger than an exact integer, but due to roundoff errors (in
2020computing log(B), log(BASE), their quotient, and/or multiplying that by N)
2021yields a numeric result a little less than that integer. Unfortunately, "how
2022close can a transcendental function get to an integer over some range?"
2023questions are generally theoretically intractable. Computer analysis via
2024continued fractions is practical: expand log(B)/log(BASE) via continued
2025fractions, giving a sequence i/j of "the best" rational approximations. Then
2026j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
2027we can get very close to being in trouble, but very rarely. For example,
202876573 is a denominator in one of the continued-fraction approximations to
2029log(10)/log(2**15), and indeed:
2030
2031 >>> log(10)/log(2**15)*76573
2032 16958.000000654003
2033
2034is very close to an integer. If we were working with IEEE single-precision,
2035rounding errors could kill us. Finding worst cases in IEEE double-precision
2036requires better-than-double-precision log() functions, and Tim didn't bother.
2037Instead the code checks to see whether the allocated space is enough as each
2038new Python digit is added, and copies the whole thing to a larger long if not.
2039This should happen extremely rarely, and in fact I don't have a test case
2040that triggers it(!). Instead the code was tested by artificially allocating
2041just 1 digit at the start, so that the copying code was exercised for every
2042digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002043***/
2044 register twodigits c; /* current input character */
2045 Py_ssize_t size_z;
2046 int i;
2047 int convwidth;
2048 twodigits convmultmax, convmult;
2049 digit *pz, *pzstop;
2050 char* scan;
2051
2052 static double log_base_BASE[37] = {0.0e0,};
2053 static int convwidth_base[37] = {0,};
2054 static twodigits convmultmax_base[37] = {0,};
2055
2056 if (log_base_BASE[base] == 0.0) {
2057 twodigits convmax = base;
2058 int i = 1;
2059
2060 log_base_BASE[base] = log((double)base) /
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002061 log((double)PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002062 for (;;) {
2063 twodigits next = convmax * base;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002064 if (next > PyLong_BASE)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002065 break;
2066 convmax = next;
2067 ++i;
2068 }
2069 convmultmax_base[base] = convmax;
2070 assert(i > 0);
2071 convwidth_base[base] = i;
2072 }
2073
2074 /* Find length of the string of numeric characters. */
2075 scan = str;
Christian Heimesbbe741d2008-03-28 10:53:29 +00002076 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002077 ++scan;
2078
2079 /* Create a long object that can contain the largest possible
2080 * integer with this base and length. Note that there's no
2081 * need to initialize z->ob_digit -- no slot is read up before
2082 * being stored into.
2083 */
2084 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002085 /* Uncomment next line to test exceedingly rare copy code */
2086 /* size_z = 1; */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002087 assert(size_z > 0);
2088 z = _PyLong_New(size_z);
2089 if (z == NULL)
2090 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002091 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002092
2093 /* `convwidth` consecutive input digits are treated as a single
2094 * digit in base `convmultmax`.
2095 */
2096 convwidth = convwidth_base[base];
2097 convmultmax = convmultmax_base[base];
2098
2099 /* Work ;-) */
2100 while (str < scan) {
2101 /* grab up to convwidth digits from the input string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00002102 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002103 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2104 c = (twodigits)(c * base +
Raymond Hettinger35631532009-01-09 03:58:09 +00002105 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002106 assert(c < PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002107 }
2108
2109 convmult = convmultmax;
2110 /* Calculate the shift only if we couldn't get
2111 * convwidth digits.
2112 */
2113 if (i != convwidth) {
2114 convmult = base;
2115 for ( ; i > 1; --i)
2116 convmult *= base;
2117 }
2118
2119 /* Multiply z by convmult, and add c. */
2120 pz = z->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00002121 pzstop = pz + Py_SIZE(z);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002122 for (; pz < pzstop; ++pz) {
2123 c += (twodigits)*pz * convmult;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002124 *pz = (digit)(c & PyLong_MASK);
2125 c >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002126 }
2127 /* carry off the current end? */
2128 if (c) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002129 assert(c < PyLong_BASE);
Christian Heimes90aa7642007-12-19 02:45:37 +00002130 if (Py_SIZE(z) < size_z) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002131 *pz = (digit)c;
Christian Heimes90aa7642007-12-19 02:45:37 +00002132 ++Py_SIZE(z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002133 }
2134 else {
2135 PyLongObject *tmp;
2136 /* Extremely rare. Get more space. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002137 assert(Py_SIZE(z) == size_z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002138 tmp = _PyLong_New(size_z + 1);
2139 if (tmp == NULL) {
2140 Py_DECREF(z);
2141 return NULL;
2142 }
2143 memcpy(tmp->ob_digit,
2144 z->ob_digit,
2145 sizeof(digit) * size_z);
2146 Py_DECREF(z);
2147 z = tmp;
2148 z->ob_digit[size_z] = (digit)c;
2149 ++size_z;
2150 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002151 }
Tim Petersbf2674b2003-02-02 07:51:32 +00002152 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002153 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00002154 if (z == NULL)
2155 return NULL;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002156 if (error_if_nonzero) {
2157 /* reset the base to 0, else the exception message
2158 doesn't make too much sense */
2159 base = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +00002160 if (Py_SIZE(z) != 0)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002161 goto onError;
2162 /* there might still be other problems, therefore base
2163 remains zero here for the same reason */
2164 }
Guido van Rossum9e896b32000-04-05 20:11:21 +00002165 if (str == start)
2166 goto onError;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002167 if (sign < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00002168 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00002169 while (*str && isspace(Py_CHARMASK(*str)))
2170 str++;
2171 if (*str != '\0')
2172 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002173 if (pend)
2174 *pend = str;
Martin v. Löwis029656f2008-06-30 04:06:08 +00002175 long_normalize(z);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002176 return (PyObject *) maybe_small_long(z);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002177
2178 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00002179 Py_XDECREF(z);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002180 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Guido van Rossum25236212007-08-22 23:28:23 +00002181 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002182 if (strobj == NULL)
2183 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002184 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00002185 "invalid literal for int() with base %d: %R",
2186 base, strobj);
2187 Py_DECREF(strobj);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002188 return NULL;
2189}
2190
2191PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002192PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002193{
Walter Dörwald07e14762002-11-06 16:15:14 +00002194 PyObject *result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002195 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002196
Walter Dörwald07e14762002-11-06 16:15:14 +00002197 if (buffer == NULL)
2198 return NULL;
2199
2200 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
2201 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002202 return NULL;
2203 }
Walter Dörwald07e14762002-11-06 16:15:14 +00002204 result = PyLong_FromString(buffer, NULL, base);
2205 PyMem_FREE(buffer);
2206 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002207}
2208
Tim Peters9f688bf2000-07-07 15:53:28 +00002209/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002210static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00002211 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002212static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002213
2214/* Long division with remainder, top-level routine */
2215
Guido van Rossume32e0141992-01-19 16:31:05 +00002216static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002217long_divrem(PyLongObject *a, PyLongObject *b,
2218 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002219{
Christian Heimes90aa7642007-12-19 02:45:37 +00002220 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002221 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002222
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002223 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00002224 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00002225 "integer division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00002226 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002227 }
2228 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00002229 (size_a == size_b &&
2230 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002231 /* |a| < |b|. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00002232 *pdiv = (PyLongObject*)PyLong_FromLong(0);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002233 if (*pdiv == NULL)
2234 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002235 Py_INCREF(a);
2236 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00002237 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002238 }
2239 if (size_b == 1) {
2240 digit rem = 0;
2241 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002242 if (z == NULL)
2243 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002244 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002245 if (*prem == NULL) {
2246 Py_DECREF(z);
2247 return -1;
2248 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002249 }
Guido van Rossume32e0141992-01-19 16:31:05 +00002250 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002251 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002252 if (z == NULL)
2253 return -1;
2254 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002255 /* Set the signs.
2256 The quotient z has the sign of a*b;
2257 the remainder r has the sign of a,
2258 so a = b*z + r. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002259 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0))
Guido van Rossumddefaf32007-01-14 03:31:43 +00002260 NEGATE(z);
Christian Heimes90aa7642007-12-19 02:45:37 +00002261 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002262 NEGATE(*prem);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002263 *pdiv = maybe_small_long(z);
Guido van Rossume32e0141992-01-19 16:31:05 +00002264 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002265}
2266
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002267/* Unsigned long division with remainder -- the algorithm. The arguments v1
2268 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002269
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002270static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002271x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002272{
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002273 PyLongObject *v, *w, *a;
2274 Py_ssize_t i, k, size_v, size_w;
2275 int d;
2276 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2277 twodigits vv;
2278 sdigit zhi;
2279 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002280
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002281 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2282 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2283 handle the special case when the initial estimate q for a quotient
2284 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2285 that won't overflow a digit. */
2286
2287 /* allocate space; w will also be used to hold the final remainder */
2288 size_v = ABS(Py_SIZE(v1));
2289 size_w = ABS(Py_SIZE(w1));
2290 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2291 v = _PyLong_New(size_v+1);
2292 if (v == NULL) {
2293 *prem = NULL;
2294 return NULL;
2295 }
2296 w = _PyLong_New(size_w);
2297 if (w == NULL) {
2298 Py_DECREF(v);
2299 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002300 return NULL;
2301 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002302
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002303 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2304 shift v1 left by the same amount. Results go into w and v. */
2305 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2306 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2307 assert(carry == 0);
2308 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2309 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2310 v->ob_digit[size_v] = carry;
2311 size_v++;
2312 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002313
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002314 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2315 at most (and usually exactly) k = size_v - size_w digits. */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002316 k = size_v - size_w;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002317 assert(k >= 0);
2318 a = _PyLong_New(k);
2319 if (a == NULL) {
2320 Py_DECREF(w);
2321 Py_DECREF(v);
2322 *prem = NULL;
2323 return NULL;
2324 }
2325 v0 = v->ob_digit;
2326 w0 = w->ob_digit;
2327 wm1 = w0[size_w-1];
2328 wm2 = w0[size_w-2];
2329 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2330 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2331 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002332
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002333 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002334 Py_DECREF(a);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002335 Py_DECREF(w);
2336 Py_DECREF(v);
2337 *prem = NULL;
2338 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002339 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002340
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002341 /* estimate quotient digit q; may overestimate by 1 (rare) */
2342 vtop = vk[size_w];
2343 assert(vtop <= wm1);
2344 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2345 q = (digit)(vv / wm1);
2346 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2347 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2348 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002349 --q;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002350 r += wm1;
2351 if (r >= PyLong_BASE)
2352 break;
2353 }
2354 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002355
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002356 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2357 zhi = 0;
2358 for (i = 0; i < size_w; ++i) {
2359 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2360 -PyLong_BASE * q <= z < PyLong_BASE */
2361 z = (sdigit)vk[i] + zhi -
2362 (stwodigits)q * (stwodigits)w0[i];
2363 vk[i] = (digit)z & PyLong_MASK;
2364 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2365 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002366 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002367
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002368 /* add w back if q was too large (this branch taken rarely) */
2369 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2370 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002371 carry = 0;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002372 for (i = 0; i < size_w; ++i) {
2373 carry += vk[i] + w0[i];
2374 vk[i] = carry & PyLong_MASK;
2375 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002376 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002377 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002378 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002379
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002380 /* store quotient digit */
2381 assert(q < PyLong_BASE);
2382 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002383 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002384
2385 /* unshift remainder; we reuse w to store the result */
2386 carry = v_rshift(w0, v0, size_w, d);
2387 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002388 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002389
2390 *prem = long_normalize(w);
2391 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002392}
2393
2394/* Methods */
2395
2396static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002397long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002398{
Christian Heimes90aa7642007-12-19 02:45:37 +00002399 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002400}
2401
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002402static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002403long_repr(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002404{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002405 return _PyLong_Format(v, 10);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002406}
2407
2408static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002409long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002410{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002411 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002412
Christian Heimes90aa7642007-12-19 02:45:37 +00002413 if (Py_SIZE(a) != Py_SIZE(b)) {
2414 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002415 sign = 0;
2416 else
Christian Heimes90aa7642007-12-19 02:45:37 +00002417 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002418 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002419 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002420 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002421 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2422 ;
2423 if (i < 0)
2424 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002425 else {
Mark Dickinsone4416742009-02-15 15:14:57 +00002426 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimes90aa7642007-12-19 02:45:37 +00002427 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002428 sign = -sign;
2429 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002430 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002431 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002432}
2433
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002434#define TEST_COND(cond) \
2435 ((cond) ? Py_True : Py_False)
2436
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002437static PyObject *
2438long_richcompare(PyObject *self, PyObject *other, int op)
2439{
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002440 int result;
2441 PyObject *v;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002442 CHECK_BINOP(self, other);
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002443 if (self == other)
2444 result = 0;
2445 else
2446 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2447 /* Convert the return value to a Boolean */
2448 switch (op) {
2449 case Py_EQ:
2450 v = TEST_COND(result == 0);
2451 break;
2452 case Py_NE:
2453 v = TEST_COND(result != 0);
2454 break;
2455 case Py_LE:
2456 v = TEST_COND(result <= 0);
2457 break;
2458 case Py_GE:
2459 v = TEST_COND(result >= 0);
2460 break;
2461 case Py_LT:
2462 v = TEST_COND(result == -1);
2463 break;
2464 case Py_GT:
2465 v = TEST_COND(result == 1);
2466 break;
2467 default:
2468 PyErr_BadArgument();
2469 return NULL;
2470 }
2471 Py_INCREF(v);
2472 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002473}
2474
Guido van Rossum9bfef441993-03-29 10:43:31 +00002475static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002476long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002477{
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002478 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002479 Py_ssize_t i;
2480 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002481
2482 /* This is designed so that Python ints and longs with the
2483 same value hash to the same value, otherwise comparisons
2484 of mapping keys will turn out weird */
Christian Heimes90aa7642007-12-19 02:45:37 +00002485 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +00002486 switch(i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00002487 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00002488 case 0: return 0;
2489 case 1: return v->ob_digit[0];
2490 }
Guido van Rossum9bfef441993-03-29 10:43:31 +00002491 sign = 1;
2492 x = 0;
2493 if (i < 0) {
2494 sign = -1;
2495 i = -(i);
2496 }
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002497 /* The following loop produces a C unsigned long x such that x is
2498 congruent to the absolute value of v modulo ULONG_MAX. The
Thomas Woutersce272b62007-09-19 21:19:28 +00002499 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002500 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002501 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002502 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002503 x += v->ob_digit[i];
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002504 /* If the addition above overflowed we compensate by
2505 incrementing. This preserves the value modulo
2506 ULONG_MAX. */
2507 if (x < v->ob_digit[i])
Thomas Woutersce272b62007-09-19 21:19:28 +00002508 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002509 }
2510 x = x * sign;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002511 if (x == (unsigned long)-1)
2512 x = (unsigned long)-2;
2513 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002514}
2515
2516
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002517/* Add the absolute values of two long integers. */
2518
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002519static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002520x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002521{
Christian Heimes90aa7642007-12-19 02:45:37 +00002522 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002523 PyLongObject *z;
Mark Dickinson17e55872009-01-24 15:56:57 +00002524 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002525 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002526
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002527 /* Ensure a is the larger of the two: */
2528 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002529 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002530 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002531 size_a = size_b;
2532 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002533 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002534 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002535 if (z == NULL)
2536 return NULL;
2537 for (i = 0; i < size_b; ++i) {
2538 carry += a->ob_digit[i] + b->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002539 z->ob_digit[i] = carry & PyLong_MASK;
2540 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002541 }
2542 for (; i < size_a; ++i) {
2543 carry += a->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002544 z->ob_digit[i] = carry & PyLong_MASK;
2545 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002546 }
2547 z->ob_digit[i] = carry;
2548 return long_normalize(z);
2549}
2550
2551/* Subtract the absolute values of two integers. */
2552
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002553static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002554x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002555{
Christian Heimes90aa7642007-12-19 02:45:37 +00002556 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002557 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002558 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002559 int sign = 1;
2560 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002561
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002562 /* Ensure a is the larger of the two: */
2563 if (size_a < size_b) {
2564 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002565 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002566 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002567 size_a = size_b;
2568 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002569 }
2570 else if (size_a == size_b) {
2571 /* Find highest digit where a and b differ: */
2572 i = size_a;
2573 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2574 ;
2575 if (i < 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002576 return (PyLongObject *)PyLong_FromLong(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002577 if (a->ob_digit[i] < b->ob_digit[i]) {
2578 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002579 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002580 }
2581 size_a = size_b = i+1;
2582 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002583 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002584 if (z == NULL)
2585 return NULL;
2586 for (i = 0; i < size_b; ++i) {
2587 /* The following assumes unsigned arithmetic
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002588 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002589 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002590 z->ob_digit[i] = borrow & PyLong_MASK;
2591 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002592 borrow &= 1; /* Keep only one sign bit */
2593 }
2594 for (; i < size_a; ++i) {
2595 borrow = a->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002596 z->ob_digit[i] = borrow & PyLong_MASK;
2597 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002598 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002599 }
2600 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002601 if (sign < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002602 NEGATE(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002603 return long_normalize(z);
2604}
2605
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002606static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002607long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002608{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002609 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002610
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002611 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002612
Christian Heimes90aa7642007-12-19 02:45:37 +00002613 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Christian Heimes217cfd12007-12-02 14:31:20 +00002614 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002615 MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002616 return result;
2617 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002618 if (Py_SIZE(a) < 0) {
2619 if (Py_SIZE(b) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002620 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002621 if (z != NULL && Py_SIZE(z) != 0)
2622 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002623 }
2624 else
2625 z = x_sub(b, a);
2626 }
2627 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002628 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002629 z = x_sub(a, b);
2630 else
2631 z = x_add(a, b);
2632 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002633 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002634}
2635
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002636static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002637long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002638{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002639 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002640
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002641 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002642
Christian Heimes90aa7642007-12-19 02:45:37 +00002643 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002644 PyObject* r;
2645 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002646 return r;
2647 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002648 if (Py_SIZE(a) < 0) {
2649 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002650 z = x_sub(a, b);
2651 else
2652 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002653 if (z != NULL && Py_SIZE(z) != 0)
2654 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002655 }
2656 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002657 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002658 z = x_add(a, b);
2659 else
2660 z = x_sub(a, b);
2661 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002662 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002663}
2664
Tim Peters5af4e6c2002-08-12 02:31:19 +00002665/* Grade school multiplication, ignoring the signs.
2666 * Returns the absolute value of the product, or NULL if error.
2667 */
2668static PyLongObject *
2669x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002670{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002671 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00002672 Py_ssize_t size_a = ABS(Py_SIZE(a));
2673 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002674 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002675
Tim Peters5af4e6c2002-08-12 02:31:19 +00002676 z = _PyLong_New(size_a + size_b);
2677 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002678 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002679
Christian Heimes90aa7642007-12-19 02:45:37 +00002680 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002681 if (a == b) {
2682 /* Efficient squaring per HAC, Algorithm 14.16:
2683 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2684 * Gives slightly less than a 2x speedup when a == b,
2685 * via exploiting that each entry in the multiplication
2686 * pyramid appears twice (except for the size_a squares).
2687 */
2688 for (i = 0; i < size_a; ++i) {
2689 twodigits carry;
2690 twodigits f = a->ob_digit[i];
2691 digit *pz = z->ob_digit + (i << 1);
2692 digit *pa = a->ob_digit + i + 1;
2693 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002694
Tim Peters0973b992004-08-29 22:16:50 +00002695 SIGCHECK({
2696 Py_DECREF(z);
2697 return NULL;
2698 })
2699
2700 carry = *pz + f * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002701 *pz++ = (digit)(carry & PyLong_MASK);
2702 carry >>= PyLong_SHIFT;
2703 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002704
2705 /* Now f is added in twice in each column of the
2706 * pyramid it appears. Same as adding f<<1 once.
2707 */
2708 f <<= 1;
2709 while (pa < paend) {
2710 carry += *pz + *pa++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002711 *pz++ = (digit)(carry & PyLong_MASK);
2712 carry >>= PyLong_SHIFT;
2713 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002714 }
2715 if (carry) {
2716 carry += *pz;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002717 *pz++ = (digit)(carry & PyLong_MASK);
2718 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002719 }
2720 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002721 *pz += (digit)(carry & PyLong_MASK);
2722 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002723 }
Tim Peters0973b992004-08-29 22:16:50 +00002724 }
2725 else { /* a is not the same as b -- gradeschool long mult */
2726 for (i = 0; i < size_a; ++i) {
2727 twodigits carry = 0;
2728 twodigits f = a->ob_digit[i];
2729 digit *pz = z->ob_digit + i;
2730 digit *pb = b->ob_digit;
2731 digit *pbend = b->ob_digit + size_b;
2732
2733 SIGCHECK({
2734 Py_DECREF(z);
2735 return NULL;
2736 })
2737
2738 while (pb < pbend) {
2739 carry += *pz + *pb++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002740 *pz++ = (digit)(carry & PyLong_MASK);
2741 carry >>= PyLong_SHIFT;
2742 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002743 }
2744 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002745 *pz += (digit)(carry & PyLong_MASK);
2746 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002747 }
2748 }
Tim Peters44121a62002-08-12 06:17:58 +00002749 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002750}
2751
2752/* A helper for Karatsuba multiplication (k_mul).
2753 Takes a long "n" and an integer "size" representing the place to
2754 split, and sets low and high such that abs(n) == (high << size) + low,
2755 viewing the shift as being by digits. The sign bit is ignored, and
2756 the return values are >= 0.
2757 Returns 0 on success, -1 on failure.
2758*/
2759static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002760kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002761{
2762 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002763 Py_ssize_t size_lo, size_hi;
Christian Heimes90aa7642007-12-19 02:45:37 +00002764 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002765
2766 size_lo = MIN(size_n, size);
2767 size_hi = size_n - size_lo;
2768
2769 if ((hi = _PyLong_New(size_hi)) == NULL)
2770 return -1;
2771 if ((lo = _PyLong_New(size_lo)) == NULL) {
2772 Py_DECREF(hi);
2773 return -1;
2774 }
2775
2776 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2777 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2778
2779 *high = long_normalize(hi);
2780 *low = long_normalize(lo);
2781 return 0;
2782}
2783
Tim Peters60004642002-08-12 22:01:34 +00002784static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2785
Tim Peters5af4e6c2002-08-12 02:31:19 +00002786/* Karatsuba multiplication. Ignores the input signs, and returns the
2787 * absolute value of the product (or NULL if error).
2788 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2789 */
2790static PyLongObject *
2791k_mul(PyLongObject *a, PyLongObject *b)
2792{
Christian Heimes90aa7642007-12-19 02:45:37 +00002793 Py_ssize_t asize = ABS(Py_SIZE(a));
2794 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002795 PyLongObject *ah = NULL;
2796 PyLongObject *al = NULL;
2797 PyLongObject *bh = NULL;
2798 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002799 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002800 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002801 Py_ssize_t shift; /* the number of digits we split off */
2802 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002803
Tim Peters5af4e6c2002-08-12 02:31:19 +00002804 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2805 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2806 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002807 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002808 * By picking X to be a power of 2, "*X" is just shifting, and it's
2809 * been reduced to 3 multiplies on numbers half the size.
2810 */
2811
Tim Petersfc07e562002-08-12 02:54:10 +00002812 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002813 * is largest.
2814 */
Tim Peters738eda72002-08-12 15:08:20 +00002815 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002816 t1 = a;
2817 a = b;
2818 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002819
2820 i = asize;
2821 asize = bsize;
2822 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002823 }
2824
2825 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002826 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2827 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002828 if (asize == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002829 return (PyLongObject *)PyLong_FromLong(0);
Tim Peters44121a62002-08-12 06:17:58 +00002830 else
2831 return x_mul(a, b);
2832 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002833
Tim Peters60004642002-08-12 22:01:34 +00002834 /* If a is small compared to b, splitting on b gives a degenerate
2835 * case with ah==0, and Karatsuba may be (even much) less efficient
2836 * than "grade school" then. However, we can still win, by viewing
2837 * b as a string of "big digits", each of width a->ob_size. That
2838 * leads to a sequence of balanced calls to k_mul.
2839 */
2840 if (2 * asize <= bsize)
2841 return k_lopsided_mul(a, b);
2842
Tim Petersd6974a52002-08-13 20:37:51 +00002843 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002844 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002845 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002846 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002847
Tim Peters0973b992004-08-29 22:16:50 +00002848 if (a == b) {
2849 bh = ah;
2850 bl = al;
2851 Py_INCREF(bh);
2852 Py_INCREF(bl);
2853 }
2854 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002855
Tim Petersd64c1de2002-08-12 17:36:03 +00002856 /* The plan:
2857 * 1. Allocate result space (asize + bsize digits: that's always
2858 * enough).
2859 * 2. Compute ah*bh, and copy into result at 2*shift.
2860 * 3. Compute al*bl, and copy into result at 0. Note that this
2861 * can't overlap with #2.
2862 * 4. Subtract al*bl from the result, starting at shift. This may
2863 * underflow (borrow out of the high digit), but we don't care:
2864 * we're effectively doing unsigned arithmetic mod
2865 * BASE**(sizea + sizeb), and so long as the *final* result fits,
2866 * borrows and carries out of the high digit can be ignored.
2867 * 5. Subtract ah*bh from the result, starting at shift.
2868 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2869 * at shift.
2870 */
2871
2872 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002873 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002874 if (ret == NULL) goto fail;
2875#ifdef Py_DEBUG
2876 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002877 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002878#endif
Tim Peters44121a62002-08-12 06:17:58 +00002879
Tim Petersd64c1de2002-08-12 17:36:03 +00002880 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002881 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002882 assert(Py_SIZE(t1) >= 0);
2883 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002884 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimes90aa7642007-12-19 02:45:37 +00002885 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002886
2887 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002888 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002889 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002890 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002891 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002892
Tim Petersd64c1de2002-08-12 17:36:03 +00002893 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002894 if ((t2 = k_mul(al, bl)) == NULL) {
2895 Py_DECREF(t1);
2896 goto fail;
2897 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002898 assert(Py_SIZE(t2) >= 0);
2899 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2900 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002901
2902 /* Zero out remaining digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002903 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002904 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002905 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002906
Tim Petersd64c1de2002-08-12 17:36:03 +00002907 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2908 * because it's fresher in cache.
2909 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002910 i = Py_SIZE(ret) - shift; /* # digits after shift */
2911 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002912 Py_DECREF(t2);
2913
Christian Heimes90aa7642007-12-19 02:45:37 +00002914 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002915 Py_DECREF(t1);
2916
Tim Petersd64c1de2002-08-12 17:36:03 +00002917 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002918 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2919 Py_DECREF(ah);
2920 Py_DECREF(al);
2921 ah = al = NULL;
2922
Tim Peters0973b992004-08-29 22:16:50 +00002923 if (a == b) {
2924 t2 = t1;
2925 Py_INCREF(t2);
2926 }
2927 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002928 Py_DECREF(t1);
2929 goto fail;
2930 }
2931 Py_DECREF(bh);
2932 Py_DECREF(bl);
2933 bh = bl = NULL;
2934
Tim Peters738eda72002-08-12 15:08:20 +00002935 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002936 Py_DECREF(t1);
2937 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002938 if (t3 == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002939 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002940
Tim Petersd6974a52002-08-13 20:37:51 +00002941 /* Add t3. It's not obvious why we can't run out of room here.
2942 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002943 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002944 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002945 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002946
Tim Peters5af4e6c2002-08-12 02:31:19 +00002947 return long_normalize(ret);
2948
2949 fail:
2950 Py_XDECREF(ret);
2951 Py_XDECREF(ah);
2952 Py_XDECREF(al);
2953 Py_XDECREF(bh);
2954 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002955 return NULL;
2956}
2957
Tim Petersd6974a52002-08-13 20:37:51 +00002958/* (*) Why adding t3 can't "run out of room" above.
2959
Tim Petersab86c2b2002-08-15 20:06:00 +00002960Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
2961to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00002962
Tim Petersab86c2b2002-08-15 20:06:00 +000029631. For any integer i, i = c(i/2) + f(i/2). In particular,
2964 bsize = c(bsize/2) + f(bsize/2).
29652. shift = f(bsize/2)
29663. asize <= bsize
29674. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
2968 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00002969
Tim Petersab86c2b2002-08-15 20:06:00 +00002970We allocated asize + bsize result digits, and add t3 into them at an offset
2971of shift. This leaves asize+bsize-shift allocated digit positions for t3
2972to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
2973asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00002974
Tim Petersab86c2b2002-08-15 20:06:00 +00002975bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
2976at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002977
Tim Petersab86c2b2002-08-15 20:06:00 +00002978If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
2979digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
2980most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002981
Tim Petersab86c2b2002-08-15 20:06:00 +00002982The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00002983
Tim Petersab86c2b2002-08-15 20:06:00 +00002984 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00002985
Tim Petersab86c2b2002-08-15 20:06:00 +00002986and we have asize + c(bsize/2) available digit positions. We need to show
2987this is always enough. An instance of c(bsize/2) cancels out in both, so
2988the question reduces to whether asize digits is enough to hold
2989(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
2990then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
2991asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002992digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00002993asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00002994c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
2995is enough to hold 2 bits. This is so if bsize >= 2, which holds because
2996bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00002997
Tim Peters48d52c02002-08-14 17:07:32 +00002998Note that since there's always enough room for (ah+al)*(bh+bl), and that's
2999clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3000ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003001*/
3002
Tim Peters60004642002-08-12 22:01:34 +00003003/* b has at least twice the digits of a, and a is big enough that Karatsuba
3004 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3005 * of slices, each with a->ob_size digits, and multiply the slices by a,
3006 * one at a time. This gives k_mul balanced inputs to work with, and is
3007 * also cache-friendly (we compute one double-width slice of the result
3008 * at a time, then move on, never bactracking except for the helpful
3009 * single-width slice overlap between successive partial sums).
3010 */
3011static PyLongObject *
3012k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3013{
Christian Heimes90aa7642007-12-19 02:45:37 +00003014 const Py_ssize_t asize = ABS(Py_SIZE(a));
3015 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00003016 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00003017 PyLongObject *ret;
3018 PyLongObject *bslice = NULL;
3019
3020 assert(asize > KARATSUBA_CUTOFF);
3021 assert(2 * asize <= bsize);
3022
3023 /* Allocate result space, and zero it out. */
3024 ret = _PyLong_New(asize + bsize);
3025 if (ret == NULL)
3026 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003027 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003028
3029 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00003030 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00003031 if (bslice == NULL)
3032 goto fail;
3033
3034 nbdone = 0;
3035 while (bsize > 0) {
3036 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003037 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003038
3039 /* Multiply the next slice of b by a. */
3040 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3041 nbtouse * sizeof(digit));
Christian Heimes90aa7642007-12-19 02:45:37 +00003042 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00003043 product = k_mul(a, bslice);
3044 if (product == NULL)
3045 goto fail;
3046
3047 /* Add into result. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003048 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3049 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00003050 Py_DECREF(product);
3051
3052 bsize -= nbtouse;
3053 nbdone += nbtouse;
3054 }
3055
3056 Py_DECREF(bslice);
3057 return long_normalize(ret);
3058
3059 fail:
3060 Py_DECREF(ret);
3061 Py_XDECREF(bslice);
3062 return NULL;
3063}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003064
3065static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003066long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003067{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003068 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003069
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003070 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003071
Mark Dickinsonbd792642009-03-18 20:06:12 +00003072 /* fast path for single-digit multiplication */
Christian Heimes90aa7642007-12-19 02:45:37 +00003073 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Mark Dickinsonbd792642009-03-18 20:06:12 +00003074 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
3075#ifdef HAVE_LONG_LONG
3076 return PyLong_FromLongLong((PY_LONG_LONG)v);
3077#else
3078 /* if we don't have long long then we're almost certainly
3079 using 15-bit digits, so v will fit in a long. In the
3080 unlikely event that we're using 30-bit digits on a platform
3081 without long long, a large v will just cause us to fall
3082 through to the general multiplication code below. */
3083 if (v >= LONG_MIN && v <= LONG_MAX)
3084 return PyLong_FromLong((long)v);
3085#endif
Martin v. Löwis14b6d922007-02-06 21:05:30 +00003086 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003087
Tim Petersd64c1de2002-08-12 17:36:03 +00003088 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00003089 /* Negate if exactly one of the inputs is negative. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003090 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003091 NEGATE(z);
Tim Peters9973d742002-08-15 19:41:06 +00003092 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003093}
3094
Guido van Rossume32e0141992-01-19 16:31:05 +00003095/* The / and % operators are now defined in terms of divmod().
3096 The expression a mod b has the value a - b*floor(a/b).
3097 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003098 |a| by |b|, with the sign of a. This is also expressed
3099 as a - b*trunc(a/b), if trunc truncates towards zero.
3100 Some examples:
3101 a b a rem b a mod b
3102 13 10 3 3
3103 -13 10 -3 7
3104 13 -10 3 -7
3105 -13 -10 -3 -3
3106 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003107 have different signs. We then subtract one from the 'div'
3108 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003109
Tim Peters47e52ee2004-08-30 02:44:38 +00003110/* Compute
3111 * *pdiv, *pmod = divmod(v, w)
3112 * NULL can be passed for pdiv or pmod, in which case that part of
3113 * the result is simply thrown away. The caller owns a reference to
3114 * each of these it requests (does not pass NULL for).
3115 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003116static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003117l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00003118 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003119{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003120 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003121
Guido van Rossume32e0141992-01-19 16:31:05 +00003122 if (long_divrem(v, w, &div, &mod) < 0)
3123 return -1;
Christian Heimes90aa7642007-12-19 02:45:37 +00003124 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3125 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003126 PyLongObject *temp;
3127 PyLongObject *one;
3128 temp = (PyLongObject *) long_add(mod, w);
3129 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00003130 mod = temp;
3131 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003132 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003133 return -1;
3134 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003135 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00003136 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003137 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3138 Py_DECREF(mod);
3139 Py_DECREF(div);
3140 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00003141 return -1;
3142 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003143 Py_DECREF(one);
3144 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003145 div = temp;
3146 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003147 if (pdiv != NULL)
3148 *pdiv = div;
3149 else
3150 Py_DECREF(div);
3151
3152 if (pmod != NULL)
3153 *pmod = mod;
3154 else
3155 Py_DECREF(mod);
3156
Guido van Rossume32e0141992-01-19 16:31:05 +00003157 return 0;
3158}
3159
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003160static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003161long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003162{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003163 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003164
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003165 CHECK_BINOP(a, b);
3166 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003167 div = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003168 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003169}
3170
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003171static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003172long_true_divide(PyObject *a, PyObject *b)
Tim Peters20dab9f2001-09-04 05:31:47 +00003173{
Tim Peterse2a60002001-09-04 06:17:36 +00003174 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00003175 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00003176
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003177 CHECK_BINOP(a, b);
Tim Peterse2a60002001-09-04 06:17:36 +00003178 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
3179 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00003180 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
Tim Peters6f97e492001-11-04 23:09:40 +00003181 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00003182 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00003183 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
3184 but should really be set correctly after sucessful calls to
3185 _PyLong_AsScaledDouble() */
3186 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00003187
3188 if (bd == 0.0) {
3189 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003190 "int division or modulo by zero");
Tim Peterse2a60002001-09-04 06:17:36 +00003191 return NULL;
3192 }
3193
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003194 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00003195 ad /= bd; /* overflow/underflow impossible here */
3196 aexp -= bexp;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003197 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00003198 goto overflow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003199 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00003200 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003201 errno = 0;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003202 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00003203 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003204 goto overflow;
3205 return PyFloat_FromDouble(ad);
3206
3207overflow:
3208 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003209 "int/int too large for a float");
Tim Peterse2a60002001-09-04 06:17:36 +00003210 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003211
Tim Peters20dab9f2001-09-04 05:31:47 +00003212}
3213
3214static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003215long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003216{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003217 PyLongObject *mod;
3218
3219 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003220
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003221 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003222 mod = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003223 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003224}
3225
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003226static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003227long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003228{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003229 PyLongObject *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003230 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003231
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003232 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003233
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003234 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003235 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003236 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003237 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003238 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003239 PyTuple_SetItem(z, 0, (PyObject *) div);
3240 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003241 }
3242 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003243 Py_DECREF(div);
3244 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003245 }
3246 return z;
3247}
3248
Tim Peters47e52ee2004-08-30 02:44:38 +00003249/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003250static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003251long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003252{
Tim Peters47e52ee2004-08-30 02:44:38 +00003253 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3254 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003255
Tim Peters47e52ee2004-08-30 02:44:38 +00003256 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00003257 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00003258 PyLongObject *temp = NULL;
3259
3260 /* 5-ary values. If the exponent is large enough, table is
3261 * precomputed so that table[i] == a**i % c for i in range(32).
3262 */
3263 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3264 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
3265
3266 /* a, b, c = v, w, x */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003267 CHECK_BINOP(v, w);
3268 a = (PyLongObject*)v; Py_INCREF(a);
3269 b = (PyLongObject*)w; Py_INCREF(b);
Tim Peters47e52ee2004-08-30 02:44:38 +00003270 if (PyLong_Check(x)) {
3271 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003272 Py_INCREF(x);
3273 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003274 else if (x == Py_None)
3275 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003276 else {
3277 Py_DECREF(a);
3278 Py_DECREF(b);
3279 Py_INCREF(Py_NotImplemented);
3280 return Py_NotImplemented;
3281 }
Tim Peters4c483c42001-09-05 06:24:58 +00003282
Christian Heimes90aa7642007-12-19 02:45:37 +00003283 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00003284 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00003285 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00003286 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00003287 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00003288 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003289 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00003290 /* else return a float. This works because we know
3291 that this calls float_pow() which converts its
3292 arguments to double. */
3293 Py_DECREF(a);
3294 Py_DECREF(b);
3295 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003296 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003297 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003298
3299 if (c) {
3300 /* if modulus == 0:
3301 raise ValueError() */
Christian Heimes90aa7642007-12-19 02:45:37 +00003302 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003303 PyErr_SetString(PyExc_ValueError,
3304 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00003305 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003306 }
3307
3308 /* if modulus < 0:
3309 negativeOutput = True
3310 modulus = -modulus */
Christian Heimes90aa7642007-12-19 02:45:37 +00003311 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003312 negativeOutput = 1;
3313 temp = (PyLongObject *)_PyLong_Copy(c);
3314 if (temp == NULL)
3315 goto Error;
3316 Py_DECREF(c);
3317 c = temp;
3318 temp = NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003319 NEGATE(c);
Tim Peters47e52ee2004-08-30 02:44:38 +00003320 }
3321
3322 /* if modulus == 1:
3323 return 0 */
Christian Heimes90aa7642007-12-19 02:45:37 +00003324 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003325 z = (PyLongObject *)PyLong_FromLong(0L);
3326 goto Done;
3327 }
3328
3329 /* if base < 0:
3330 base = base % modulus
3331 Having the base positive just makes things easier. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003332 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003333 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003334 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003335 Py_DECREF(a);
3336 a = temp;
3337 temp = NULL;
3338 }
3339 }
3340
3341 /* At this point a, b, and c are guaranteed non-negative UNLESS
3342 c is NULL, in which case a may be negative. */
3343
3344 z = (PyLongObject *)PyLong_FromLong(1L);
3345 if (z == NULL)
3346 goto Error;
3347
3348 /* Perform a modular reduction, X = X % c, but leave X alone if c
3349 * is NULL.
3350 */
3351#define REDUCE(X) \
3352 if (c != NULL) { \
3353 if (l_divmod(X, c, NULL, &temp) < 0) \
3354 goto Error; \
3355 Py_XDECREF(X); \
3356 X = temp; \
3357 temp = NULL; \
3358 }
3359
3360 /* Multiply two values, then reduce the result:
3361 result = X*Y % c. If c is NULL, skip the mod. */
3362#define MULT(X, Y, result) \
3363{ \
3364 temp = (PyLongObject *)long_mul(X, Y); \
3365 if (temp == NULL) \
3366 goto Error; \
3367 Py_XDECREF(result); \
3368 result = temp; \
3369 temp = NULL; \
3370 REDUCE(result) \
3371}
3372
Christian Heimes90aa7642007-12-19 02:45:37 +00003373 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003374 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3375 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimes90aa7642007-12-19 02:45:37 +00003376 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003377 digit bi = b->ob_digit[i];
3378
Mark Dickinsone4416742009-02-15 15:14:57 +00003379 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003380 MULT(z, z, z)
3381 if (bi & j)
3382 MULT(z, a, z)
3383 }
3384 }
3385 }
3386 else {
3387 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3388 Py_INCREF(z); /* still holds 1L */
3389 table[0] = z;
3390 for (i = 1; i < 32; ++i)
3391 MULT(table[i-1], a, table[i])
3392
Christian Heimes90aa7642007-12-19 02:45:37 +00003393 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003394 const digit bi = b->ob_digit[i];
3395
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003396 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003397 const int index = (bi >> j) & 0x1f;
3398 for (k = 0; k < 5; ++k)
3399 MULT(z, z, z)
3400 if (index)
3401 MULT(z, table[index], z)
3402 }
3403 }
3404 }
3405
Christian Heimes90aa7642007-12-19 02:45:37 +00003406 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003407 temp = (PyLongObject *)long_sub(z, c);
3408 if (temp == NULL)
3409 goto Error;
3410 Py_DECREF(z);
3411 z = temp;
3412 temp = NULL;
3413 }
3414 goto Done;
3415
3416 Error:
3417 if (z != NULL) {
3418 Py_DECREF(z);
3419 z = NULL;
3420 }
3421 /* fall through */
3422 Done:
Christian Heimes90aa7642007-12-19 02:45:37 +00003423 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003424 for (i = 0; i < 32; ++i)
3425 Py_XDECREF(table[i]);
3426 }
Tim Petersde7990b2005-07-17 23:45:23 +00003427 Py_DECREF(a);
3428 Py_DECREF(b);
3429 Py_XDECREF(c);
3430 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003431 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003432}
3433
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003434static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003435long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003436{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003437 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003438 PyLongObject *x;
3439 PyLongObject *w;
Christian Heimes90aa7642007-12-19 02:45:37 +00003440 if (ABS(Py_SIZE(v)) <=1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003441 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003442 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003443 if (w == NULL)
3444 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003445 x = (PyLongObject *) long_add(v, w);
3446 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003447 if (x == NULL)
3448 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003449 Py_SIZE(x) = -(Py_SIZE(x));
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003450 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003451}
3452
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003453static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003454long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003455{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003456 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00003457 if (ABS(Py_SIZE(v)) <= 1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003458 return PyLong_FromLong(-MEDIUM_VALUE(v));
Tim Peters69c2de32001-09-11 22:31:33 +00003459 z = (PyLongObject *)_PyLong_Copy(v);
3460 if (z != NULL)
Christian Heimes90aa7642007-12-19 02:45:37 +00003461 Py_SIZE(z) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003462 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003463}
3464
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003465static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003466long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003467{
Christian Heimes90aa7642007-12-19 02:45:37 +00003468 if (Py_SIZE(v) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003469 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003470 else
Guido van Rossumb43daf72007-08-01 18:08:08 +00003471 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003472}
3473
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003474static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003475long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003476{
Christian Heimes90aa7642007-12-19 02:45:37 +00003477 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003478}
3479
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003480static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003481long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003482{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003483 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003484 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003485 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003486 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003487
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003488 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003489
Christian Heimes90aa7642007-12-19 02:45:37 +00003490 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003491 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003492 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003493 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003494 if (a1 == NULL)
3495 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003496 a2 = (PyLongObject *) long_rshift(a1, b);
3497 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003498 if (a2 == NULL)
3499 goto rshift_error;
3500 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003501 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003502 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003503 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003504
Neil Schemenauerba872e22001-01-04 01:46:03 +00003505 shiftby = PyLong_AsLong((PyObject *)b);
3506 if (shiftby == -1L && PyErr_Occurred())
3507 goto rshift_error;
3508 if (shiftby < 0) {
3509 PyErr_SetString(PyExc_ValueError,
3510 "negative shift count");
3511 goto rshift_error;
3512 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003513 wordshift = shiftby / PyLong_SHIFT;
Christian Heimes90aa7642007-12-19 02:45:37 +00003514 newsize = ABS(Py_SIZE(a)) - wordshift;
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003515 if (newsize <= 0)
3516 return PyLong_FromLong(0);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003517 loshift = shiftby % PyLong_SHIFT;
3518 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003519 lomask = ((digit)1 << hishift) - 1;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003520 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003521 z = _PyLong_New(newsize);
3522 if (z == NULL)
3523 goto rshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003524 if (Py_SIZE(a) < 0)
3525 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003526 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3527 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3528 if (i+1 < newsize)
3529 z->ob_digit[i] |=
3530 (a->ob_digit[j+1] << hishift) & himask;
3531 }
3532 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003533 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003534rshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003535 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003536
Guido van Rossumc6913e71991-11-19 20:26:46 +00003537}
3538
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003539static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003540long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003541{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003542 /* This version due to Tim Peters */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003543 PyLongObject *a = (PyLongObject*)v;
3544 PyLongObject *b = (PyLongObject*)w;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003545 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003546 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003547 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003548 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003549
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003550 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003551
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003552 shiftby = PyLong_AsLong((PyObject *)b);
3553 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003554 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003555 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003556 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003557 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003558 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003559 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003560 PyErr_SetString(PyExc_ValueError,
3561 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003562 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003563 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003564 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3565 wordshift = (int)shiftby / PyLong_SHIFT;
3566 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003567
Christian Heimes90aa7642007-12-19 02:45:37 +00003568 oldsize = ABS(Py_SIZE(a));
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003569 newsize = oldsize + wordshift;
3570 if (remshift)
3571 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003572 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003573 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003574 goto lshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003575 if (Py_SIZE(a) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003576 NEGATE(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003577 for (i = 0; i < wordshift; i++)
3578 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003579 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003580 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003581 accum |= (twodigits)a->ob_digit[j] << remshift;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003582 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3583 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003584 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003585 if (remshift)
3586 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003587 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003588 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003589 z = long_normalize(z);
3590lshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003591 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003592}
3593
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003594
3595/* Bitwise and/xor/or operations */
3596
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003597static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003598long_bitwise(PyLongObject *a,
3599 int op, /* '&', '|', '^' */
3600 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003601{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003602 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003603 int negz;
Mark Dickinsone4416742009-02-15 15:14:57 +00003604 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003605 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003606 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003607 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003608
Christian Heimes90aa7642007-12-19 02:45:37 +00003609 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003610 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003611 if (a == NULL)
3612 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003613 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003614 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003615 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003616 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003617 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003618 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003619 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003620 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003621 if (b == NULL) {
3622 Py_DECREF(a);
3623 return NULL;
3624 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003625 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003626 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003627 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003628 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003629 maskb = 0;
3630 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003631
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003632 negz = 0;
3633 switch (op) {
3634 case '^':
3635 if (maska != maskb) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003636 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003637 negz = -1;
3638 }
3639 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003640 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003641 if (maska && maskb) {
3642 op = '|';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003643 maska ^= PyLong_MASK;
3644 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003645 negz = -1;
3646 }
3647 break;
3648 case '|':
3649 if (maska || maskb) {
3650 op = '&';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003651 maska ^= PyLong_MASK;
3652 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003653 negz = -1;
3654 }
3655 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003656 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003657
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003658 /* JRH: The original logic here was to allocate the result value (z)
3659 as the longer of the two operands. However, there are some cases
3660 where the result is guaranteed to be shorter than that: AND of two
3661 positives, OR of two negatives: use the shorter number. AND with
3662 mixed signs: use the positive number. OR with mixed signs: use the
3663 negative number. After the transformations above, op will be '&'
3664 iff one of these cases applies, and mask will be non-0 for operands
3665 whose length should be ignored.
3666 */
3667
Christian Heimes90aa7642007-12-19 02:45:37 +00003668 size_a = Py_SIZE(a);
3669 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003670 size_z = op == '&'
3671 ? (maska
3672 ? size_b
3673 : (maskb ? size_a : MIN(size_a, size_b)))
3674 : MAX(size_a, size_b);
3675 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003676 if (z == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003677 Py_DECREF(a);
3678 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003679 return NULL;
3680 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003681
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003682 for (i = 0; i < size_z; ++i) {
3683 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3684 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3685 switch (op) {
3686 case '&': z->ob_digit[i] = diga & digb; break;
3687 case '|': z->ob_digit[i] = diga | digb; break;
3688 case '^': z->ob_digit[i] = diga ^ digb; break;
3689 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003690 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003691
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003692 Py_DECREF(a);
3693 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003694 z = long_normalize(z);
3695 if (negz == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003696 return (PyObject *) maybe_small_long(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003697 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003698 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003699 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003700}
3701
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003702static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003703long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003704{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003705 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003706 CHECK_BINOP(a, b);
3707 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003708 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003709}
3710
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003711static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003712long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003713{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003714 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003715 CHECK_BINOP(a, b);
3716 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003717 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003718}
3719
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003720static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003721long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003722{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003723 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003724 CHECK_BINOP(a, b);
3725 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003726 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003727}
3728
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003729static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003730long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003731{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003732 if (PyLong_CheckExact(v))
3733 Py_INCREF(v);
3734 else
3735 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003736 return v;
3737}
3738
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003739static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003740long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003741{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003742 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003743 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003744 if (result == -1.0 && PyErr_Occurred())
3745 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003746 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003747}
3748
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003749static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003750long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003751
Tim Peters6d6c1a32001-08-02 04:15:00 +00003752static PyObject *
3753long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3754{
3755 PyObject *x = NULL;
3756 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003757 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003758
Guido van Rossumbef14172001-08-29 15:47:46 +00003759 if (type != &PyLong_Type)
3760 return long_subtype_new(type, args, kwds); /* Wimp out */
Guido van Rossumddefaf32007-01-14 03:31:43 +00003761 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:int", kwlist,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003762 &x, &base))
3763 return NULL;
3764 if (x == NULL)
3765 return PyLong_FromLong(0L);
3766 if (base == -909)
3767 return PyNumber_Long(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003768 else if (PyUnicode_Check(x))
3769 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3770 PyUnicode_GET_SIZE(x),
3771 base);
Christian Heimes72b710a2008-05-26 13:28:38 +00003772 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Guido van Rossumd8faa362007-04-27 19:54:29 +00003773 /* Since PyLong_FromString doesn't have a length parameter,
3774 * check here for possible NULs in the string. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00003775 char *string;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003776 Py_ssize_t size = Py_SIZE(x);
Christian Heimes9c4756e2008-05-26 13:22:05 +00003777 if (PyByteArray_Check(x))
3778 string = PyByteArray_AS_STRING(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003779 else
Christian Heimes72b710a2008-05-26 13:28:38 +00003780 string = PyBytes_AS_STRING(x);
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003781 if (strlen(string) != (size_t)size) {
Guido van Rossum25236212007-08-22 23:28:23 +00003782 /* We only see this if there's a null byte in x,
Guido van Rossum98297ee2007-11-06 21:34:58 +00003783 x is a bytes or buffer, *and* a base is given. */
Guido van Rossumd8faa362007-04-27 19:54:29 +00003784 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00003785 "invalid literal for int() with base %d: %R",
3786 base, x);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003787 return NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003788 }
Guido van Rossum4581ae52007-05-22 21:56:47 +00003789 return PyLong_FromString(string, NULL, base);
Guido van Rossumddefaf32007-01-14 03:31:43 +00003790 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003791 else {
3792 PyErr_SetString(PyExc_TypeError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003793 "int() can't convert non-string with explicit base");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003794 return NULL;
3795 }
3796}
3797
Guido van Rossumbef14172001-08-29 15:47:46 +00003798/* Wimpy, slow approach to tp_new calls for subtypes of long:
3799 first create a regular long from whatever arguments we got,
3800 then allocate a subtype instance and initialize it from
3801 the regular long. The regular long is then thrown away.
3802*/
3803static PyObject *
3804long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3805{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003806 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003807 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003808
3809 assert(PyType_IsSubtype(type, &PyLong_Type));
3810 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3811 if (tmp == NULL)
3812 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003813 assert(PyLong_CheckExact(tmp));
Christian Heimes90aa7642007-12-19 02:45:37 +00003814 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003815 if (n < 0)
3816 n = -n;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003817 newobj = (PyLongObject *)type->tp_alloc(type, n);
3818 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003819 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003820 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003821 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003822 assert(PyLong_Check(newobj));
Christian Heimes90aa7642007-12-19 02:45:37 +00003823 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003824 for (i = 0; i < n; i++)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003825 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003826 Py_DECREF(tmp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003827 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003828}
3829
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003830static PyObject *
3831long_getnewargs(PyLongObject *v)
3832{
3833 return Py_BuildValue("(N)", _PyLong_Copy(v));
3834}
3835
Guido van Rossumb43daf72007-08-01 18:08:08 +00003836static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00003837long_get0(PyLongObject *v, void *context) {
3838 return PyLong_FromLong(0L);
3839}
3840
3841static PyObject *
3842long_get1(PyLongObject *v, void *context) {
3843 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00003844}
3845
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003846static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00003847long__format__(PyObject *self, PyObject *args)
3848{
Eric Smith4a7d76d2008-05-30 18:10:19 +00003849 PyObject *format_spec;
3850
3851 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
3852 return NULL;
3853 return _PyLong_FormatAdvanced(self,
3854 PyUnicode_AS_UNICODE(format_spec),
3855 PyUnicode_GET_SIZE(format_spec));
Eric Smith8c663262007-08-25 02:26:07 +00003856}
3857
Eric Smith8c663262007-08-25 02:26:07 +00003858static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003859long_round(PyObject *self, PyObject *args)
3860{
Mark Dickinson1124e712009-01-28 21:25:58 +00003861 PyObject *o_ndigits=NULL, *temp;
3862 PyLongObject *pow=NULL, *q=NULL, *r=NULL, *ndigits=NULL, *one;
3863 int errcode;
3864 digit q_mod_4;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003865
Mark Dickinson1124e712009-01-28 21:25:58 +00003866 /* Notes on the algorithm: to round to the nearest 10**n (n positive),
3867 the straightforward method is:
3868
3869 (1) divide by 10**n
3870 (2) round to nearest integer (round to even in case of tie)
3871 (3) multiply result by 10**n.
3872
3873 But the rounding step involves examining the fractional part of the
3874 quotient to see whether it's greater than 0.5 or not. Since we
3875 want to do the whole calculation in integer arithmetic, it's
3876 simpler to do:
3877
3878 (1) divide by (10**n)/2
3879 (2) round to nearest multiple of 2 (multiple of 4 in case of tie)
3880 (3) multiply result by (10**n)/2.
3881
3882 Then all we need to know about the fractional part of the quotient
3883 arising in step (2) is whether it's zero or not.
3884
3885 Doing both a multiplication and division is wasteful, and is easily
3886 avoided if we just figure out how much to adjust the original input
3887 by to do the rounding.
3888
3889 Here's the whole algorithm expressed in Python.
3890
3891 def round(self, ndigits = None):
3892 """round(int, int) -> int"""
3893 if ndigits is None or ndigits >= 0:
3894 return self
3895 pow = 10**-ndigits >> 1
3896 q, r = divmod(self, pow)
3897 self -= r
3898 if (q & 1 != 0):
3899 if (q & 2 == r == 0):
3900 self -= pow
3901 else:
3902 self += pow
3903 return self
3904
3905 */
3906 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
3907 return NULL;
3908 if (o_ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003909 return long_long(self);
3910
Mark Dickinson1124e712009-01-28 21:25:58 +00003911 ndigits = (PyLongObject *)PyNumber_Index(o_ndigits);
3912 if (ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003913 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00003914
3915 if (Py_SIZE(ndigits) >= 0) {
3916 Py_DECREF(ndigits);
3917 return long_long(self);
3918 }
3919
3920 Py_INCREF(self); /* to keep refcounting simple */
3921 /* we now own references to self, ndigits */
3922
3923 /* pow = 10 ** -ndigits >> 1 */
3924 pow = (PyLongObject *)PyLong_FromLong(10L);
3925 if (pow == NULL)
3926 goto error;
3927 temp = long_neg(ndigits);
3928 Py_DECREF(ndigits);
3929 ndigits = (PyLongObject *)temp;
3930 if (ndigits == NULL)
3931 goto error;
3932 temp = long_pow((PyObject *)pow, (PyObject *)ndigits, Py_None);
3933 Py_DECREF(pow);
3934 pow = (PyLongObject *)temp;
3935 if (pow == NULL)
3936 goto error;
3937 assert(PyLong_Check(pow)); /* check long_pow returned a long */
3938 one = (PyLongObject *)PyLong_FromLong(1L);
3939 if (one == NULL)
3940 goto error;
3941 temp = long_rshift(pow, one);
3942 Py_DECREF(one);
3943 Py_DECREF(pow);
3944 pow = (PyLongObject *)temp;
3945 if (pow == NULL)
3946 goto error;
3947
3948 /* q, r = divmod(self, pow) */
3949 errcode = l_divmod((PyLongObject *)self, pow, &q, &r);
3950 if (errcode == -1)
3951 goto error;
3952
3953 /* self -= r */
3954 temp = long_sub((PyLongObject *)self, r);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003955 Py_DECREF(self);
Mark Dickinson1124e712009-01-28 21:25:58 +00003956 self = temp;
3957 if (self == NULL)
3958 goto error;
3959
3960 /* get value of quotient modulo 4 */
3961 if (Py_SIZE(q) == 0)
3962 q_mod_4 = 0;
3963 else if (Py_SIZE(q) > 0)
3964 q_mod_4 = q->ob_digit[0] & 3;
3965 else
3966 q_mod_4 = (PyLong_BASE-q->ob_digit[0]) & 3;
3967
3968 if ((q_mod_4 & 1) == 1) {
3969 /* q is odd; round self up or down by adding or subtracting pow */
3970 if (q_mod_4 == 1 && Py_SIZE(r) == 0)
3971 temp = (PyObject *)long_sub((PyLongObject *)self, pow);
3972 else
3973 temp = (PyObject *)long_add((PyLongObject *)self, pow);
3974 Py_DECREF(self);
3975 self = temp;
3976 if (self == NULL)
3977 goto error;
3978 }
3979 Py_DECREF(q);
3980 Py_DECREF(r);
3981 Py_DECREF(pow);
3982 Py_DECREF(ndigits);
3983 return self;
3984
3985 error:
3986 Py_XDECREF(q);
3987 Py_XDECREF(r);
3988 Py_XDECREF(pow);
3989 Py_XDECREF(self);
3990 Py_XDECREF(ndigits);
3991 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003992}
3993
Martin v. Löwis00709aa2008-06-04 14:18:43 +00003994static PyObject *
3995long_sizeof(PyLongObject *v)
3996{
3997 Py_ssize_t res;
3998
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003999 res = offsetof(PyLongObject, ob_digit) + ABS(Py_SIZE(v))*sizeof(digit);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004000 return PyLong_FromSsize_t(res);
4001}
4002
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004003static PyObject *
4004long_bit_length(PyLongObject *v)
4005{
4006 PyLongObject *result, *x, *y;
4007 Py_ssize_t ndigits, msd_bits = 0;
4008 digit msd;
4009
4010 assert(v != NULL);
4011 assert(PyLong_Check(v));
4012
4013 ndigits = ABS(Py_SIZE(v));
4014 if (ndigits == 0)
4015 return PyLong_FromLong(0);
4016
4017 msd = v->ob_digit[ndigits-1];
4018 while (msd >= 32) {
4019 msd_bits += 6;
4020 msd >>= 6;
4021 }
4022 msd_bits += (long)(BitLengthTable[msd]);
4023
4024 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4025 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
4026
4027 /* expression above may overflow; use Python integers instead */
4028 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4029 if (result == NULL)
4030 return NULL;
4031 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4032 if (x == NULL)
4033 goto error;
4034 y = (PyLongObject *)long_mul(result, x);
4035 Py_DECREF(x);
4036 if (y == NULL)
4037 goto error;
4038 Py_DECREF(result);
4039 result = y;
4040
4041 x = (PyLongObject *)PyLong_FromLong(msd_bits);
4042 if (x == NULL)
4043 goto error;
4044 y = (PyLongObject *)long_add(result, x);
4045 Py_DECREF(x);
4046 if (y == NULL)
4047 goto error;
4048 Py_DECREF(result);
4049 result = y;
4050
4051 return (PyObject *)result;
4052
4053error:
4054 Py_DECREF(result);
4055 return NULL;
4056}
4057
4058PyDoc_STRVAR(long_bit_length_doc,
4059"int.bit_length() -> int\n\
4060\n\
4061Number of bits necessary to represent self in binary.\n\
4062>>> bin(37)\n\
4063'0b100101'\n\
4064>>> (37).bit_length()\n\
40656");
4066
Christian Heimes53876d92008-04-19 00:31:39 +00004067#if 0
4068static PyObject *
4069long_is_finite(PyObject *v)
4070{
4071 Py_RETURN_TRUE;
4072}
4073#endif
4074
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004075static PyMethodDef long_methods[] = {
Guido van Rossumb43daf72007-08-01 18:08:08 +00004076 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
4077 "Returns self, the complex conjugate of any int."},
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004078 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
4079 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00004080#if 0
4081 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
4082 "Returns always True."},
4083#endif
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004084 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
4085 "Truncating an Integral returns itself."},
4086 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
4087 "Flooring an Integral returns itself."},
4088 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
4089 "Ceiling of an Integral returns itself."},
4090 {"__round__", (PyCFunction)long_round, METH_VARARGS,
Mark Dickinson1124e712009-01-28 21:25:58 +00004091 "Rounding an Integral returns itself.\n"
4092 "Rounding with an ndigits argument also returns an integer."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004093 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smith8c663262007-08-25 02:26:07 +00004094 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004095 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
4096 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004097 {NULL, NULL} /* sentinel */
4098};
4099
Guido van Rossumb43daf72007-08-01 18:08:08 +00004100static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00004101 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004102 (getter)long_long, (setter)NULL,
4103 "the real part of a complex number",
4104 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004105 {"imag",
4106 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004107 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004108 NULL},
4109 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004110 (getter)long_long, (setter)NULL,
4111 "the numerator of a rational number in lowest terms",
4112 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004113 {"denominator",
4114 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004115 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004116 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00004117 {NULL} /* Sentinel */
4118};
4119
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004120PyDoc_STRVAR(long_doc,
Guido van Rossumddefaf32007-01-14 03:31:43 +00004121"int(x[, base]) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004122\n\
Guido van Rossumddefaf32007-01-14 03:31:43 +00004123Convert a string or number to an integer, if possible. A floating\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004124point argument will be truncated towards zero (this does not include a\n\
4125string representation of a floating point number!) When converting a\n\
4126string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004127converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004128
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004129static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00004130 (binaryfunc) long_add, /*nb_add*/
4131 (binaryfunc) long_sub, /*nb_subtract*/
4132 (binaryfunc) long_mul, /*nb_multiply*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004133 long_mod, /*nb_remainder*/
4134 long_divmod, /*nb_divmod*/
4135 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004136 (unaryfunc) long_neg, /*nb_negative*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004137 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004138 (unaryfunc) long_abs, /*tp_absolute*/
Jack Diederich4dafcc42006-11-28 19:15:13 +00004139 (inquiry) long_bool, /*tp_bool*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004140 (unaryfunc) long_invert, /*nb_invert*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004141 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004142 (binaryfunc) long_rshift, /*nb_rshift*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004143 long_and, /*nb_and*/
4144 long_xor, /*nb_xor*/
4145 long_or, /*nb_or*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004146 long_long, /*nb_int*/
Mark Dickinson8055afd2009-01-17 10:04:45 +00004147 0, /*nb_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004148 long_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00004149 0, /* nb_inplace_add */
4150 0, /* nb_inplace_subtract */
4151 0, /* nb_inplace_multiply */
Guido van Rossum4668b002001-08-08 05:00:18 +00004152 0, /* nb_inplace_remainder */
4153 0, /* nb_inplace_power */
4154 0, /* nb_inplace_lshift */
4155 0, /* nb_inplace_rshift */
4156 0, /* nb_inplace_and */
4157 0, /* nb_inplace_xor */
4158 0, /* nb_inplace_or */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004159 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00004160 long_true_divide, /* nb_true_divide */
4161 0, /* nb_inplace_floor_divide */
4162 0, /* nb_inplace_true_divide */
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00004163 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004164};
4165
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004166PyTypeObject PyLong_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004167 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00004168 "int", /* tp_name */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004169 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004170 sizeof(digit), /* tp_itemsize */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004171 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004172 0, /* tp_print */
4173 0, /* tp_getattr */
4174 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00004175 0, /* tp_reserved */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004176 long_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004177 &long_as_number, /* tp_as_number */
4178 0, /* tp_as_sequence */
4179 0, /* tp_as_mapping */
4180 (hashfunc)long_hash, /* tp_hash */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004181 0, /* tp_call */
4182 long_repr, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004183 PyObject_GenericGetAttr, /* tp_getattro */
4184 0, /* tp_setattro */
4185 0, /* tp_as_buffer */
Thomas Wouters27d517b2007-02-25 20:39:11 +00004186 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
4187 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004188 long_doc, /* tp_doc */
4189 0, /* tp_traverse */
4190 0, /* tp_clear */
Guido van Rossum47b9ff62006-08-24 00:41:19 +00004191 long_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004192 0, /* tp_weaklistoffset */
4193 0, /* tp_iter */
4194 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004195 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004196 0, /* tp_members */
Guido van Rossumb43daf72007-08-01 18:08:08 +00004197 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004198 0, /* tp_base */
4199 0, /* tp_dict */
4200 0, /* tp_descr_get */
4201 0, /* tp_descr_set */
4202 0, /* tp_dictoffset */
4203 0, /* tp_init */
4204 0, /* tp_alloc */
4205 long_new, /* tp_new */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004206 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004207};
Guido van Rossumddefaf32007-01-14 03:31:43 +00004208
Mark Dickinsonbd792642009-03-18 20:06:12 +00004209static PyTypeObject Int_InfoType;
4210
4211PyDoc_STRVAR(int_info__doc__,
4212"sys.int_info\n\
4213\n\
4214A struct sequence that holds information about Python's\n\
4215internal representation of integers. The attributes are read only.");
4216
4217static PyStructSequence_Field int_info_fields[] = {
4218 {"bits_per_digit", "size of a digit in bits"},
4219 {"sizeof_digit", "size in bytes of the C type used to "
4220 "represent a digit"},
4221 {NULL, NULL}
4222};
4223
4224static PyStructSequence_Desc int_info_desc = {
4225 "sys.int_info", /* name */
4226 int_info__doc__, /* doc */
4227 int_info_fields, /* fields */
4228 2 /* number of fields */
4229};
4230
4231PyObject *
4232PyLong_GetInfo(void)
4233{
4234 PyObject* int_info;
4235 int field = 0;
4236 int_info = PyStructSequence_New(&Int_InfoType);
4237 if (int_info == NULL)
4238 return NULL;
Mark Dickinson0bdab682009-04-02 18:41:40 +00004239 PyStructSequence_SET_ITEM(int_info, field++,
4240 PyLong_FromLong(PyLong_SHIFT));
4241 PyStructSequence_SET_ITEM(int_info, field++,
4242 PyLong_FromLong(sizeof(digit)));
Mark Dickinsonbd792642009-03-18 20:06:12 +00004243 if (PyErr_Occurred()) {
4244 Py_CLEAR(int_info);
4245 return NULL;
4246 }
4247 return int_info;
4248}
4249
Guido van Rossumddefaf32007-01-14 03:31:43 +00004250int
4251_PyLong_Init(void)
4252{
4253#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004254 int ival, size;
Guido van Rossumddefaf32007-01-14 03:31:43 +00004255 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004256
4257 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
4258 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
4259 if (Py_TYPE(v) == &PyLong_Type) {
4260 /* The element is already initialized, most likely
4261 * the Python interpreter was initialized before.
4262 */
Christian Heimes48aa4b12008-02-01 16:56:30 +00004263 Py_ssize_t refcnt;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004264 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004265
Christian Heimes48aa4b12008-02-01 16:56:30 +00004266 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
4267 _Py_NewReference(op);
4268 /* _Py_NewReference sets the ref count to 1 but
4269 * the ref count might be larger. Set the refcnt
4270 * to the original refcnt + 1 */
4271 Py_REFCNT(op) = refcnt + 1;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004272 assert(Py_SIZE(op) == size);
4273 assert(v->ob_digit[0] == abs(ival));
4274 }
4275 else {
4276 PyObject_INIT(v, &PyLong_Type);
4277 }
4278 Py_SIZE(v) = size;
4279 v->ob_digit[0] = abs(ival);
Guido van Rossumddefaf32007-01-14 03:31:43 +00004280 }
4281#endif
Mark Dickinsonbd792642009-03-18 20:06:12 +00004282 /* initialize int_info */
4283 if (Int_InfoType.tp_name == 0)
4284 PyStructSequence_InitType(&Int_InfoType, &int_info_desc);
4285
Guido van Rossumddefaf32007-01-14 03:31:43 +00004286 return 1;
4287}
4288
4289void
4290PyLong_Fini(void)
4291{
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004292 /* Integers are currently statically allocated. Py_DECREF is not
4293 needed, but Python must forget about the reference or multiple
4294 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00004295#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004296 int i;
4297 PyLongObject *v = small_ints;
4298 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
4299 _Py_DEC_REFTOTAL;
4300 _Py_ForgetReference((PyObject*)v);
4301 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004302#endif
4303}