← Back to branch summary

~ubuntu-branches/ubuntu/maverick/python3.1/maverick

« back to all changes in this revision

Viewing changes to Include/longintrepr.h

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2009-03-23 00:01:27 UTC
  • Revision ID: james.westby@ubuntu.com-20090323000127-5fstfxju4ufrhthq
Tags: upstream-3.1~a1+20090322
Import upstream version 3.1~a1+20090322

Show diffs side-by-side

added added

removed removed

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