blob: 81af4ea751bc4c9a6cd5ae04c6bef8960711dd93 [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 Dickinsonbd792642009-03-18 20:06:12 +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;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001662 Py_ssize_t i, j, 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;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001683 j = size_a*PyLong_SHIFT + bits-1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001684 sz = i + j / bits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001685 if (j / PyLong_SHIFT < size_a || sz < i) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001686 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001687 "int is too large to format");
Thomas Wouters89f507f2006-12-13 04:49:30 +00001688 return NULL;
1689 }
Walter Dörwald1ab83302007-05-18 17:15:44 +00001690 str = PyUnicode_FromUnicode(NULL, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001691 if (str == NULL)
1692 return NULL;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001693 p = PyUnicode_AS_UNICODE(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001694 *p = '\0';
Christian Heimes90aa7642007-12-19 02:45:37 +00001695 if (Py_SIZE(a) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00001696 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001697
Christian Heimes90aa7642007-12-19 02:45:37 +00001698 if (Py_SIZE(a) == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001699 *--p = '0';
1700 }
1701 else if ((base & (base - 1)) == 0) {
1702 /* JRH: special case for power-of-2 bases */
Tim Peters586b2e32001-07-15 09:11:14 +00001703 twodigits accum = 0;
1704 int accumbits = 0; /* # of bits in accum */
1705 int basebits = 1; /* # of bits in base-1 */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001706 i = base;
Tim Peters7d3a5112000-07-08 04:17:21 +00001707 while ((i >>= 1) > 1)
1708 ++basebits;
Tim Peters586b2e32001-07-15 09:11:14 +00001709
1710 for (i = 0; i < size_a; ++i) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00001711 accum |= (twodigits)a->ob_digit[i] << accumbits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001712 accumbits += PyLong_SHIFT;
Tim Peters586b2e32001-07-15 09:11:14 +00001713 assert(accumbits >= basebits);
1714 do {
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001715 char cdigit = (char)(accum & (base - 1));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001716 cdigit += (cdigit < 10) ? '0' : 'a'-10;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001717 assert(p > PyUnicode_AS_UNICODE(str));
Martin v. Löwisa5854c22002-02-16 23:39:10 +00001718 *--p = cdigit;
Tim Peters586b2e32001-07-15 09:11:14 +00001719 accumbits -= basebits;
1720 accum >>= basebits;
1721 } while (i < size_a-1 ? accumbits >= basebits :
1722 accum > 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001723 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001724 }
1725 else {
Tim Petersfad225f2001-07-13 02:59:26 +00001726 /* Not 0, and base not a power of 2. Divide repeatedly by
1727 base, but for speed use the highest power of base that
1728 fits in a digit. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001729 Py_ssize_t size = size_a;
Tim Peters212e6142001-07-14 12:23:19 +00001730 digit *pin = a->ob_digit;
1731 PyLongObject *scratch;
1732 /* powbasw <- largest power of base that fits in a digit. */
Tim Petersfad225f2001-07-13 02:59:26 +00001733 digit powbase = base; /* powbase == base ** power */
1734 int power = 1;
1735 for (;;) {
Mark Dickinson134708a2009-02-25 20:33:49 +00001736 twodigits newpow = powbase * (twodigits)base;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001737 if (newpow >> PyLong_SHIFT) /* doesn't fit in a digit */
Tim Petersfad225f2001-07-13 02:59:26 +00001738 break;
1739 powbase = (digit)newpow;
1740 ++power;
1741 }
Tim Peters212e6142001-07-14 12:23:19 +00001742
1743 /* Get a scratch area for repeated division. */
1744 scratch = _PyLong_New(size);
1745 if (scratch == NULL) {
1746 Py_DECREF(str);
1747 return NULL;
1748 }
1749
1750 /* Repeatedly divide by powbase. */
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001751 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001752 int ntostore = power;
Tim Peters212e6142001-07-14 12:23:19 +00001753 digit rem = inplace_divrem1(scratch->ob_digit,
1754 pin, size, powbase);
1755 pin = scratch->ob_digit; /* no need to use a again */
1756 if (pin[size - 1] == 0)
1757 --size;
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001758 SIGCHECK({
Tim Peters212e6142001-07-14 12:23:19 +00001759 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001760 Py_DECREF(str);
1761 return NULL;
1762 })
Tim Peters212e6142001-07-14 12:23:19 +00001763
1764 /* Break rem into digits. */
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001765 assert(ntostore > 0);
1766 do {
Tim Petersfad225f2001-07-13 02:59:26 +00001767 digit nextrem = (digit)(rem / base);
1768 char c = (char)(rem - nextrem * base);
Walter Dörwald1ab83302007-05-18 17:15:44 +00001769 assert(p > PyUnicode_AS_UNICODE(str));
Raymond Hettinger3296e692005-06-29 23:29:56 +00001770 c += (c < 10) ? '0' : 'a'-10;
Tim Petersfad225f2001-07-13 02:59:26 +00001771 *--p = c;
1772 rem = nextrem;
Tim Petersc8a6b9b2001-07-14 11:01:28 +00001773 --ntostore;
1774 /* Termination is a bit delicate: must not
1775 store leading zeroes, so must get out if
Tim Peters212e6142001-07-14 12:23:19 +00001776 remaining quotient and rem are both 0. */
1777 } while (ntostore && (size || rem));
1778 } while (size != 0);
1779 Py_DECREF(scratch);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001780 }
1781
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001782 if (base == 16) {
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001783 *--p = 'x';
1784 *--p = '0';
1785 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001786 else if (base == 8) {
1787 *--p = 'o';
1788 *--p = '0';
1789 }
1790 else if (base == 2) {
1791 *--p = 'b';
1792 *--p = '0';
1793 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00001794 else if (base != 10) {
1795 *--p = '#';
1796 *--p = '0' + base%10;
1797 if (base > 10)
1798 *--p = '0' + base/10;
1799 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001800 if (sign)
1801 *--p = sign;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001802 if (p != PyUnicode_AS_UNICODE(str)) {
1803 Py_UNICODE *q = PyUnicode_AS_UNICODE(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001804 assert(p > q);
1805 do {
1806 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001807 q--;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001808 if (PyUnicode_Resize(&str, (Py_ssize_t) (q - PyUnicode_AS_UNICODE(str)))) {
1809 Py_DECREF(str);
1810 return NULL;
1811 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001812 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001813 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001814}
1815
Thomas Wouters477c8d52006-05-27 19:21:47 +00001816/* Table of digit values for 8-bit string -> integer conversion.
1817 * '0' maps to 0, ..., '9' maps to 9.
1818 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1819 * All other indices map to 37.
1820 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001821 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001822 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001823unsigned char _PyLong_DigitValue[256] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001824 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1825 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1826 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1827 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1828 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1829 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1830 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1831 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1832 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1833 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1834 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 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};
1841
1842/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001843 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1844 * non-digit (which may be *str!). A normalized long is returned.
1845 * The point to this routine is that it takes time linear in the number of
1846 * string characters.
1847 */
1848static PyLongObject *
1849long_from_binary_base(char **str, int base)
1850{
1851 char *p = *str;
1852 char *start = p;
1853 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001854 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001855 PyLongObject *z;
1856 twodigits accum;
1857 int bits_in_accum;
1858 digit *pdigit;
1859
1860 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1861 n = base;
1862 for (bits_per_char = -1; n; ++bits_per_char)
1863 n >>= 1;
1864 /* n <- total # of bits needed, while setting p to end-of-string */
1865 n = 0;
Christian Heimesbbe741d2008-03-28 10:53:29 +00001866 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001867 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001868 *str = p;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001869 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1870 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001871 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001872 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001873 "int string too large to convert");
Tim Peters1a3b19a2003-02-02 17:33:53 +00001874 return NULL;
1875 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001876 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001877 z = _PyLong_New(n);
1878 if (z == NULL)
1879 return NULL;
1880 /* Read string from right, and fill in long from left; i.e.,
1881 * from least to most significant in both.
1882 */
1883 accum = 0;
1884 bits_in_accum = 0;
1885 pdigit = z->ob_digit;
1886 while (--p >= start) {
Raymond Hettinger35631532009-01-09 03:58:09 +00001887 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001888 assert(k >= 0 && k < base);
Mark Dickinson17e55872009-01-24 15:56:57 +00001889 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001890 bits_in_accum += bits_per_char;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001891 if (bits_in_accum >= PyLong_SHIFT) {
1892 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinson17e55872009-01-24 15:56:57 +00001893 assert(pdigit - z->ob_digit <= n);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001894 accum >>= PyLong_SHIFT;
1895 bits_in_accum -= PyLong_SHIFT;
1896 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001897 }
1898 }
1899 if (bits_in_accum) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001900 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001901 *pdigit++ = (digit)accum;
Mark Dickinson17e55872009-01-24 15:56:57 +00001902 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001903 }
1904 while (pdigit - z->ob_digit < n)
1905 *pdigit++ = 0;
1906 return long_normalize(z);
1907}
1908
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001909PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001910PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001911{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001912 int sign = 1, error_if_nonzero = 0;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001913 char *start, *orig_str = str;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001914 PyLongObject *z = NULL;
Guido van Rossum25236212007-08-22 23:28:23 +00001915 PyObject *strobj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001916 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001917
Guido van Rossum472c04f1996-12-05 21:57:21 +00001918 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001919 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001920 "int() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001921 return NULL;
1922 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001923 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001924 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001925 if (*str == '+')
1926 ++str;
1927 else if (*str == '-') {
1928 ++str;
1929 sign = -1;
1930 }
1931 if (base == 0) {
1932 if (str[0] != '0')
1933 base = 10;
1934 else if (str[1] == 'x' || str[1] == 'X')
1935 base = 16;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001936 else if (str[1] == 'o' || str[1] == 'O')
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001937 base = 8;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001938 else if (str[1] == 'b' || str[1] == 'B')
1939 base = 2;
1940 else {
1941 /* "old" (C-style) octal literal, now invalid.
1942 it might still be zero though */
1943 error_if_nonzero = 1;
1944 base = 10;
1945 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001946 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001947 if (str[0] == '0' &&
1948 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1949 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1950 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001951 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001952
Guido van Rossume6762971998-06-22 03:54:46 +00001953 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00001954 if ((base & (base - 1)) == 0)
1955 z = long_from_binary_base(&str, base);
1956 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001957/***
1958Binary bases can be converted in time linear in the number of digits, because
1959Python's representation base is binary. Other bases (including decimal!) use
1960the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001961
Thomas Wouters477c8d52006-05-27 19:21:47 +00001962First some math: the largest integer that can be expressed in N base-B digits
1963is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1964case number of Python digits needed to hold it is the smallest integer n s.t.
1965
1966 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1967 BASE**n >= B**N [taking logs to base BASE]
1968 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
1969
1970The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
1971this quickly. A Python long with that much space is reserved near the start,
1972and the result is computed into it.
1973
1974The input string is actually treated as being in base base**i (i.e., i digits
1975are processed at a time), where two more static arrays hold:
1976
1977 convwidth_base[base] = the largest integer i such that base**i <= BASE
1978 convmultmax_base[base] = base ** convwidth_base[base]
1979
1980The first of these is the largest i such that i consecutive input digits
1981must fit in a single Python digit. The second is effectively the input
1982base we're really using.
1983
1984Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1985convmultmax_base[base], the result is "simply"
1986
1987 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1988
1989where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001990
1991Error analysis: as above, the number of Python digits `n` needed is worst-
1992case
1993
1994 n >= N * log(B)/log(BASE)
1995
1996where `N` is the number of input digits in base `B`. This is computed via
1997
1998 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
1999
2000below. Two numeric concerns are how much space this can waste, and whether
2001the computed result can be too small. To be concrete, assume BASE = 2**15,
2002which is the default (and it's unlikely anyone changes that).
2003
2004Waste isn't a problem: provided the first input digit isn't 0, the difference
2005between the worst-case input with N digits and the smallest input with N
2006digits is about a factor of B, but B is small compared to BASE so at most
2007one allocated Python digit can remain unused on that count. If
2008N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
2009and adding 1 returns a result 1 larger than necessary. However, that can't
2010happen: whenever B is a power of 2, long_from_binary_base() is called
2011instead, and it's impossible for B**i to be an integer power of 2**15 when
2012B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
2013an exact integer when B is not a power of 2, since B**i has a prime factor
2014other than 2 in that case, but (2**15)**j's only prime factor is 2).
2015
2016The computed result can be too small if the true value of N*log(B)/log(BASE)
2017is a little bit larger than an exact integer, but due to roundoff errors (in
2018computing log(B), log(BASE), their quotient, and/or multiplying that by N)
2019yields a numeric result a little less than that integer. Unfortunately, "how
2020close can a transcendental function get to an integer over some range?"
2021questions are generally theoretically intractable. Computer analysis via
2022continued fractions is practical: expand log(B)/log(BASE) via continued
2023fractions, giving a sequence i/j of "the best" rational approximations. Then
2024j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
2025we can get very close to being in trouble, but very rarely. For example,
202676573 is a denominator in one of the continued-fraction approximations to
2027log(10)/log(2**15), and indeed:
2028
2029 >>> log(10)/log(2**15)*76573
2030 16958.000000654003
2031
2032is very close to an integer. If we were working with IEEE single-precision,
2033rounding errors could kill us. Finding worst cases in IEEE double-precision
2034requires better-than-double-precision log() functions, and Tim didn't bother.
2035Instead the code checks to see whether the allocated space is enough as each
2036new Python digit is added, and copies the whole thing to a larger long if not.
2037This should happen extremely rarely, and in fact I don't have a test case
2038that triggers it(!). Instead the code was tested by artificially allocating
2039just 1 digit at the start, so that the copying code was exercised for every
2040digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002041***/
2042 register twodigits c; /* current input character */
2043 Py_ssize_t size_z;
2044 int i;
2045 int convwidth;
2046 twodigits convmultmax, convmult;
2047 digit *pz, *pzstop;
2048 char* scan;
2049
2050 static double log_base_BASE[37] = {0.0e0,};
2051 static int convwidth_base[37] = {0,};
2052 static twodigits convmultmax_base[37] = {0,};
2053
2054 if (log_base_BASE[base] == 0.0) {
2055 twodigits convmax = base;
2056 int i = 1;
2057
2058 log_base_BASE[base] = log((double)base) /
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002059 log((double)PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002060 for (;;) {
2061 twodigits next = convmax * base;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002062 if (next > PyLong_BASE)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002063 break;
2064 convmax = next;
2065 ++i;
2066 }
2067 convmultmax_base[base] = convmax;
2068 assert(i > 0);
2069 convwidth_base[base] = i;
2070 }
2071
2072 /* Find length of the string of numeric characters. */
2073 scan = str;
Christian Heimesbbe741d2008-03-28 10:53:29 +00002074 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002075 ++scan;
2076
2077 /* Create a long object that can contain the largest possible
2078 * integer with this base and length. Note that there's no
2079 * need to initialize z->ob_digit -- no slot is read up before
2080 * being stored into.
2081 */
2082 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002083 /* Uncomment next line to test exceedingly rare copy code */
2084 /* size_z = 1; */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002085 assert(size_z > 0);
2086 z = _PyLong_New(size_z);
2087 if (z == NULL)
2088 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002089 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002090
2091 /* `convwidth` consecutive input digits are treated as a single
2092 * digit in base `convmultmax`.
2093 */
2094 convwidth = convwidth_base[base];
2095 convmultmax = convmultmax_base[base];
2096
2097 /* Work ;-) */
2098 while (str < scan) {
2099 /* grab up to convwidth digits from the input string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00002100 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002101 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2102 c = (twodigits)(c * base +
Raymond Hettinger35631532009-01-09 03:58:09 +00002103 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002104 assert(c < PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002105 }
2106
2107 convmult = convmultmax;
2108 /* Calculate the shift only if we couldn't get
2109 * convwidth digits.
2110 */
2111 if (i != convwidth) {
2112 convmult = base;
2113 for ( ; i > 1; --i)
2114 convmult *= base;
2115 }
2116
2117 /* Multiply z by convmult, and add c. */
2118 pz = z->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00002119 pzstop = pz + Py_SIZE(z);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002120 for (; pz < pzstop; ++pz) {
2121 c += (twodigits)*pz * convmult;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002122 *pz = (digit)(c & PyLong_MASK);
2123 c >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002124 }
2125 /* carry off the current end? */
2126 if (c) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002127 assert(c < PyLong_BASE);
Christian Heimes90aa7642007-12-19 02:45:37 +00002128 if (Py_SIZE(z) < size_z) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002129 *pz = (digit)c;
Christian Heimes90aa7642007-12-19 02:45:37 +00002130 ++Py_SIZE(z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002131 }
2132 else {
2133 PyLongObject *tmp;
2134 /* Extremely rare. Get more space. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002135 assert(Py_SIZE(z) == size_z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002136 tmp = _PyLong_New(size_z + 1);
2137 if (tmp == NULL) {
2138 Py_DECREF(z);
2139 return NULL;
2140 }
2141 memcpy(tmp->ob_digit,
2142 z->ob_digit,
2143 sizeof(digit) * size_z);
2144 Py_DECREF(z);
2145 z = tmp;
2146 z->ob_digit[size_z] = (digit)c;
2147 ++size_z;
2148 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002149 }
Tim Petersbf2674b2003-02-02 07:51:32 +00002150 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002151 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00002152 if (z == NULL)
2153 return NULL;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002154 if (error_if_nonzero) {
2155 /* reset the base to 0, else the exception message
2156 doesn't make too much sense */
2157 base = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +00002158 if (Py_SIZE(z) != 0)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002159 goto onError;
2160 /* there might still be other problems, therefore base
2161 remains zero here for the same reason */
2162 }
Guido van Rossum9e896b32000-04-05 20:11:21 +00002163 if (str == start)
2164 goto onError;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002165 if (sign < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00002166 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00002167 while (*str && isspace(Py_CHARMASK(*str)))
2168 str++;
2169 if (*str != '\0')
2170 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002171 if (pend)
2172 *pend = str;
Martin v. Löwis029656f2008-06-30 04:06:08 +00002173 long_normalize(z);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002174 return (PyObject *) maybe_small_long(z);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002175
2176 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00002177 Py_XDECREF(z);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002178 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Guido van Rossum25236212007-08-22 23:28:23 +00002179 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002180 if (strobj == NULL)
2181 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002182 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00002183 "invalid literal for int() with base %d: %R",
2184 base, strobj);
2185 Py_DECREF(strobj);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002186 return NULL;
2187}
2188
2189PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002190PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002191{
Walter Dörwald07e14762002-11-06 16:15:14 +00002192 PyObject *result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002193 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002194
Walter Dörwald07e14762002-11-06 16:15:14 +00002195 if (buffer == NULL)
2196 return NULL;
2197
2198 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
2199 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002200 return NULL;
2201 }
Walter Dörwald07e14762002-11-06 16:15:14 +00002202 result = PyLong_FromString(buffer, NULL, base);
2203 PyMem_FREE(buffer);
2204 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002205}
2206
Tim Peters9f688bf2000-07-07 15:53:28 +00002207/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002208static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00002209 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002210static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002211
2212/* Long division with remainder, top-level routine */
2213
Guido van Rossume32e0141992-01-19 16:31:05 +00002214static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002215long_divrem(PyLongObject *a, PyLongObject *b,
2216 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002217{
Christian Heimes90aa7642007-12-19 02:45:37 +00002218 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002219 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002220
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002221 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00002222 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00002223 "integer division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00002224 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002225 }
2226 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00002227 (size_a == size_b &&
2228 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002229 /* |a| < |b|. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00002230 *pdiv = (PyLongObject*)PyLong_FromLong(0);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002231 if (*pdiv == NULL)
2232 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002233 Py_INCREF(a);
2234 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00002235 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002236 }
2237 if (size_b == 1) {
2238 digit rem = 0;
2239 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002240 if (z == NULL)
2241 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002242 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002243 if (*prem == NULL) {
2244 Py_DECREF(z);
2245 return -1;
2246 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002247 }
Guido van Rossume32e0141992-01-19 16:31:05 +00002248 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002249 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002250 if (z == NULL)
2251 return -1;
2252 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002253 /* Set the signs.
2254 The quotient z has the sign of a*b;
2255 the remainder r has the sign of a,
2256 so a = b*z + r. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002257 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0))
Guido van Rossumddefaf32007-01-14 03:31:43 +00002258 NEGATE(z);
Christian Heimes90aa7642007-12-19 02:45:37 +00002259 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002260 NEGATE(*prem);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002261 *pdiv = maybe_small_long(z);
Guido van Rossume32e0141992-01-19 16:31:05 +00002262 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002263}
2264
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002265/* Unsigned long division with remainder -- the algorithm. The arguments v1
2266 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002267
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002268static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002269x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002270{
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002271 PyLongObject *v, *w, *a;
2272 Py_ssize_t i, k, size_v, size_w;
2273 int d;
2274 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2275 twodigits vv;
2276 sdigit zhi;
2277 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002278
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002279 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2280 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2281 handle the special case when the initial estimate q for a quotient
2282 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2283 that won't overflow a digit. */
2284
2285 /* allocate space; w will also be used to hold the final remainder */
2286 size_v = ABS(Py_SIZE(v1));
2287 size_w = ABS(Py_SIZE(w1));
2288 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2289 v = _PyLong_New(size_v+1);
2290 if (v == NULL) {
2291 *prem = NULL;
2292 return NULL;
2293 }
2294 w = _PyLong_New(size_w);
2295 if (w == NULL) {
2296 Py_DECREF(v);
2297 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002298 return NULL;
2299 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002300
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002301 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2302 shift v1 left by the same amount. Results go into w and v. */
2303 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2304 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2305 assert(carry == 0);
2306 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2307 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2308 v->ob_digit[size_v] = carry;
2309 size_v++;
2310 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002311
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002312 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2313 at most (and usually exactly) k = size_v - size_w digits. */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002314 k = size_v - size_w;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002315 assert(k >= 0);
2316 a = _PyLong_New(k);
2317 if (a == NULL) {
2318 Py_DECREF(w);
2319 Py_DECREF(v);
2320 *prem = NULL;
2321 return NULL;
2322 }
2323 v0 = v->ob_digit;
2324 w0 = w->ob_digit;
2325 wm1 = w0[size_w-1];
2326 wm2 = w0[size_w-2];
2327 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2328 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2329 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002330
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002331 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002332 Py_DECREF(a);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002333 Py_DECREF(w);
2334 Py_DECREF(v);
2335 *prem = NULL;
2336 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002337 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002338
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002339 /* estimate quotient digit q; may overestimate by 1 (rare) */
2340 vtop = vk[size_w];
2341 assert(vtop <= wm1);
2342 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2343 q = (digit)(vv / wm1);
2344 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2345 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2346 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002347 --q;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002348 r += wm1;
2349 if (r >= PyLong_BASE)
2350 break;
2351 }
2352 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002353
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002354 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2355 zhi = 0;
2356 for (i = 0; i < size_w; ++i) {
2357 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2358 -PyLong_BASE * q <= z < PyLong_BASE */
2359 z = (sdigit)vk[i] + zhi -
2360 (stwodigits)q * (stwodigits)w0[i];
2361 vk[i] = (digit)z & PyLong_MASK;
2362 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2363 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002364 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002365
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002366 /* add w back if q was too large (this branch taken rarely) */
2367 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2368 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002369 carry = 0;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002370 for (i = 0; i < size_w; ++i) {
2371 carry += vk[i] + w0[i];
2372 vk[i] = carry & PyLong_MASK;
2373 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002374 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002375 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002376 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002377
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002378 /* store quotient digit */
2379 assert(q < PyLong_BASE);
2380 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002381 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002382
2383 /* unshift remainder; we reuse w to store the result */
2384 carry = v_rshift(w0, v0, size_w, d);
2385 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002386 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002387
2388 *prem = long_normalize(w);
2389 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002390}
2391
2392/* Methods */
2393
2394static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002395long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002396{
Christian Heimes90aa7642007-12-19 02:45:37 +00002397 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002398}
2399
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002400static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002401long_repr(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002402{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002403 return _PyLong_Format(v, 10);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002404}
2405
2406static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002407long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002408{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002409 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002410
Christian Heimes90aa7642007-12-19 02:45:37 +00002411 if (Py_SIZE(a) != Py_SIZE(b)) {
2412 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002413 sign = 0;
2414 else
Christian Heimes90aa7642007-12-19 02:45:37 +00002415 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002416 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002417 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002418 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002419 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2420 ;
2421 if (i < 0)
2422 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002423 else {
Mark Dickinsone4416742009-02-15 15:14:57 +00002424 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimes90aa7642007-12-19 02:45:37 +00002425 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002426 sign = -sign;
2427 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002428 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002429 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002430}
2431
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002432#define TEST_COND(cond) \
2433 ((cond) ? Py_True : Py_False)
2434
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002435static PyObject *
2436long_richcompare(PyObject *self, PyObject *other, int op)
2437{
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002438 int result;
2439 PyObject *v;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002440 CHECK_BINOP(self, other);
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002441 if (self == other)
2442 result = 0;
2443 else
2444 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2445 /* Convert the return value to a Boolean */
2446 switch (op) {
2447 case Py_EQ:
2448 v = TEST_COND(result == 0);
2449 break;
2450 case Py_NE:
2451 v = TEST_COND(result != 0);
2452 break;
2453 case Py_LE:
2454 v = TEST_COND(result <= 0);
2455 break;
2456 case Py_GE:
2457 v = TEST_COND(result >= 0);
2458 break;
2459 case Py_LT:
2460 v = TEST_COND(result == -1);
2461 break;
2462 case Py_GT:
2463 v = TEST_COND(result == 1);
2464 break;
2465 default:
2466 PyErr_BadArgument();
2467 return NULL;
2468 }
2469 Py_INCREF(v);
2470 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002471}
2472
Guido van Rossum9bfef441993-03-29 10:43:31 +00002473static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002474long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002475{
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002476 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002477 Py_ssize_t i;
2478 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002479
2480 /* This is designed so that Python ints and longs with the
2481 same value hash to the same value, otherwise comparisons
2482 of mapping keys will turn out weird */
Christian Heimes90aa7642007-12-19 02:45:37 +00002483 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +00002484 switch(i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00002485 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00002486 case 0: return 0;
2487 case 1: return v->ob_digit[0];
2488 }
Guido van Rossum9bfef441993-03-29 10:43:31 +00002489 sign = 1;
2490 x = 0;
2491 if (i < 0) {
2492 sign = -1;
2493 i = -(i);
2494 }
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002495 /* The following loop produces a C unsigned long x such that x is
2496 congruent to the absolute value of v modulo ULONG_MAX. The
Thomas Woutersce272b62007-09-19 21:19:28 +00002497 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002498 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002499 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002500 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002501 x += v->ob_digit[i];
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002502 /* If the addition above overflowed we compensate by
2503 incrementing. This preserves the value modulo
2504 ULONG_MAX. */
2505 if (x < v->ob_digit[i])
Thomas Woutersce272b62007-09-19 21:19:28 +00002506 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002507 }
2508 x = x * sign;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002509 if (x == (unsigned long)-1)
2510 x = (unsigned long)-2;
2511 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002512}
2513
2514
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002515/* Add the absolute values of two long integers. */
2516
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002517static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002518x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002519{
Christian Heimes90aa7642007-12-19 02:45:37 +00002520 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002521 PyLongObject *z;
Mark Dickinson17e55872009-01-24 15:56:57 +00002522 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002523 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002524
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002525 /* Ensure a is the larger of the two: */
2526 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002527 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002528 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002529 size_a = size_b;
2530 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002531 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002532 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002533 if (z == NULL)
2534 return NULL;
2535 for (i = 0; i < size_b; ++i) {
2536 carry += a->ob_digit[i] + b->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002537 z->ob_digit[i] = carry & PyLong_MASK;
2538 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002539 }
2540 for (; i < size_a; ++i) {
2541 carry += a->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002542 z->ob_digit[i] = carry & PyLong_MASK;
2543 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002544 }
2545 z->ob_digit[i] = carry;
2546 return long_normalize(z);
2547}
2548
2549/* Subtract the absolute values of two integers. */
2550
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002551static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002552x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002553{
Christian Heimes90aa7642007-12-19 02:45:37 +00002554 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002555 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002556 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002557 int sign = 1;
2558 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002559
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002560 /* Ensure a is the larger of the two: */
2561 if (size_a < size_b) {
2562 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002563 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002564 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002565 size_a = size_b;
2566 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002567 }
2568 else if (size_a == size_b) {
2569 /* Find highest digit where a and b differ: */
2570 i = size_a;
2571 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2572 ;
2573 if (i < 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002574 return (PyLongObject *)PyLong_FromLong(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002575 if (a->ob_digit[i] < b->ob_digit[i]) {
2576 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002577 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002578 }
2579 size_a = size_b = i+1;
2580 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002581 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002582 if (z == NULL)
2583 return NULL;
2584 for (i = 0; i < size_b; ++i) {
2585 /* The following assumes unsigned arithmetic
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002586 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002587 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002588 z->ob_digit[i] = borrow & PyLong_MASK;
2589 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002590 borrow &= 1; /* Keep only one sign bit */
2591 }
2592 for (; i < size_a; ++i) {
2593 borrow = a->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002594 z->ob_digit[i] = borrow & PyLong_MASK;
2595 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002596 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002597 }
2598 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002599 if (sign < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002600 NEGATE(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002601 return long_normalize(z);
2602}
2603
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002604static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002605long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002606{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002607 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002608
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002609 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002610
Christian Heimes90aa7642007-12-19 02:45:37 +00002611 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Christian Heimes217cfd12007-12-02 14:31:20 +00002612 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002613 MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002614 return result;
2615 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002616 if (Py_SIZE(a) < 0) {
2617 if (Py_SIZE(b) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002618 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002619 if (z != NULL && Py_SIZE(z) != 0)
2620 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002621 }
2622 else
2623 z = x_sub(b, a);
2624 }
2625 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002626 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002627 z = x_sub(a, b);
2628 else
2629 z = x_add(a, b);
2630 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002631 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002632}
2633
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002634static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002635long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002636{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002637 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002638
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002639 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002640
Christian Heimes90aa7642007-12-19 02:45:37 +00002641 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002642 PyObject* r;
2643 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002644 return r;
2645 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002646 if (Py_SIZE(a) < 0) {
2647 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002648 z = x_sub(a, b);
2649 else
2650 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002651 if (z != NULL && Py_SIZE(z) != 0)
2652 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002653 }
2654 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002655 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002656 z = x_add(a, b);
2657 else
2658 z = x_sub(a, b);
2659 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002660 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002661}
2662
Tim Peters5af4e6c2002-08-12 02:31:19 +00002663/* Grade school multiplication, ignoring the signs.
2664 * Returns the absolute value of the product, or NULL if error.
2665 */
2666static PyLongObject *
2667x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002668{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002669 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00002670 Py_ssize_t size_a = ABS(Py_SIZE(a));
2671 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002672 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002673
Tim Peters5af4e6c2002-08-12 02:31:19 +00002674 z = _PyLong_New(size_a + size_b);
2675 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002676 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002677
Christian Heimes90aa7642007-12-19 02:45:37 +00002678 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002679 if (a == b) {
2680 /* Efficient squaring per HAC, Algorithm 14.16:
2681 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2682 * Gives slightly less than a 2x speedup when a == b,
2683 * via exploiting that each entry in the multiplication
2684 * pyramid appears twice (except for the size_a squares).
2685 */
2686 for (i = 0; i < size_a; ++i) {
2687 twodigits carry;
2688 twodigits f = a->ob_digit[i];
2689 digit *pz = z->ob_digit + (i << 1);
2690 digit *pa = a->ob_digit + i + 1;
2691 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002692
Tim Peters0973b992004-08-29 22:16:50 +00002693 SIGCHECK({
2694 Py_DECREF(z);
2695 return NULL;
2696 })
2697
2698 carry = *pz + f * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002699 *pz++ = (digit)(carry & PyLong_MASK);
2700 carry >>= PyLong_SHIFT;
2701 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002702
2703 /* Now f is added in twice in each column of the
2704 * pyramid it appears. Same as adding f<<1 once.
2705 */
2706 f <<= 1;
2707 while (pa < paend) {
2708 carry += *pz + *pa++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002709 *pz++ = (digit)(carry & PyLong_MASK);
2710 carry >>= PyLong_SHIFT;
2711 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002712 }
2713 if (carry) {
2714 carry += *pz;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002715 *pz++ = (digit)(carry & PyLong_MASK);
2716 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002717 }
2718 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002719 *pz += (digit)(carry & PyLong_MASK);
2720 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002721 }
Tim Peters0973b992004-08-29 22:16:50 +00002722 }
2723 else { /* a is not the same as b -- gradeschool long mult */
2724 for (i = 0; i < size_a; ++i) {
2725 twodigits carry = 0;
2726 twodigits f = a->ob_digit[i];
2727 digit *pz = z->ob_digit + i;
2728 digit *pb = b->ob_digit;
2729 digit *pbend = b->ob_digit + size_b;
2730
2731 SIGCHECK({
2732 Py_DECREF(z);
2733 return NULL;
2734 })
2735
2736 while (pb < pbend) {
2737 carry += *pz + *pb++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002738 *pz++ = (digit)(carry & PyLong_MASK);
2739 carry >>= PyLong_SHIFT;
2740 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002741 }
2742 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002743 *pz += (digit)(carry & PyLong_MASK);
2744 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002745 }
2746 }
Tim Peters44121a62002-08-12 06:17:58 +00002747 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002748}
2749
2750/* A helper for Karatsuba multiplication (k_mul).
2751 Takes a long "n" and an integer "size" representing the place to
2752 split, and sets low and high such that abs(n) == (high << size) + low,
2753 viewing the shift as being by digits. The sign bit is ignored, and
2754 the return values are >= 0.
2755 Returns 0 on success, -1 on failure.
2756*/
2757static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002758kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002759{
2760 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002761 Py_ssize_t size_lo, size_hi;
Christian Heimes90aa7642007-12-19 02:45:37 +00002762 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002763
2764 size_lo = MIN(size_n, size);
2765 size_hi = size_n - size_lo;
2766
2767 if ((hi = _PyLong_New(size_hi)) == NULL)
2768 return -1;
2769 if ((lo = _PyLong_New(size_lo)) == NULL) {
2770 Py_DECREF(hi);
2771 return -1;
2772 }
2773
2774 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2775 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2776
2777 *high = long_normalize(hi);
2778 *low = long_normalize(lo);
2779 return 0;
2780}
2781
Tim Peters60004642002-08-12 22:01:34 +00002782static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2783
Tim Peters5af4e6c2002-08-12 02:31:19 +00002784/* Karatsuba multiplication. Ignores the input signs, and returns the
2785 * absolute value of the product (or NULL if error).
2786 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2787 */
2788static PyLongObject *
2789k_mul(PyLongObject *a, PyLongObject *b)
2790{
Christian Heimes90aa7642007-12-19 02:45:37 +00002791 Py_ssize_t asize = ABS(Py_SIZE(a));
2792 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002793 PyLongObject *ah = NULL;
2794 PyLongObject *al = NULL;
2795 PyLongObject *bh = NULL;
2796 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002797 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002798 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002799 Py_ssize_t shift; /* the number of digits we split off */
2800 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002801
Tim Peters5af4e6c2002-08-12 02:31:19 +00002802 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2803 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2804 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002805 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002806 * By picking X to be a power of 2, "*X" is just shifting, and it's
2807 * been reduced to 3 multiplies on numbers half the size.
2808 */
2809
Tim Petersfc07e562002-08-12 02:54:10 +00002810 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002811 * is largest.
2812 */
Tim Peters738eda72002-08-12 15:08:20 +00002813 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002814 t1 = a;
2815 a = b;
2816 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002817
2818 i = asize;
2819 asize = bsize;
2820 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002821 }
2822
2823 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002824 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2825 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002826 if (asize == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002827 return (PyLongObject *)PyLong_FromLong(0);
Tim Peters44121a62002-08-12 06:17:58 +00002828 else
2829 return x_mul(a, b);
2830 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002831
Tim Peters60004642002-08-12 22:01:34 +00002832 /* If a is small compared to b, splitting on b gives a degenerate
2833 * case with ah==0, and Karatsuba may be (even much) less efficient
2834 * than "grade school" then. However, we can still win, by viewing
2835 * b as a string of "big digits", each of width a->ob_size. That
2836 * leads to a sequence of balanced calls to k_mul.
2837 */
2838 if (2 * asize <= bsize)
2839 return k_lopsided_mul(a, b);
2840
Tim Petersd6974a52002-08-13 20:37:51 +00002841 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002842 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002843 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002844 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002845
Tim Peters0973b992004-08-29 22:16:50 +00002846 if (a == b) {
2847 bh = ah;
2848 bl = al;
2849 Py_INCREF(bh);
2850 Py_INCREF(bl);
2851 }
2852 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002853
Tim Petersd64c1de2002-08-12 17:36:03 +00002854 /* The plan:
2855 * 1. Allocate result space (asize + bsize digits: that's always
2856 * enough).
2857 * 2. Compute ah*bh, and copy into result at 2*shift.
2858 * 3. Compute al*bl, and copy into result at 0. Note that this
2859 * can't overlap with #2.
2860 * 4. Subtract al*bl from the result, starting at shift. This may
2861 * underflow (borrow out of the high digit), but we don't care:
2862 * we're effectively doing unsigned arithmetic mod
2863 * BASE**(sizea + sizeb), and so long as the *final* result fits,
2864 * borrows and carries out of the high digit can be ignored.
2865 * 5. Subtract ah*bh from the result, starting at shift.
2866 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2867 * at shift.
2868 */
2869
2870 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002871 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002872 if (ret == NULL) goto fail;
2873#ifdef Py_DEBUG
2874 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002875 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002876#endif
Tim Peters44121a62002-08-12 06:17:58 +00002877
Tim Petersd64c1de2002-08-12 17:36:03 +00002878 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002879 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002880 assert(Py_SIZE(t1) >= 0);
2881 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002882 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimes90aa7642007-12-19 02:45:37 +00002883 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002884
2885 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002886 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002887 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002888 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002889 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002890
Tim Petersd64c1de2002-08-12 17:36:03 +00002891 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002892 if ((t2 = k_mul(al, bl)) == NULL) {
2893 Py_DECREF(t1);
2894 goto fail;
2895 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002896 assert(Py_SIZE(t2) >= 0);
2897 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2898 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002899
2900 /* Zero out remaining digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002901 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002902 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002903 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002904
Tim Petersd64c1de2002-08-12 17:36:03 +00002905 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2906 * because it's fresher in cache.
2907 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002908 i = Py_SIZE(ret) - shift; /* # digits after shift */
2909 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002910 Py_DECREF(t2);
2911
Christian Heimes90aa7642007-12-19 02:45:37 +00002912 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002913 Py_DECREF(t1);
2914
Tim Petersd64c1de2002-08-12 17:36:03 +00002915 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002916 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2917 Py_DECREF(ah);
2918 Py_DECREF(al);
2919 ah = al = NULL;
2920
Tim Peters0973b992004-08-29 22:16:50 +00002921 if (a == b) {
2922 t2 = t1;
2923 Py_INCREF(t2);
2924 }
2925 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002926 Py_DECREF(t1);
2927 goto fail;
2928 }
2929 Py_DECREF(bh);
2930 Py_DECREF(bl);
2931 bh = bl = NULL;
2932
Tim Peters738eda72002-08-12 15:08:20 +00002933 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002934 Py_DECREF(t1);
2935 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002936 if (t3 == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002937 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002938
Tim Petersd6974a52002-08-13 20:37:51 +00002939 /* Add t3. It's not obvious why we can't run out of room here.
2940 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002941 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002942 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002943 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002944
Tim Peters5af4e6c2002-08-12 02:31:19 +00002945 return long_normalize(ret);
2946
2947 fail:
2948 Py_XDECREF(ret);
2949 Py_XDECREF(ah);
2950 Py_XDECREF(al);
2951 Py_XDECREF(bh);
2952 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002953 return NULL;
2954}
2955
Tim Petersd6974a52002-08-13 20:37:51 +00002956/* (*) Why adding t3 can't "run out of room" above.
2957
Tim Petersab86c2b2002-08-15 20:06:00 +00002958Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
2959to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00002960
Tim Petersab86c2b2002-08-15 20:06:00 +000029611. For any integer i, i = c(i/2) + f(i/2). In particular,
2962 bsize = c(bsize/2) + f(bsize/2).
29632. shift = f(bsize/2)
29643. asize <= bsize
29654. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
2966 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00002967
Tim Petersab86c2b2002-08-15 20:06:00 +00002968We allocated asize + bsize result digits, and add t3 into them at an offset
2969of shift. This leaves asize+bsize-shift allocated digit positions for t3
2970to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
2971asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00002972
Tim Petersab86c2b2002-08-15 20:06:00 +00002973bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
2974at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002975
Tim Petersab86c2b2002-08-15 20:06:00 +00002976If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
2977digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
2978most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00002979
Tim Petersab86c2b2002-08-15 20:06:00 +00002980The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00002981
Tim Petersab86c2b2002-08-15 20:06:00 +00002982 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00002983
Tim Petersab86c2b2002-08-15 20:06:00 +00002984and we have asize + c(bsize/2) available digit positions. We need to show
2985this is always enough. An instance of c(bsize/2) cancels out in both, so
2986the question reduces to whether asize digits is enough to hold
2987(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
2988then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
2989asize 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 +00002990digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00002991asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00002992c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
2993is enough to hold 2 bits. This is so if bsize >= 2, which holds because
2994bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00002995
Tim Peters48d52c02002-08-14 17:07:32 +00002996Note that since there's always enough room for (ah+al)*(bh+bl), and that's
2997clearly >= each of ah*bh and al*bl, there's always enough room to subtract
2998ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00002999*/
3000
Tim Peters60004642002-08-12 22:01:34 +00003001/* b has at least twice the digits of a, and a is big enough that Karatsuba
3002 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3003 * of slices, each with a->ob_size digits, and multiply the slices by a,
3004 * one at a time. This gives k_mul balanced inputs to work with, and is
3005 * also cache-friendly (we compute one double-width slice of the result
3006 * at a time, then move on, never bactracking except for the helpful
3007 * single-width slice overlap between successive partial sums).
3008 */
3009static PyLongObject *
3010k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3011{
Christian Heimes90aa7642007-12-19 02:45:37 +00003012 const Py_ssize_t asize = ABS(Py_SIZE(a));
3013 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00003014 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00003015 PyLongObject *ret;
3016 PyLongObject *bslice = NULL;
3017
3018 assert(asize > KARATSUBA_CUTOFF);
3019 assert(2 * asize <= bsize);
3020
3021 /* Allocate result space, and zero it out. */
3022 ret = _PyLong_New(asize + bsize);
3023 if (ret == NULL)
3024 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003025 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003026
3027 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00003028 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00003029 if (bslice == NULL)
3030 goto fail;
3031
3032 nbdone = 0;
3033 while (bsize > 0) {
3034 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003035 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003036
3037 /* Multiply the next slice of b by a. */
3038 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3039 nbtouse * sizeof(digit));
Christian Heimes90aa7642007-12-19 02:45:37 +00003040 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00003041 product = k_mul(a, bslice);
3042 if (product == NULL)
3043 goto fail;
3044
3045 /* Add into result. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003046 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3047 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00003048 Py_DECREF(product);
3049
3050 bsize -= nbtouse;
3051 nbdone += nbtouse;
3052 }
3053
3054 Py_DECREF(bslice);
3055 return long_normalize(ret);
3056
3057 fail:
3058 Py_DECREF(ret);
3059 Py_XDECREF(bslice);
3060 return NULL;
3061}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003062
3063static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003064long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003065{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003066 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003067
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003068 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003069
Mark Dickinsonbd792642009-03-18 20:06:12 +00003070 /* fast path for single-digit multiplication */
Christian Heimes90aa7642007-12-19 02:45:37 +00003071 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Mark Dickinsonbd792642009-03-18 20:06:12 +00003072 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
3073#ifdef HAVE_LONG_LONG
3074 return PyLong_FromLongLong((PY_LONG_LONG)v);
3075#else
3076 /* if we don't have long long then we're almost certainly
3077 using 15-bit digits, so v will fit in a long. In the
3078 unlikely event that we're using 30-bit digits on a platform
3079 without long long, a large v will just cause us to fall
3080 through to the general multiplication code below. */
3081 if (v >= LONG_MIN && v <= LONG_MAX)
3082 return PyLong_FromLong((long)v);
3083#endif
Martin v. Löwis14b6d922007-02-06 21:05:30 +00003084 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003085
Tim Petersd64c1de2002-08-12 17:36:03 +00003086 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00003087 /* Negate if exactly one of the inputs is negative. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003088 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003089 NEGATE(z);
Tim Peters9973d742002-08-15 19:41:06 +00003090 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003091}
3092
Guido van Rossume32e0141992-01-19 16:31:05 +00003093/* The / and % operators are now defined in terms of divmod().
3094 The expression a mod b has the value a - b*floor(a/b).
3095 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003096 |a| by |b|, with the sign of a. This is also expressed
3097 as a - b*trunc(a/b), if trunc truncates towards zero.
3098 Some examples:
3099 a b a rem b a mod b
3100 13 10 3 3
3101 -13 10 -3 7
3102 13 -10 3 -7
3103 -13 -10 -3 -3
3104 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003105 have different signs. We then subtract one from the 'div'
3106 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003107
Tim Peters47e52ee2004-08-30 02:44:38 +00003108/* Compute
3109 * *pdiv, *pmod = divmod(v, w)
3110 * NULL can be passed for pdiv or pmod, in which case that part of
3111 * the result is simply thrown away. The caller owns a reference to
3112 * each of these it requests (does not pass NULL for).
3113 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003114static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003115l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00003116 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003117{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003118 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003119
Guido van Rossume32e0141992-01-19 16:31:05 +00003120 if (long_divrem(v, w, &div, &mod) < 0)
3121 return -1;
Christian Heimes90aa7642007-12-19 02:45:37 +00003122 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3123 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003124 PyLongObject *temp;
3125 PyLongObject *one;
3126 temp = (PyLongObject *) long_add(mod, w);
3127 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00003128 mod = temp;
3129 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003130 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003131 return -1;
3132 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003133 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00003134 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003135 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3136 Py_DECREF(mod);
3137 Py_DECREF(div);
3138 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00003139 return -1;
3140 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003141 Py_DECREF(one);
3142 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003143 div = temp;
3144 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003145 if (pdiv != NULL)
3146 *pdiv = div;
3147 else
3148 Py_DECREF(div);
3149
3150 if (pmod != NULL)
3151 *pmod = mod;
3152 else
3153 Py_DECREF(mod);
3154
Guido van Rossume32e0141992-01-19 16:31:05 +00003155 return 0;
3156}
3157
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003158static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003159long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003160{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003161 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003162
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003163 CHECK_BINOP(a, b);
3164 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003165 div = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003166 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003167}
3168
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003169static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003170long_true_divide(PyObject *a, PyObject *b)
Tim Peters20dab9f2001-09-04 05:31:47 +00003171{
Tim Peterse2a60002001-09-04 06:17:36 +00003172 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00003173 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00003174
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003175 CHECK_BINOP(a, b);
Tim Peterse2a60002001-09-04 06:17:36 +00003176 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
3177 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00003178 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
Tim Peters6f97e492001-11-04 23:09:40 +00003179 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00003180 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00003181 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
3182 but should really be set correctly after sucessful calls to
3183 _PyLong_AsScaledDouble() */
3184 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00003185
3186 if (bd == 0.0) {
3187 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003188 "int division or modulo by zero");
Tim Peterse2a60002001-09-04 06:17:36 +00003189 return NULL;
3190 }
3191
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003192 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00003193 ad /= bd; /* overflow/underflow impossible here */
3194 aexp -= bexp;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003195 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00003196 goto overflow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003197 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00003198 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003199 errno = 0;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003200 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00003201 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003202 goto overflow;
3203 return PyFloat_FromDouble(ad);
3204
3205overflow:
3206 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003207 "int/int too large for a float");
Tim Peterse2a60002001-09-04 06:17:36 +00003208 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003209
Tim Peters20dab9f2001-09-04 05:31:47 +00003210}
3211
3212static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003213long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003214{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003215 PyLongObject *mod;
3216
3217 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003218
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003219 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003220 mod = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003221 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003222}
3223
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003224static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003225long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003226{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003227 PyLongObject *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003228 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003229
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003230 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003231
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003232 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003233 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003234 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003235 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003236 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003237 PyTuple_SetItem(z, 0, (PyObject *) div);
3238 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003239 }
3240 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003241 Py_DECREF(div);
3242 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003243 }
3244 return z;
3245}
3246
Tim Peters47e52ee2004-08-30 02:44:38 +00003247/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003248static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003249long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003250{
Tim Peters47e52ee2004-08-30 02:44:38 +00003251 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3252 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003253
Tim Peters47e52ee2004-08-30 02:44:38 +00003254 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00003255 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00003256 PyLongObject *temp = NULL;
3257
3258 /* 5-ary values. If the exponent is large enough, table is
3259 * precomputed so that table[i] == a**i % c for i in range(32).
3260 */
3261 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3262 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
3263
3264 /* a, b, c = v, w, x */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003265 CHECK_BINOP(v, w);
3266 a = (PyLongObject*)v; Py_INCREF(a);
3267 b = (PyLongObject*)w; Py_INCREF(b);
Tim Peters47e52ee2004-08-30 02:44:38 +00003268 if (PyLong_Check(x)) {
3269 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003270 Py_INCREF(x);
3271 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003272 else if (x == Py_None)
3273 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003274 else {
3275 Py_DECREF(a);
3276 Py_DECREF(b);
3277 Py_INCREF(Py_NotImplemented);
3278 return Py_NotImplemented;
3279 }
Tim Peters4c483c42001-09-05 06:24:58 +00003280
Christian Heimes90aa7642007-12-19 02:45:37 +00003281 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00003282 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00003283 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00003284 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00003285 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00003286 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003287 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00003288 /* else return a float. This works because we know
3289 that this calls float_pow() which converts its
3290 arguments to double. */
3291 Py_DECREF(a);
3292 Py_DECREF(b);
3293 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003294 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003295 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003296
3297 if (c) {
3298 /* if modulus == 0:
3299 raise ValueError() */
Christian Heimes90aa7642007-12-19 02:45:37 +00003300 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003301 PyErr_SetString(PyExc_ValueError,
3302 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00003303 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003304 }
3305
3306 /* if modulus < 0:
3307 negativeOutput = True
3308 modulus = -modulus */
Christian Heimes90aa7642007-12-19 02:45:37 +00003309 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003310 negativeOutput = 1;
3311 temp = (PyLongObject *)_PyLong_Copy(c);
3312 if (temp == NULL)
3313 goto Error;
3314 Py_DECREF(c);
3315 c = temp;
3316 temp = NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003317 NEGATE(c);
Tim Peters47e52ee2004-08-30 02:44:38 +00003318 }
3319
3320 /* if modulus == 1:
3321 return 0 */
Christian Heimes90aa7642007-12-19 02:45:37 +00003322 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003323 z = (PyLongObject *)PyLong_FromLong(0L);
3324 goto Done;
3325 }
3326
3327 /* if base < 0:
3328 base = base % modulus
3329 Having the base positive just makes things easier. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003330 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003331 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003332 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003333 Py_DECREF(a);
3334 a = temp;
3335 temp = NULL;
3336 }
3337 }
3338
3339 /* At this point a, b, and c are guaranteed non-negative UNLESS
3340 c is NULL, in which case a may be negative. */
3341
3342 z = (PyLongObject *)PyLong_FromLong(1L);
3343 if (z == NULL)
3344 goto Error;
3345
3346 /* Perform a modular reduction, X = X % c, but leave X alone if c
3347 * is NULL.
3348 */
3349#define REDUCE(X) \
3350 if (c != NULL) { \
3351 if (l_divmod(X, c, NULL, &temp) < 0) \
3352 goto Error; \
3353 Py_XDECREF(X); \
3354 X = temp; \
3355 temp = NULL; \
3356 }
3357
3358 /* Multiply two values, then reduce the result:
3359 result = X*Y % c. If c is NULL, skip the mod. */
3360#define MULT(X, Y, result) \
3361{ \
3362 temp = (PyLongObject *)long_mul(X, Y); \
3363 if (temp == NULL) \
3364 goto Error; \
3365 Py_XDECREF(result); \
3366 result = temp; \
3367 temp = NULL; \
3368 REDUCE(result) \
3369}
3370
Christian Heimes90aa7642007-12-19 02:45:37 +00003371 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003372 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3373 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimes90aa7642007-12-19 02:45:37 +00003374 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003375 digit bi = b->ob_digit[i];
3376
Mark Dickinsone4416742009-02-15 15:14:57 +00003377 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003378 MULT(z, z, z)
3379 if (bi & j)
3380 MULT(z, a, z)
3381 }
3382 }
3383 }
3384 else {
3385 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3386 Py_INCREF(z); /* still holds 1L */
3387 table[0] = z;
3388 for (i = 1; i < 32; ++i)
3389 MULT(table[i-1], a, table[i])
3390
Christian Heimes90aa7642007-12-19 02:45:37 +00003391 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003392 const digit bi = b->ob_digit[i];
3393
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003394 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003395 const int index = (bi >> j) & 0x1f;
3396 for (k = 0; k < 5; ++k)
3397 MULT(z, z, z)
3398 if (index)
3399 MULT(z, table[index], z)
3400 }
3401 }
3402 }
3403
Christian Heimes90aa7642007-12-19 02:45:37 +00003404 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003405 temp = (PyLongObject *)long_sub(z, c);
3406 if (temp == NULL)
3407 goto Error;
3408 Py_DECREF(z);
3409 z = temp;
3410 temp = NULL;
3411 }
3412 goto Done;
3413
3414 Error:
3415 if (z != NULL) {
3416 Py_DECREF(z);
3417 z = NULL;
3418 }
3419 /* fall through */
3420 Done:
Christian Heimes90aa7642007-12-19 02:45:37 +00003421 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003422 for (i = 0; i < 32; ++i)
3423 Py_XDECREF(table[i]);
3424 }
Tim Petersde7990b2005-07-17 23:45:23 +00003425 Py_DECREF(a);
3426 Py_DECREF(b);
3427 Py_XDECREF(c);
3428 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003429 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003430}
3431
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003432static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003433long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003434{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003435 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003436 PyLongObject *x;
3437 PyLongObject *w;
Christian Heimes90aa7642007-12-19 02:45:37 +00003438 if (ABS(Py_SIZE(v)) <=1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003439 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003440 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003441 if (w == NULL)
3442 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003443 x = (PyLongObject *) long_add(v, w);
3444 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003445 if (x == NULL)
3446 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003447 Py_SIZE(x) = -(Py_SIZE(x));
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003448 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003449}
3450
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003451static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003452long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003453{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003454 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00003455 if (ABS(Py_SIZE(v)) <= 1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003456 return PyLong_FromLong(-MEDIUM_VALUE(v));
Tim Peters69c2de32001-09-11 22:31:33 +00003457 z = (PyLongObject *)_PyLong_Copy(v);
3458 if (z != NULL)
Christian Heimes90aa7642007-12-19 02:45:37 +00003459 Py_SIZE(z) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003460 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003461}
3462
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003463static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003464long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003465{
Christian Heimes90aa7642007-12-19 02:45:37 +00003466 if (Py_SIZE(v) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003467 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003468 else
Guido van Rossumb43daf72007-08-01 18:08:08 +00003469 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003470}
3471
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003472static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003473long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003474{
Christian Heimes90aa7642007-12-19 02:45:37 +00003475 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003476}
3477
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003478static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003479long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003480{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003481 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003482 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003483 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003484 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003485
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003486 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003487
Christian Heimes90aa7642007-12-19 02:45:37 +00003488 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003489 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003490 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003491 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003492 if (a1 == NULL)
3493 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003494 a2 = (PyLongObject *) long_rshift(a1, b);
3495 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003496 if (a2 == NULL)
3497 goto rshift_error;
3498 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003499 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003500 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003501 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003502
Neil Schemenauerba872e22001-01-04 01:46:03 +00003503 shiftby = PyLong_AsLong((PyObject *)b);
3504 if (shiftby == -1L && PyErr_Occurred())
3505 goto rshift_error;
3506 if (shiftby < 0) {
3507 PyErr_SetString(PyExc_ValueError,
3508 "negative shift count");
3509 goto rshift_error;
3510 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003511 wordshift = shiftby / PyLong_SHIFT;
Christian Heimes90aa7642007-12-19 02:45:37 +00003512 newsize = ABS(Py_SIZE(a)) - wordshift;
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003513 if (newsize <= 0)
3514 return PyLong_FromLong(0);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003515 loshift = shiftby % PyLong_SHIFT;
3516 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003517 lomask = ((digit)1 << hishift) - 1;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003518 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003519 z = _PyLong_New(newsize);
3520 if (z == NULL)
3521 goto rshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003522 if (Py_SIZE(a) < 0)
3523 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003524 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3525 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3526 if (i+1 < newsize)
3527 z->ob_digit[i] |=
3528 (a->ob_digit[j+1] << hishift) & himask;
3529 }
3530 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003531 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003532rshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003533 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003534
Guido van Rossumc6913e71991-11-19 20:26:46 +00003535}
3536
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003537static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003538long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003539{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003540 /* This version due to Tim Peters */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003541 PyLongObject *a = (PyLongObject*)v;
3542 PyLongObject *b = (PyLongObject*)w;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003543 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003544 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003545 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003546 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003547
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003548 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003549
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003550 shiftby = PyLong_AsLong((PyObject *)b);
3551 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003552 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003553 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003554 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003555 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003556 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003557 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003558 PyErr_SetString(PyExc_ValueError,
3559 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003560 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003561 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003562 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3563 wordshift = (int)shiftby / PyLong_SHIFT;
3564 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003565
Christian Heimes90aa7642007-12-19 02:45:37 +00003566 oldsize = ABS(Py_SIZE(a));
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003567 newsize = oldsize + wordshift;
3568 if (remshift)
3569 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003570 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003571 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003572 goto lshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003573 if (Py_SIZE(a) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003574 NEGATE(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003575 for (i = 0; i < wordshift; i++)
3576 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003577 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003578 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003579 accum |= (twodigits)a->ob_digit[j] << remshift;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003580 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3581 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003582 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003583 if (remshift)
3584 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003585 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003586 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003587 z = long_normalize(z);
3588lshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003589 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003590}
3591
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003592
3593/* Bitwise and/xor/or operations */
3594
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003595static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003596long_bitwise(PyLongObject *a,
3597 int op, /* '&', '|', '^' */
3598 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003599{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003600 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003601 int negz;
Mark Dickinsone4416742009-02-15 15:14:57 +00003602 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003603 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003604 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003605 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003606
Christian Heimes90aa7642007-12-19 02:45:37 +00003607 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003608 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003609 if (a == NULL)
3610 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003611 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003612 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003613 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003614 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003615 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003616 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003617 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003618 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003619 if (b == NULL) {
3620 Py_DECREF(a);
3621 return NULL;
3622 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003623 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003624 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003625 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003626 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003627 maskb = 0;
3628 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003629
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003630 negz = 0;
3631 switch (op) {
3632 case '^':
3633 if (maska != maskb) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003634 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003635 negz = -1;
3636 }
3637 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003638 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003639 if (maska && maskb) {
3640 op = '|';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003641 maska ^= PyLong_MASK;
3642 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003643 negz = -1;
3644 }
3645 break;
3646 case '|':
3647 if (maska || maskb) {
3648 op = '&';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003649 maska ^= PyLong_MASK;
3650 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003651 negz = -1;
3652 }
3653 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003654 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003655
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003656 /* JRH: The original logic here was to allocate the result value (z)
3657 as the longer of the two operands. However, there are some cases
3658 where the result is guaranteed to be shorter than that: AND of two
3659 positives, OR of two negatives: use the shorter number. AND with
3660 mixed signs: use the positive number. OR with mixed signs: use the
3661 negative number. After the transformations above, op will be '&'
3662 iff one of these cases applies, and mask will be non-0 for operands
3663 whose length should be ignored.
3664 */
3665
Christian Heimes90aa7642007-12-19 02:45:37 +00003666 size_a = Py_SIZE(a);
3667 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003668 size_z = op == '&'
3669 ? (maska
3670 ? size_b
3671 : (maskb ? size_a : MIN(size_a, size_b)))
3672 : MAX(size_a, size_b);
3673 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003674 if (z == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003675 Py_DECREF(a);
3676 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003677 return NULL;
3678 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003679
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003680 for (i = 0; i < size_z; ++i) {
3681 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3682 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3683 switch (op) {
3684 case '&': z->ob_digit[i] = diga & digb; break;
3685 case '|': z->ob_digit[i] = diga | digb; break;
3686 case '^': z->ob_digit[i] = diga ^ digb; break;
3687 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003688 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003689
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003690 Py_DECREF(a);
3691 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003692 z = long_normalize(z);
3693 if (negz == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003694 return (PyObject *) maybe_small_long(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003695 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003696 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003697 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003698}
3699
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003700static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003701long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003702{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003703 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003704 CHECK_BINOP(a, b);
3705 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003706 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003707}
3708
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003709static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003710long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003711{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003712 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003713 CHECK_BINOP(a, b);
3714 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003715 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003716}
3717
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003718static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003719long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003720{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003721 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003722 CHECK_BINOP(a, b);
3723 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003724 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003725}
3726
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003727static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003728long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003729{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003730 if (PyLong_CheckExact(v))
3731 Py_INCREF(v);
3732 else
3733 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003734 return v;
3735}
3736
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003737static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003738long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003739{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003740 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003741 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003742 if (result == -1.0 && PyErr_Occurred())
3743 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003744 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003745}
3746
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003747static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003748long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003749
Tim Peters6d6c1a32001-08-02 04:15:00 +00003750static PyObject *
3751long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3752{
3753 PyObject *x = NULL;
3754 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003755 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003756
Guido van Rossumbef14172001-08-29 15:47:46 +00003757 if (type != &PyLong_Type)
3758 return long_subtype_new(type, args, kwds); /* Wimp out */
Guido van Rossumddefaf32007-01-14 03:31:43 +00003759 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:int", kwlist,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003760 &x, &base))
3761 return NULL;
3762 if (x == NULL)
3763 return PyLong_FromLong(0L);
3764 if (base == -909)
3765 return PyNumber_Long(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003766 else if (PyUnicode_Check(x))
3767 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3768 PyUnicode_GET_SIZE(x),
3769 base);
Christian Heimes72b710a2008-05-26 13:28:38 +00003770 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Guido van Rossumd8faa362007-04-27 19:54:29 +00003771 /* Since PyLong_FromString doesn't have a length parameter,
3772 * check here for possible NULs in the string. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00003773 char *string;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003774 Py_ssize_t size = Py_SIZE(x);
Christian Heimes9c4756e2008-05-26 13:22:05 +00003775 if (PyByteArray_Check(x))
3776 string = PyByteArray_AS_STRING(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003777 else
Christian Heimes72b710a2008-05-26 13:28:38 +00003778 string = PyBytes_AS_STRING(x);
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003779 if (strlen(string) != (size_t)size) {
Guido van Rossum25236212007-08-22 23:28:23 +00003780 /* We only see this if there's a null byte in x,
Guido van Rossum98297ee2007-11-06 21:34:58 +00003781 x is a bytes or buffer, *and* a base is given. */
Guido van Rossumd8faa362007-04-27 19:54:29 +00003782 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00003783 "invalid literal for int() with base %d: %R",
3784 base, x);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003785 return NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003786 }
Guido van Rossum4581ae52007-05-22 21:56:47 +00003787 return PyLong_FromString(string, NULL, base);
Guido van Rossumddefaf32007-01-14 03:31:43 +00003788 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003789 else {
3790 PyErr_SetString(PyExc_TypeError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003791 "int() can't convert non-string with explicit base");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003792 return NULL;
3793 }
3794}
3795
Guido van Rossumbef14172001-08-29 15:47:46 +00003796/* Wimpy, slow approach to tp_new calls for subtypes of long:
3797 first create a regular long from whatever arguments we got,
3798 then allocate a subtype instance and initialize it from
3799 the regular long. The regular long is then thrown away.
3800*/
3801static PyObject *
3802long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3803{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003804 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003805 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003806
3807 assert(PyType_IsSubtype(type, &PyLong_Type));
3808 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3809 if (tmp == NULL)
3810 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003811 assert(PyLong_CheckExact(tmp));
Christian Heimes90aa7642007-12-19 02:45:37 +00003812 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003813 if (n < 0)
3814 n = -n;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003815 newobj = (PyLongObject *)type->tp_alloc(type, n);
3816 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003817 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003818 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003819 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003820 assert(PyLong_Check(newobj));
Christian Heimes90aa7642007-12-19 02:45:37 +00003821 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003822 for (i = 0; i < n; i++)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003823 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003824 Py_DECREF(tmp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003825 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003826}
3827
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003828static PyObject *
3829long_getnewargs(PyLongObject *v)
3830{
3831 return Py_BuildValue("(N)", _PyLong_Copy(v));
3832}
3833
Guido van Rossumb43daf72007-08-01 18:08:08 +00003834static PyObject *
3835long_getN(PyLongObject *v, void *context) {
Christian Heimesc36625b2008-01-04 13:33:00 +00003836 return PyLong_FromLong((Py_intptr_t)context);
Guido van Rossumb43daf72007-08-01 18:08:08 +00003837}
3838
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003839static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00003840long__format__(PyObject *self, PyObject *args)
3841{
Eric Smith4a7d76d2008-05-30 18:10:19 +00003842 PyObject *format_spec;
3843
3844 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
3845 return NULL;
3846 return _PyLong_FormatAdvanced(self,
3847 PyUnicode_AS_UNICODE(format_spec),
3848 PyUnicode_GET_SIZE(format_spec));
Eric Smith8c663262007-08-25 02:26:07 +00003849}
3850
Eric Smith8c663262007-08-25 02:26:07 +00003851static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003852long_round(PyObject *self, PyObject *args)
3853{
Mark Dickinson1124e712009-01-28 21:25:58 +00003854 PyObject *o_ndigits=NULL, *temp;
3855 PyLongObject *pow=NULL, *q=NULL, *r=NULL, *ndigits=NULL, *one;
3856 int errcode;
3857 digit q_mod_4;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003858
Mark Dickinson1124e712009-01-28 21:25:58 +00003859 /* Notes on the algorithm: to round to the nearest 10**n (n positive),
3860 the straightforward method is:
3861
3862 (1) divide by 10**n
3863 (2) round to nearest integer (round to even in case of tie)
3864 (3) multiply result by 10**n.
3865
3866 But the rounding step involves examining the fractional part of the
3867 quotient to see whether it's greater than 0.5 or not. Since we
3868 want to do the whole calculation in integer arithmetic, it's
3869 simpler to do:
3870
3871 (1) divide by (10**n)/2
3872 (2) round to nearest multiple of 2 (multiple of 4 in case of tie)
3873 (3) multiply result by (10**n)/2.
3874
3875 Then all we need to know about the fractional part of the quotient
3876 arising in step (2) is whether it's zero or not.
3877
3878 Doing both a multiplication and division is wasteful, and is easily
3879 avoided if we just figure out how much to adjust the original input
3880 by to do the rounding.
3881
3882 Here's the whole algorithm expressed in Python.
3883
3884 def round(self, ndigits = None):
3885 """round(int, int) -> int"""
3886 if ndigits is None or ndigits >= 0:
3887 return self
3888 pow = 10**-ndigits >> 1
3889 q, r = divmod(self, pow)
3890 self -= r
3891 if (q & 1 != 0):
3892 if (q & 2 == r == 0):
3893 self -= pow
3894 else:
3895 self += pow
3896 return self
3897
3898 */
3899 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
3900 return NULL;
3901 if (o_ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003902 return long_long(self);
3903
Mark Dickinson1124e712009-01-28 21:25:58 +00003904 ndigits = (PyLongObject *)PyNumber_Index(o_ndigits);
3905 if (ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003906 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00003907
3908 if (Py_SIZE(ndigits) >= 0) {
3909 Py_DECREF(ndigits);
3910 return long_long(self);
3911 }
3912
3913 Py_INCREF(self); /* to keep refcounting simple */
3914 /* we now own references to self, ndigits */
3915
3916 /* pow = 10 ** -ndigits >> 1 */
3917 pow = (PyLongObject *)PyLong_FromLong(10L);
3918 if (pow == NULL)
3919 goto error;
3920 temp = long_neg(ndigits);
3921 Py_DECREF(ndigits);
3922 ndigits = (PyLongObject *)temp;
3923 if (ndigits == NULL)
3924 goto error;
3925 temp = long_pow((PyObject *)pow, (PyObject *)ndigits, Py_None);
3926 Py_DECREF(pow);
3927 pow = (PyLongObject *)temp;
3928 if (pow == NULL)
3929 goto error;
3930 assert(PyLong_Check(pow)); /* check long_pow returned a long */
3931 one = (PyLongObject *)PyLong_FromLong(1L);
3932 if (one == NULL)
3933 goto error;
3934 temp = long_rshift(pow, one);
3935 Py_DECREF(one);
3936 Py_DECREF(pow);
3937 pow = (PyLongObject *)temp;
3938 if (pow == NULL)
3939 goto error;
3940
3941 /* q, r = divmod(self, pow) */
3942 errcode = l_divmod((PyLongObject *)self, pow, &q, &r);
3943 if (errcode == -1)
3944 goto error;
3945
3946 /* self -= r */
3947 temp = long_sub((PyLongObject *)self, r);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003948 Py_DECREF(self);
Mark Dickinson1124e712009-01-28 21:25:58 +00003949 self = temp;
3950 if (self == NULL)
3951 goto error;
3952
3953 /* get value of quotient modulo 4 */
3954 if (Py_SIZE(q) == 0)
3955 q_mod_4 = 0;
3956 else if (Py_SIZE(q) > 0)
3957 q_mod_4 = q->ob_digit[0] & 3;
3958 else
3959 q_mod_4 = (PyLong_BASE-q->ob_digit[0]) & 3;
3960
3961 if ((q_mod_4 & 1) == 1) {
3962 /* q is odd; round self up or down by adding or subtracting pow */
3963 if (q_mod_4 == 1 && Py_SIZE(r) == 0)
3964 temp = (PyObject *)long_sub((PyLongObject *)self, pow);
3965 else
3966 temp = (PyObject *)long_add((PyLongObject *)self, pow);
3967 Py_DECREF(self);
3968 self = temp;
3969 if (self == NULL)
3970 goto error;
3971 }
3972 Py_DECREF(q);
3973 Py_DECREF(r);
3974 Py_DECREF(pow);
3975 Py_DECREF(ndigits);
3976 return self;
3977
3978 error:
3979 Py_XDECREF(q);
3980 Py_XDECREF(r);
3981 Py_XDECREF(pow);
3982 Py_XDECREF(self);
3983 Py_XDECREF(ndigits);
3984 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003985}
3986
Martin v. Löwis00709aa2008-06-04 14:18:43 +00003987static PyObject *
3988long_sizeof(PyLongObject *v)
3989{
3990 Py_ssize_t res;
3991
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003992 res = offsetof(PyLongObject, ob_digit) + ABS(Py_SIZE(v))*sizeof(digit);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00003993 return PyLong_FromSsize_t(res);
3994}
3995
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00003996static PyObject *
3997long_bit_length(PyLongObject *v)
3998{
3999 PyLongObject *result, *x, *y;
4000 Py_ssize_t ndigits, msd_bits = 0;
4001 digit msd;
4002
4003 assert(v != NULL);
4004 assert(PyLong_Check(v));
4005
4006 ndigits = ABS(Py_SIZE(v));
4007 if (ndigits == 0)
4008 return PyLong_FromLong(0);
4009
4010 msd = v->ob_digit[ndigits-1];
4011 while (msd >= 32) {
4012 msd_bits += 6;
4013 msd >>= 6;
4014 }
4015 msd_bits += (long)(BitLengthTable[msd]);
4016
4017 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4018 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
4019
4020 /* expression above may overflow; use Python integers instead */
4021 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4022 if (result == NULL)
4023 return NULL;
4024 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4025 if (x == NULL)
4026 goto error;
4027 y = (PyLongObject *)long_mul(result, x);
4028 Py_DECREF(x);
4029 if (y == NULL)
4030 goto error;
4031 Py_DECREF(result);
4032 result = y;
4033
4034 x = (PyLongObject *)PyLong_FromLong(msd_bits);
4035 if (x == NULL)
4036 goto error;
4037 y = (PyLongObject *)long_add(result, x);
4038 Py_DECREF(x);
4039 if (y == NULL)
4040 goto error;
4041 Py_DECREF(result);
4042 result = y;
4043
4044 return (PyObject *)result;
4045
4046error:
4047 Py_DECREF(result);
4048 return NULL;
4049}
4050
4051PyDoc_STRVAR(long_bit_length_doc,
4052"int.bit_length() -> int\n\
4053\n\
4054Number of bits necessary to represent self in binary.\n\
4055>>> bin(37)\n\
4056'0b100101'\n\
4057>>> (37).bit_length()\n\
40586");
4059
Christian Heimes53876d92008-04-19 00:31:39 +00004060#if 0
4061static PyObject *
4062long_is_finite(PyObject *v)
4063{
4064 Py_RETURN_TRUE;
4065}
4066#endif
4067
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004068static PyMethodDef long_methods[] = {
Guido van Rossumb43daf72007-08-01 18:08:08 +00004069 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
4070 "Returns self, the complex conjugate of any int."},
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004071 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
4072 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00004073#if 0
4074 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
4075 "Returns always True."},
4076#endif
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004077 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
4078 "Truncating an Integral returns itself."},
4079 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
4080 "Flooring an Integral returns itself."},
4081 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
4082 "Ceiling of an Integral returns itself."},
4083 {"__round__", (PyCFunction)long_round, METH_VARARGS,
Mark Dickinson1124e712009-01-28 21:25:58 +00004084 "Rounding an Integral returns itself.\n"
4085 "Rounding with an ndigits argument also returns an integer."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004086 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smith8c663262007-08-25 02:26:07 +00004087 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004088 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
4089 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004090 {NULL, NULL} /* sentinel */
4091};
4092
Guido van Rossumb43daf72007-08-01 18:08:08 +00004093static PyGetSetDef long_getset[] = {
4094 {"real",
4095 (getter)long_long, (setter)NULL,
4096 "the real part of a complex number",
4097 NULL},
4098 {"imag",
4099 (getter)long_getN, (setter)NULL,
4100 "the imaginary part of a complex number",
4101 (void*)0},
4102 {"numerator",
4103 (getter)long_long, (setter)NULL,
4104 "the numerator of a rational number in lowest terms",
4105 NULL},
4106 {"denominator",
4107 (getter)long_getN, (setter)NULL,
4108 "the denominator of a rational number in lowest terms",
4109 (void*)1},
4110 {NULL} /* Sentinel */
4111};
4112
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004113PyDoc_STRVAR(long_doc,
Guido van Rossumddefaf32007-01-14 03:31:43 +00004114"int(x[, base]) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004115\n\
Guido van Rossumddefaf32007-01-14 03:31:43 +00004116Convert a string or number to an integer, if possible. A floating\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004117point argument will be truncated towards zero (this does not include a\n\
4118string representation of a floating point number!) When converting a\n\
4119string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004120converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004121
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004122static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00004123 (binaryfunc) long_add, /*nb_add*/
4124 (binaryfunc) long_sub, /*nb_subtract*/
4125 (binaryfunc) long_mul, /*nb_multiply*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004126 long_mod, /*nb_remainder*/
4127 long_divmod, /*nb_divmod*/
4128 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004129 (unaryfunc) long_neg, /*nb_negative*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004130 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004131 (unaryfunc) long_abs, /*tp_absolute*/
Jack Diederich4dafcc42006-11-28 19:15:13 +00004132 (inquiry) long_bool, /*tp_bool*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004133 (unaryfunc) long_invert, /*nb_invert*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004134 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004135 (binaryfunc) long_rshift, /*nb_rshift*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004136 long_and, /*nb_and*/
4137 long_xor, /*nb_xor*/
4138 long_or, /*nb_or*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004139 long_long, /*nb_int*/
Mark Dickinson8055afd2009-01-17 10:04:45 +00004140 0, /*nb_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004141 long_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00004142 0, /* nb_inplace_add */
4143 0, /* nb_inplace_subtract */
4144 0, /* nb_inplace_multiply */
Guido van Rossum4668b002001-08-08 05:00:18 +00004145 0, /* nb_inplace_remainder */
4146 0, /* nb_inplace_power */
4147 0, /* nb_inplace_lshift */
4148 0, /* nb_inplace_rshift */
4149 0, /* nb_inplace_and */
4150 0, /* nb_inplace_xor */
4151 0, /* nb_inplace_or */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004152 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00004153 long_true_divide, /* nb_true_divide */
4154 0, /* nb_inplace_floor_divide */
4155 0, /* nb_inplace_true_divide */
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00004156 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004157};
4158
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004159PyTypeObject PyLong_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004160 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00004161 "int", /* tp_name */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004162 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004163 sizeof(digit), /* tp_itemsize */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004164 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004165 0, /* tp_print */
4166 0, /* tp_getattr */
4167 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00004168 0, /* tp_reserved */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004169 long_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004170 &long_as_number, /* tp_as_number */
4171 0, /* tp_as_sequence */
4172 0, /* tp_as_mapping */
4173 (hashfunc)long_hash, /* tp_hash */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004174 0, /* tp_call */
4175 long_repr, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004176 PyObject_GenericGetAttr, /* tp_getattro */
4177 0, /* tp_setattro */
4178 0, /* tp_as_buffer */
Thomas Wouters27d517b2007-02-25 20:39:11 +00004179 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
4180 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004181 long_doc, /* tp_doc */
4182 0, /* tp_traverse */
4183 0, /* tp_clear */
Guido van Rossum47b9ff62006-08-24 00:41:19 +00004184 long_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004185 0, /* tp_weaklistoffset */
4186 0, /* tp_iter */
4187 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004188 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004189 0, /* tp_members */
Guido van Rossumb43daf72007-08-01 18:08:08 +00004190 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004191 0, /* tp_base */
4192 0, /* tp_dict */
4193 0, /* tp_descr_get */
4194 0, /* tp_descr_set */
4195 0, /* tp_dictoffset */
4196 0, /* tp_init */
4197 0, /* tp_alloc */
4198 long_new, /* tp_new */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004199 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004200};
Guido van Rossumddefaf32007-01-14 03:31:43 +00004201
Mark Dickinsonbd792642009-03-18 20:06:12 +00004202static PyTypeObject Int_InfoType;
4203
4204PyDoc_STRVAR(int_info__doc__,
4205"sys.int_info\n\
4206\n\
4207A struct sequence that holds information about Python's\n\
4208internal representation of integers. The attributes are read only.");
4209
4210static PyStructSequence_Field int_info_fields[] = {
4211 {"bits_per_digit", "size of a digit in bits"},
4212 {"sizeof_digit", "size in bytes of the C type used to "
4213 "represent a digit"},
4214 {NULL, NULL}
4215};
4216
4217static PyStructSequence_Desc int_info_desc = {
4218 "sys.int_info", /* name */
4219 int_info__doc__, /* doc */
4220 int_info_fields, /* fields */
4221 2 /* number of fields */
4222};
4223
4224PyObject *
4225PyLong_GetInfo(void)
4226{
4227 PyObject* int_info;
4228 int field = 0;
4229 int_info = PyStructSequence_New(&Int_InfoType);
4230 if (int_info == NULL)
4231 return NULL;
Mark Dickinson0bdab682009-04-02 18:41:40 +00004232 PyStructSequence_SET_ITEM(int_info, field++,
4233 PyLong_FromLong(PyLong_SHIFT));
4234 PyStructSequence_SET_ITEM(int_info, field++,
4235 PyLong_FromLong(sizeof(digit)));
Mark Dickinsonbd792642009-03-18 20:06:12 +00004236 if (PyErr_Occurred()) {
4237 Py_CLEAR(int_info);
4238 return NULL;
4239 }
4240 return int_info;
4241}
4242
Guido van Rossumddefaf32007-01-14 03:31:43 +00004243int
4244_PyLong_Init(void)
4245{
4246#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004247 int ival, size;
Guido van Rossumddefaf32007-01-14 03:31:43 +00004248 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004249
4250 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
4251 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
4252 if (Py_TYPE(v) == &PyLong_Type) {
4253 /* The element is already initialized, most likely
4254 * the Python interpreter was initialized before.
4255 */
Christian Heimes48aa4b12008-02-01 16:56:30 +00004256 Py_ssize_t refcnt;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004257 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004258
Christian Heimes48aa4b12008-02-01 16:56:30 +00004259 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
4260 _Py_NewReference(op);
4261 /* _Py_NewReference sets the ref count to 1 but
4262 * the ref count might be larger. Set the refcnt
4263 * to the original refcnt + 1 */
4264 Py_REFCNT(op) = refcnt + 1;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004265 assert(Py_SIZE(op) == size);
4266 assert(v->ob_digit[0] == abs(ival));
4267 }
4268 else {
4269 PyObject_INIT(v, &PyLong_Type);
4270 }
4271 Py_SIZE(v) = size;
4272 v->ob_digit[0] = abs(ival);
Guido van Rossumddefaf32007-01-14 03:31:43 +00004273 }
4274#endif
Mark Dickinsonbd792642009-03-18 20:06:12 +00004275 /* initialize int_info */
4276 if (Int_InfoType.tp_name == 0)
4277 PyStructSequence_InitType(&Int_InfoType, &int_info_desc);
4278
Guido van Rossumddefaf32007-01-14 03:31:43 +00004279 return 1;
4280}
4281
4282void
4283PyLong_Fini(void)
4284{
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004285 /* Integers are currently statically allocated. Py_DECREF is not
4286 needed, but Python must forget about the reference or multiple
4287 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00004288#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004289 int i;
4290 PyLongObject *v = small_ints;
4291 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
4292 _Py_DEC_REFTOTAL;
4293 _Py_ForgetReference((PyObject*)v);
4294 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004295#endif
4296}