blob: 254076e4d4dc5d8b3ee2d159a6bbca36827ad47c [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_LONGINTREPR_H
2#define Py_LONGINTREPR_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumedcc38a1991-05-05 20:09:44 +00007
Guido van Rossum3d095431992-01-19 16:30:12 +00008/* This is published for the benefit of "friend" marshal.c only. */
9
Guido van Rossumedcc38a1991-05-05 20:09:44 +000010/* Parameters of the long integer representation.
11 These shouldn't have to be changed as C should guarantee that a short
Tim Peters7d3a5112000-07-08 04:17:21 +000012 contains at least 16 bits, but it's made changeable anyway.
Guido van Rossumedcc38a1991-05-05 20:09:44 +000013 Note: 'digit' should be able to hold 2*MASK+1, and 'twodigits'
14 should be able to hold the intermediate results in 'mul'
Tim Peters0973b992004-08-29 22:16:50 +000015 (at most (BASE-1)*(2*BASE+1) == MASK*(2*MASK+3)).
Guido van Rossumedcc38a1991-05-05 20:09:44 +000016 Also, x_sub assumes that 'digit' is an unsigned type, and overflow
17 is handled by taking the result mod 2**N for some N > SHIFT.
Tim Peters47e52ee2004-08-30 02:44:38 +000018 And, at some places it is assumed that MASK fits in an int, as well.
19 long_pow() requires that SHIFT be divisible by 5. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +000020
21typedef unsigned short digit;
Guido van Rossumbadb1161991-05-14 12:06:16 +000022typedef unsigned int wdigit; /* digit widened to parameter size */
Tim Peters7d3a5112000-07-08 04:17:21 +000023#define BASE_TWODIGITS_TYPE long
24typedef unsigned BASE_TWODIGITS_TYPE twodigits;
25typedef BASE_TWODIGITS_TYPE stwodigits; /* signed variant of twodigits */
Guido van Rossumedcc38a1991-05-05 20:09:44 +000026
27#define SHIFT 15
28#define BASE ((digit)1 << SHIFT)
29#define MASK ((int)(BASE - 1))
30
Tim Peters47e52ee2004-08-30 02:44:38 +000031#if SHIFT % 5 != 0
32#error "longobject.c requires that SHIFT be divisible by 5"
33#endif
34
Guido van Rossumedcc38a1991-05-05 20:09:44 +000035/* Long integer representation.
36 The absolute value of a number is equal to
37 SUM(for i=0 through abs(ob_size)-1) ob_digit[i] * 2**(SHIFT*i)
38 Negative numbers are represented with ob_size < 0;
39 zero is represented by ob_size == 0.
40 In a normalized number, ob_digit[abs(ob_size)-1] (the most significant
41 digit) is never zero. Also, in all cases, for all valid i,
42 0 <= ob_digit[i] <= MASK.
Thomas Wouters7e474022000-07-16 12:04:32 +000043 The allocation function takes care of allocating extra memory
Tim Peters03b18832002-03-02 04:33:09 +000044 so that ob_digit[0] ... ob_digit[abs(ob_size)-1] are actually available.
45
46 CAUTION: Generic code manipulating subtypes of PyVarObject has to
47 aware that longs abuse ob_size's sign bit.
48*/
Guido van Rossumedcc38a1991-05-05 20:09:44 +000049
Guido van Rossum3d095431992-01-19 16:30:12 +000050struct _longobject {
Tim Peters03b18832002-03-02 04:33:09 +000051 PyObject_VAR_HEAD
Guido van Rossumedcc38a1991-05-05 20:09:44 +000052 digit ob_digit[1];
Guido van Rossum3d095431992-01-19 16:30:12 +000053};
Guido van Rossumedcc38a1991-05-05 20:09:44 +000054
Mark Hammond91a681d2002-08-12 07:21:58 +000055PyAPI_FUNC(PyLongObject *) _PyLong_New(int);
Guido van Rossuma3309961993-07-28 09:05:47 +000056
Tim Peters64b5ce32001-09-10 20:52:51 +000057/* Return a copy of src. */
Mark Hammond91a681d2002-08-12 07:21:58 +000058PyAPI_FUNC(PyObject *) _PyLong_Copy(PyLongObject *src);
Tim Peters64b5ce32001-09-10 20:52:51 +000059
Guido van Rossuma3309961993-07-28 09:05:47 +000060#ifdef __cplusplus
61}
62#endif
63#endif /* !Py_LONGINTREPR_H */