annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/python3.8/longintrepr.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 #ifndef Py_LIMITED_API
jpayne@69 2 #ifndef Py_LONGINTREPR_H
jpayne@69 3 #define Py_LONGINTREPR_H
jpayne@69 4 #ifdef __cplusplus
jpayne@69 5 extern "C" {
jpayne@69 6 #endif
jpayne@69 7
jpayne@69 8
jpayne@69 9 /* This is published for the benefit of "friends" marshal.c and _decimal.c. */
jpayne@69 10
jpayne@69 11 /* Parameters of the integer representation. There are two different
jpayne@69 12 sets of parameters: one set for 30-bit digits, stored in an unsigned 32-bit
jpayne@69 13 integer type, and one set for 15-bit digits with each digit stored in an
jpayne@69 14 unsigned short. The value of PYLONG_BITS_IN_DIGIT, defined either at
jpayne@69 15 configure time or in pyport.h, is used to decide which digit size to use.
jpayne@69 16
jpayne@69 17 Type 'digit' should be able to hold 2*PyLong_BASE-1, and type 'twodigits'
jpayne@69 18 should be an unsigned integer type able to hold all integers up to
jpayne@69 19 PyLong_BASE*PyLong_BASE-1. x_sub assumes that 'digit' is an unsigned type,
jpayne@69 20 and that overflow is handled by taking the result modulo 2**N for some N >
jpayne@69 21 PyLong_SHIFT. The majority of the code doesn't care about the precise
jpayne@69 22 value of PyLong_SHIFT, but there are some notable exceptions:
jpayne@69 23
jpayne@69 24 - long_pow() requires that PyLong_SHIFT be divisible by 5
jpayne@69 25
jpayne@69 26 - PyLong_{As,From}ByteArray require that PyLong_SHIFT be at least 8
jpayne@69 27
jpayne@69 28 - long_hash() requires that PyLong_SHIFT is *strictly* less than the number
jpayne@69 29 of bits in an unsigned long, as do the PyLong <-> long (or unsigned long)
jpayne@69 30 conversion functions
jpayne@69 31
jpayne@69 32 - the Python int <-> size_t/Py_ssize_t conversion functions expect that
jpayne@69 33 PyLong_SHIFT is strictly less than the number of bits in a size_t
jpayne@69 34
jpayne@69 35 - the marshal code currently expects that PyLong_SHIFT is a multiple of 15
jpayne@69 36
jpayne@69 37 - NSMALLNEGINTS and NSMALLPOSINTS should be small enough to fit in a single
jpayne@69 38 digit; with the current values this forces PyLong_SHIFT >= 9
jpayne@69 39
jpayne@69 40 The values 15 and 30 should fit all of the above requirements, on any
jpayne@69 41 platform.
jpayne@69 42 */
jpayne@69 43
jpayne@69 44 #if PYLONG_BITS_IN_DIGIT == 30
jpayne@69 45 typedef uint32_t digit;
jpayne@69 46 typedef int32_t sdigit; /* signed variant of digit */
jpayne@69 47 typedef uint64_t twodigits;
jpayne@69 48 typedef int64_t stwodigits; /* signed variant of twodigits */
jpayne@69 49 #define PyLong_SHIFT 30
jpayne@69 50 #define _PyLong_DECIMAL_SHIFT 9 /* max(e such that 10**e fits in a digit) */
jpayne@69 51 #define _PyLong_DECIMAL_BASE ((digit)1000000000) /* 10 ** DECIMAL_SHIFT */
jpayne@69 52 #elif PYLONG_BITS_IN_DIGIT == 15
jpayne@69 53 typedef unsigned short digit;
jpayne@69 54 typedef short sdigit; /* signed variant of digit */
jpayne@69 55 typedef unsigned long twodigits;
jpayne@69 56 typedef long stwodigits; /* signed variant of twodigits */
jpayne@69 57 #define PyLong_SHIFT 15
jpayne@69 58 #define _PyLong_DECIMAL_SHIFT 4 /* max(e such that 10**e fits in a digit) */
jpayne@69 59 #define _PyLong_DECIMAL_BASE ((digit)10000) /* 10 ** DECIMAL_SHIFT */
jpayne@69 60 #else
jpayne@69 61 #error "PYLONG_BITS_IN_DIGIT should be 15 or 30"
jpayne@69 62 #endif
jpayne@69 63 #define PyLong_BASE ((digit)1 << PyLong_SHIFT)
jpayne@69 64 #define PyLong_MASK ((digit)(PyLong_BASE - 1))
jpayne@69 65
jpayne@69 66 #if PyLong_SHIFT % 5 != 0
jpayne@69 67 #error "longobject.c requires that PyLong_SHIFT be divisible by 5"
jpayne@69 68 #endif
jpayne@69 69
jpayne@69 70 /* Long integer representation.
jpayne@69 71 The absolute value of a number is equal to
jpayne@69 72 SUM(for i=0 through abs(ob_size)-1) ob_digit[i] * 2**(SHIFT*i)
jpayne@69 73 Negative numbers are represented with ob_size < 0;
jpayne@69 74 zero is represented by ob_size == 0.
jpayne@69 75 In a normalized number, ob_digit[abs(ob_size)-1] (the most significant
jpayne@69 76 digit) is never zero. Also, in all cases, for all valid i,
jpayne@69 77 0 <= ob_digit[i] <= MASK.
jpayne@69 78 The allocation function takes care of allocating extra memory
jpayne@69 79 so that ob_digit[0] ... ob_digit[abs(ob_size)-1] are actually available.
jpayne@69 80
jpayne@69 81 CAUTION: Generic code manipulating subtypes of PyVarObject has to
jpayne@69 82 aware that ints abuse ob_size's sign bit.
jpayne@69 83 */
jpayne@69 84
jpayne@69 85 struct _longobject {
jpayne@69 86 PyObject_VAR_HEAD
jpayne@69 87 digit ob_digit[1];
jpayne@69 88 };
jpayne@69 89
jpayne@69 90 PyAPI_FUNC(PyLongObject *) _PyLong_New(Py_ssize_t);
jpayne@69 91
jpayne@69 92 /* Return a copy of src. */
jpayne@69 93 PyAPI_FUNC(PyObject *) _PyLong_Copy(PyLongObject *src);
jpayne@69 94
jpayne@69 95 #ifdef __cplusplus
jpayne@69 96 }
jpayne@69 97 #endif
jpayne@69 98 #endif /* !Py_LONGINTREPR_H */
jpayne@69 99 #endif /* Py_LIMITED_API */