aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/tools/python3/src/Include/setobject.h
blob: d1f26f8e8a9abafcd8e0ac2dafac78924b6712d7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/* Set object interface */ 
 
#ifndef Py_SETOBJECT_H 
#define Py_SETOBJECT_H 
#ifdef __cplusplus 
extern "C" { 
#endif 
 
#ifndef Py_LIMITED_API 
 
/* There are three kinds of entries in the table: 
 
1. Unused:  key == NULL and hash == 0 
2. Dummy:   key == dummy and hash == -1 
3. Active:  key != NULL and key != dummy and hash != -1 
 
The hash field of Unused slots is always zero. 
 
The hash field of Dummy slots are set to -1 
meaning that dummy entries can be detected by 
either entry->key==dummy or by entry->hash==-1. 
*/ 
 
#define PySet_MINSIZE 8 
 
typedef struct { 
    PyObject *key; 
    Py_hash_t hash;             /* Cached hash code of the key */ 
} setentry; 
 
/* The SetObject data structure is shared by set and frozenset objects. 
 
Invariant for sets: 
 - hash is -1 
 
Invariants for frozensets: 
 - data is immutable. 
 - hash is the hash of the frozenset or -1 if not computed yet. 
 
*/ 
 
typedef struct { 
    PyObject_HEAD 
 
    Py_ssize_t fill;            /* Number active and dummy entries*/ 
    Py_ssize_t used;            /* Number active entries */ 
 
    /* The table contains mask + 1 slots, and that's a power of 2. 
     * We store the mask instead of the size because the mask is more 
     * frequently needed. 
     */ 
    Py_ssize_t mask; 
 
    /* The table points to a fixed-size smalltable for small tables 
     * or to additional malloc'ed memory for bigger tables. 
     * The table pointer is never NULL which saves us from repeated 
     * runtime null-tests. 
     */ 
    setentry *table; 
    Py_hash_t hash;             /* Only used by frozenset objects */ 
    Py_ssize_t finger;          /* Search finger for pop() */ 
 
    setentry smalltable[PySet_MINSIZE]; 
    PyObject *weakreflist;      /* List of weak references */ 
} PySetObject; 
 
#define PySet_GET_SIZE(so) (assert(PyAnySet_Check(so)),(((PySetObject *)(so))->used)) 
 
PyAPI_DATA(PyObject *) _PySet_Dummy; 
 
PyAPI_FUNC(int) _PySet_NextEntry(PyObject *set, Py_ssize_t *pos, PyObject **key, Py_hash_t *hash); 
PyAPI_FUNC(int) _PySet_Update(PyObject *set, PyObject *iterable); 
 
#endif /* Section excluded by Py_LIMITED_API */ 
 
PyAPI_DATA(PyTypeObject) PySet_Type; 
PyAPI_DATA(PyTypeObject) PyFrozenSet_Type; 
PyAPI_DATA(PyTypeObject) PySetIter_Type; 
 
PyAPI_FUNC(PyObject *) PySet_New(PyObject *); 
PyAPI_FUNC(PyObject *) PyFrozenSet_New(PyObject *); 
 
PyAPI_FUNC(int) PySet_Add(PyObject *set, PyObject *key); 
PyAPI_FUNC(int) PySet_Clear(PyObject *set); 
PyAPI_FUNC(int) PySet_Contains(PyObject *anyset, PyObject *key); 
PyAPI_FUNC(int) PySet_Discard(PyObject *set, PyObject *key); 
PyAPI_FUNC(PyObject *) PySet_Pop(PyObject *set); 
PyAPI_FUNC(Py_ssize_t) PySet_Size(PyObject *anyset); 
 
#define PyFrozenSet_CheckExact(ob) Py_IS_TYPE(ob, &PyFrozenSet_Type)
#define PyAnySet_CheckExact(ob) \ 
    (Py_IS_TYPE(ob, &PySet_Type) || Py_IS_TYPE(ob, &PyFrozenSet_Type))
#define PyAnySet_Check(ob) \ 
    (Py_IS_TYPE(ob, &PySet_Type) || Py_IS_TYPE(ob, &PyFrozenSet_Type) || \
      PyType_IsSubtype(Py_TYPE(ob), &PySet_Type) || \ 
      PyType_IsSubtype(Py_TYPE(ob), &PyFrozenSet_Type)) 
#define PySet_Check(ob) \ 
    (Py_IS_TYPE(ob, &PySet_Type) || \
    PyType_IsSubtype(Py_TYPE(ob), &PySet_Type)) 
#define   PyFrozenSet_Check(ob) \ 
    (Py_IS_TYPE(ob, &PyFrozenSet_Type) || \
      PyType_IsSubtype(Py_TYPE(ob), &PyFrozenSet_Type)) 
 
#ifdef __cplusplus 
} 
#endif 
#endif /* !Py_SETOBJECT_H */