blob: 39465f32860930ceda7e16283b5142022fadcbdb [file] [log] [blame]
Raymond Hettingerc991db22005-08-11 07:58:45 +00001
Raymond Hettingera9d99362005-08-05 00:01:15 +00002/* set object implementation
3 Written and maintained by Raymond D. Hettinger <python@rcn.com>
4 Derived from Lib/sets.py and Objects/dictobject.c.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00005
Martin v. Löwis68192102007-07-21 06:55:02 +00006 Copyright (c) 2003-2007 Python Software Foundation.
Raymond Hettingera9d99362005-08-05 00:01:15 +00007 All rights reserved.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00008*/
9
Raymond Hettingera690a992003-11-16 16:17:49 +000010#include "Python.h"
Raymond Hettingera9d99362005-08-05 00:01:15 +000011#include "structmember.h"
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000012
Raymond Hettinger9c14ffb2006-12-08 04:57:50 +000013/* Set a key error with the specified argument, wrapping it in a
14 * tuple automatically so that tuple keys are not unpacked as the
15 * exception arguments. */
16static void
17set_key_error(PyObject *arg)
18{
19 PyObject *tup;
20 tup = PyTuple_Pack(1, arg);
21 if (!tup)
22 return; /* caller will expect error to be set anyway */
23 PyErr_SetObject(PyExc_KeyError, tup);
24 Py_DECREF(tup);
25}
26
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000027/* This must be >= 1. */
28#define PERTURB_SHIFT 5
29
30/* Object used as dummy key to fill deleted entries */
Raymond Hettingera9d99362005-08-05 00:01:15 +000031static PyObject *dummy = NULL; /* Initialized by first call to make_new_set() */
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000032
Armin Rigoe1709372006-04-12 17:06:05 +000033#ifdef Py_REF_DEBUG
34PyObject *
35_PySet_Dummy(void)
36{
37 return dummy;
38}
39#endif
40
Raymond Hettingerbc841a12005-08-07 13:02:53 +000041#define INIT_NONZERO_SET_SLOTS(so) do { \
42 (so)->table = (so)->smalltable; \
43 (so)->mask = PySet_MINSIZE - 1; \
44 (so)->hash = -1; \
45 } while(0)
46
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000047#define EMPTY_TO_MINSIZE(so) do { \
48 memset((so)->smalltable, 0, sizeof((so)->smalltable)); \
49 (so)->used = (so)->fill = 0; \
Raymond Hettingerbc841a12005-08-07 13:02:53 +000050 INIT_NONZERO_SET_SLOTS(so); \
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000051 } while(0)
52
Raymond Hettingerbc841a12005-08-07 13:02:53 +000053/* Reuse scheme to save calls to malloc, free, and memset */
Christian Heimes5b970ad2008-02-06 13:33:44 +000054#ifndef PySet_MAXFREELIST
55#define PySet_MAXFREELIST 80
56#endif
57static PySetObject *free_list[PySet_MAXFREELIST];
58static int numfree = 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000059
60/*
61The basic lookup function used by all operations.
62This is based on Algorithm D from Knuth Vol. 3, Sec. 6.4.
63Open addressing is preferred over chaining since the link overhead for
64chaining would be substantial (100% with typical malloc overhead).
65
66The initial probe index is computed as hash mod the table size. Subsequent
Raymond Hettingerbc841a12005-08-07 13:02:53 +000067probe indices are computed as explained in Objects/dictobject.c.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000068
69All arithmetic on hash should ignore overflow.
70
Raymond Hettinger9bda1d62005-09-16 07:14:21 +000071Unlike the dictionary implementation, the lookkey functions can return
72NULL if the rich comparison returns an error.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000073*/
74
75static setentry *
76set_lookkey(PySetObject *so, PyObject *key, register long hash)
77{
Martin v. Löwis18e16552006-02-15 17:27:45 +000078 register Py_ssize_t i;
79 register size_t perturb;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000080 register setentry *freeslot;
Neal Norwitz0f2783c2006-06-19 05:40:44 +000081 register size_t mask = so->mask;
Raymond Hettingera580c472005-08-05 17:19:54 +000082 setentry *table = so->table;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +000083 register setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000084 register int cmp;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000085 PyObject *startkey;
86
87 i = hash & mask;
Raymond Hettingera580c472005-08-05 17:19:54 +000088 entry = &table[i];
Raymond Hettinger06d8cf82005-07-31 15:36:06 +000089 if (entry->key == NULL || entry->key == key)
90 return entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000091
Raymond Hettinger06d8cf82005-07-31 15:36:06 +000092 if (entry->key == dummy)
93 freeslot = entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000094 else {
Raymond Hettinger06d8cf82005-07-31 15:36:06 +000095 if (entry->hash == hash) {
Raymond Hettinger06d8cf82005-07-31 15:36:06 +000096 startkey = entry->key;
Raymond Hettingerd99bee72008-05-30 06:49:47 +000097 Py_INCREF(startkey);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +000098 cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
Raymond Hettingerd99bee72008-05-30 06:49:47 +000099 Py_DECREF(startkey);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000100 if (cmp < 0)
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000101 return NULL;
Raymond Hettingera580c472005-08-05 17:19:54 +0000102 if (table == so->table && entry->key == startkey) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000103 if (cmp > 0)
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000104 return entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000105 }
106 else {
107 /* The compare did major nasty stuff to the
108 * set: start over.
109 */
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000110 return set_lookkey(so, key, hash);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000111 }
112 }
113 freeslot = NULL;
114 }
115
116 /* In the loop, key == dummy is by far (factor of 100s) the
117 least likely outcome, so test for that last. */
118 for (perturb = hash; ; perturb >>= PERTURB_SHIFT) {
119 i = (i << 2) + i + perturb + 1;
Raymond Hettingera580c472005-08-05 17:19:54 +0000120 entry = &table[i & mask];
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000121 if (entry->key == NULL) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000122 if (freeslot != NULL)
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000123 entry = freeslot;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000124 break;
125 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000126 if (entry->key == key)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000127 break;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000128 if (entry->hash == hash && entry->key != dummy) {
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000129 startkey = entry->key;
Raymond Hettingerd99bee72008-05-30 06:49:47 +0000130 Py_INCREF(startkey);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000131 cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
Raymond Hettingerd99bee72008-05-30 06:49:47 +0000132 Py_DECREF(startkey);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000133 if (cmp < 0)
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000134 return NULL;
Raymond Hettingera580c472005-08-05 17:19:54 +0000135 if (table == so->table && entry->key == startkey) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000136 if (cmp > 0)
137 break;
138 }
139 else {
140 /* The compare did major nasty stuff to the
141 * set: start over.
142 */
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000143 return set_lookkey(so, key, hash);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000144 }
145 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000146 else if (entry->key == dummy && freeslot == NULL)
147 freeslot = entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000148 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000149 return entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000150}
151
152/*
153 * Hacked up version of set_lookkey which can assume keys are always strings;
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000154 * This means we can always use _PyString_Eq directly and not have to check to
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000155 * see if the comparison altered the table.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000156 */
157static setentry *
158set_lookkey_string(PySetObject *so, PyObject *key, register long hash)
159{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000160 register Py_ssize_t i;
161 register size_t perturb;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000162 register setentry *freeslot;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000163 register size_t mask = so->mask;
Raymond Hettingera580c472005-08-05 17:19:54 +0000164 setentry *table = so->table;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000165 register setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000166
167 /* Make sure this function doesn't have to handle non-string keys,
168 including subclasses of str; e.g., one reason to subclass
169 strings is to override __eq__, and for speed we don't cater to
170 that here. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000171 if (!PyString_CheckExact(key)) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000172 so->lookup = set_lookkey;
173 return set_lookkey(so, key, hash);
174 }
175 i = hash & mask;
Raymond Hettingera580c472005-08-05 17:19:54 +0000176 entry = &table[i];
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000177 if (entry->key == NULL || entry->key == key)
178 return entry;
Raymond Hettingered6c1ef2005-08-13 08:28:03 +0000179 if (entry->key == dummy)
180 freeslot = entry;
181 else {
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000182 if (entry->hash == hash && _PyString_Eq(entry->key, key))
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000183 return entry;
Raymond Hettingered6c1ef2005-08-13 08:28:03 +0000184 freeslot = NULL;
185 }
186
187 /* In the loop, key == dummy is by far (factor of 100s) the
188 least likely outcome, so test for that last. */
189 for (perturb = hash; ; perturb >>= PERTURB_SHIFT) {
190 i = (i << 2) + i + perturb + 1;
191 entry = &table[i & mask];
192 if (entry->key == NULL)
193 return freeslot == NULL ? entry : freeslot;
194 if (entry->key == key
195 || (entry->hash == hash
196 && entry->key != dummy
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000197 && _PyString_Eq(entry->key, key)))
Raymond Hettingered6c1ef2005-08-13 08:28:03 +0000198 return entry;
199 if (entry->key == dummy && freeslot == NULL)
200 freeslot = entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000201 }
Neal Norwitza5ccda92006-10-28 21:16:54 +0000202 assert(0); /* NOT REACHED */
203 return 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000204}
205
206/*
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000207Internal routine to insert a new key into the table.
Raymond Hettinger0c850862006-12-08 04:24:33 +0000208Used by the public insert routine.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000209Eats a reference to key.
210*/
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000211static int
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000212set_insert_key(register PySetObject *so, PyObject *key, long hash)
213{
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000214 register setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000215 typedef setentry *(*lookupfunc)(PySetObject *, PyObject *, long);
216
217 assert(so->lookup != NULL);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000218 entry = so->lookup(so, key, hash);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000219 if (entry == NULL)
220 return -1;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000221 if (entry->key == NULL) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000222 /* UNUSED */
223 so->fill++;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000224 entry->key = key;
225 entry->hash = hash;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000226 so->used++;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000227 } else if (entry->key == dummy) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000228 /* DUMMY */
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000229 entry->key = key;
230 entry->hash = hash;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000231 so->used++;
232 Py_DECREF(dummy);
233 } else {
234 /* ACTIVE */
235 Py_DECREF(key);
236 }
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000237 return 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000238}
239
240/*
Raymond Hettinger0c850862006-12-08 04:24:33 +0000241Internal routine used by set_table_resize() to insert an item which is
242known to be absent from the set. This routine also assumes that
243the set contains no deleted entries. Besides the performance benefit,
244using set_insert_clean() in set_table_resize() is dangerous (SF bug #1456209).
245Note that no refcounts are changed by this routine; if needed, the caller
246is responsible for incref'ing `key`.
247*/
248static void
249set_insert_clean(register PySetObject *so, PyObject *key, long hash)
250{
251 register size_t i;
252 register size_t perturb;
253 register size_t mask = (size_t)so->mask;
254 setentry *table = so->table;
255 register setentry *entry;
256
257 i = hash & mask;
258 entry = &table[i];
259 for (perturb = hash; entry->key != NULL; perturb >>= PERTURB_SHIFT) {
260 i = (i << 2) + i + perturb + 1;
261 entry = &table[i & mask];
262 }
263 so->fill++;
264 entry->key = key;
265 entry->hash = hash;
266 so->used++;
267}
268
269/*
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000270Restructure the table by allocating a new table and reinserting all
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000271keys again. When entries have been deleted, the new table may
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000272actually be smaller than the old one.
273*/
274static int
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000275set_table_resize(PySetObject *so, Py_ssize_t minused)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000276{
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000277 Py_ssize_t newsize;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000278 setentry *oldtable, *newtable, *entry;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000279 Py_ssize_t i;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000280 int is_oldtable_malloced;
281 setentry small_copy[PySet_MINSIZE];
282
283 assert(minused >= 0);
284
285 /* Find the smallest table size > minused. */
286 for (newsize = PySet_MINSIZE;
287 newsize <= minused && newsize > 0;
288 newsize <<= 1)
289 ;
290 if (newsize <= 0) {
291 PyErr_NoMemory();
292 return -1;
293 }
294
295 /* Get space for a new table. */
296 oldtable = so->table;
297 assert(oldtable != NULL);
298 is_oldtable_malloced = oldtable != so->smalltable;
299
300 if (newsize == PySet_MINSIZE) {
301 /* A large table is shrinking, or we can't get any smaller. */
302 newtable = so->smalltable;
303 if (newtable == oldtable) {
304 if (so->fill == so->used) {
305 /* No dummies, so no point doing anything. */
306 return 0;
307 }
308 /* We're not going to resize it, but rebuild the
309 table anyway to purge old dummy entries.
310 Subtle: This is *necessary* if fill==size,
311 as set_lookkey needs at least one virgin slot to
312 terminate failing searches. If fill < size, it's
313 merely desirable, as dummies slow searches. */
314 assert(so->fill > so->used);
315 memcpy(small_copy, oldtable, sizeof(small_copy));
316 oldtable = small_copy;
317 }
318 }
319 else {
320 newtable = PyMem_NEW(setentry, newsize);
321 if (newtable == NULL) {
322 PyErr_NoMemory();
323 return -1;
324 }
325 }
326
327 /* Make the set empty, using the new table. */
328 assert(newtable != oldtable);
329 so->table = newtable;
330 so->mask = newsize - 1;
331 memset(newtable, 0, sizeof(setentry) * newsize);
332 so->used = 0;
333 i = so->fill;
334 so->fill = 0;
335
336 /* Copy the data over; this is refcount-neutral for active entries;
337 dummy entries aren't copied over, of course */
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000338 for (entry = oldtable; i > 0; entry++) {
339 if (entry->key == NULL) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000340 /* UNUSED */
341 ;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000342 } else if (entry->key == dummy) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000343 /* DUMMY */
344 --i;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000345 assert(entry->key == dummy);
346 Py_DECREF(entry->key);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000347 } else {
348 /* ACTIVE */
349 --i;
Raymond Hettinger0c850862006-12-08 04:24:33 +0000350 set_insert_clean(so, entry->key, entry->hash);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000351 }
352 }
353
354 if (is_oldtable_malloced)
355 PyMem_DEL(oldtable);
356 return 0;
357}
358
Raymond Hettingerc991db22005-08-11 07:58:45 +0000359/* CAUTION: set_add_key/entry() must guarantee it won't resize the table */
360
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000361static int
Raymond Hettingerc991db22005-08-11 07:58:45 +0000362set_add_entry(register PySetObject *so, setentry *entry)
363{
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000364 register Py_ssize_t n_used;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000365
366 assert(so->fill <= so->mask); /* at least one empty slot */
367 n_used = so->used;
368 Py_INCREF(entry->key);
Raymond Hettingerc563a1c2006-09-07 02:42:48 +0000369 if (set_insert_key(so, entry->key, entry->hash) == -1) {
370 Py_DECREF(entry->key);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000371 return -1;
Raymond Hettingerc563a1c2006-09-07 02:42:48 +0000372 }
Raymond Hettingerc991db22005-08-11 07:58:45 +0000373 if (!(so->used > n_used && so->fill*3 >= (so->mask+1)*2))
374 return 0;
375 return set_table_resize(so, so->used>50000 ? so->used*2 : so->used*4);
376}
377
378static int
379set_add_key(register PySetObject *so, PyObject *key)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000380{
381 register long hash;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000382 register Py_ssize_t n_used;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000383
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000384 if (!PyString_CheckExact(key) ||
385 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000386 hash = PyObject_Hash(key);
387 if (hash == -1)
388 return -1;
389 }
390 assert(so->fill <= so->mask); /* at least one empty slot */
391 n_used = so->used;
392 Py_INCREF(key);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000393 if (set_insert_key(so, key, hash) == -1) {
394 Py_DECREF(key);
395 return -1;
396 }
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000397 if (!(so->used > n_used && so->fill*3 >= (so->mask+1)*2))
398 return 0;
Raymond Hettingerbc841a12005-08-07 13:02:53 +0000399 return set_table_resize(so, so->used>50000 ? so->used*2 : so->used*4);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000400}
401
402#define DISCARD_NOTFOUND 0
403#define DISCARD_FOUND 1
404
405static int
Raymond Hettingerc991db22005-08-11 07:58:45 +0000406set_discard_entry(PySetObject *so, setentry *oldentry)
407{ register setentry *entry;
408 PyObject *old_key;
409
410 entry = (so->lookup)(so, oldentry->key, oldentry->hash);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000411 if (entry == NULL)
412 return -1;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000413 if (entry->key == NULL || entry->key == dummy)
414 return DISCARD_NOTFOUND;
415 old_key = entry->key;
416 Py_INCREF(dummy);
417 entry->key = dummy;
418 so->used--;
419 Py_DECREF(old_key);
420 return DISCARD_FOUND;
421}
422
423static int
424set_discard_key(PySetObject *so, PyObject *key)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000425{
426 register long hash;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000427 register setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000428 PyObject *old_key;
429
430 assert (PyAnySet_Check(so));
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000431 if (!PyString_CheckExact(key) ||
432 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000433 hash = PyObject_Hash(key);
434 if (hash == -1)
435 return -1;
436 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000437 entry = (so->lookup)(so, key, hash);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000438 if (entry == NULL)
439 return -1;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000440 if (entry->key == NULL || entry->key == dummy)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000441 return DISCARD_NOTFOUND;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000442 old_key = entry->key;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000443 Py_INCREF(dummy);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000444 entry->key = dummy;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000445 so->used--;
446 Py_DECREF(old_key);
447 return DISCARD_FOUND;
448}
449
Raymond Hettingerfe889f32005-08-06 05:43:39 +0000450static int
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000451set_clear_internal(PySetObject *so)
452{
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000453 setentry *entry, *table;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000454 int table_is_malloced;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000455 Py_ssize_t fill;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000456 setentry small_copy[PySet_MINSIZE];
457#ifdef Py_DEBUG
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000458 Py_ssize_t i, n;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000459 assert (PyAnySet_Check(so));
Raymond Hettingera580c472005-08-05 17:19:54 +0000460
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000461 n = so->mask + 1;
462 i = 0;
463#endif
464
465 table = so->table;
466 assert(table != NULL);
467 table_is_malloced = table != so->smalltable;
468
469 /* This is delicate. During the process of clearing the set,
470 * decrefs can cause the set to mutate. To avoid fatal confusion
471 * (voice of experience), we have to make the set empty before
Raymond Hettingerfe889f32005-08-06 05:43:39 +0000472 * clearing the slots, and never refer to anything via so->ref while
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000473 * clearing.
474 */
475 fill = so->fill;
476 if (table_is_malloced)
477 EMPTY_TO_MINSIZE(so);
478
479 else if (fill > 0) {
480 /* It's a small table with something that needs to be cleared.
481 * Afraid the only safe way is to copy the set entries into
482 * another small table first.
483 */
484 memcpy(small_copy, table, sizeof(small_copy));
485 table = small_copy;
486 EMPTY_TO_MINSIZE(so);
487 }
488 /* else it's a small table that's already empty */
489
490 /* Now we can finally clear things. If C had refcounts, we could
491 * assert that the refcount on table is 1 now, i.e. that this function
492 * has unique access to it, so decref side-effects can't alter it.
493 */
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000494 for (entry = table; fill > 0; ++entry) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000495#ifdef Py_DEBUG
496 assert(i < n);
497 ++i;
498#endif
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000499 if (entry->key) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000500 --fill;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000501 Py_DECREF(entry->key);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000502 }
503#ifdef Py_DEBUG
504 else
Raymond Hettinger334b5b22006-03-26 03:11:29 +0000505 assert(entry->key == NULL);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000506#endif
507 }
508
509 if (table_is_malloced)
510 PyMem_DEL(table);
Raymond Hettingerfe889f32005-08-06 05:43:39 +0000511 return 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000512}
513
514/*
515 * Iterate over a set table. Use like so:
516 *
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000517 * Py_ssize_t pos;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000518 * setentry *entry;
Raymond Hettingerd7946662005-08-01 21:39:29 +0000519 * pos = 0; # important! pos should not otherwise be changed by you
Raymond Hettingerc991db22005-08-11 07:58:45 +0000520 * while (set_next(yourset, &pos, &entry)) {
521 * Refer to borrowed reference in entry->key.
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000522 * }
523 *
Raymond Hettingerc991db22005-08-11 07:58:45 +0000524 * CAUTION: In general, it isn't safe to use set_next in a loop that
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000525 * mutates the table.
526 */
527static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000528set_next(PySetObject *so, Py_ssize_t *pos_ptr, setentry **entry_ptr)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000529{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000530 Py_ssize_t i;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000531 Py_ssize_t mask;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000532 register setentry *table;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000533
534 assert (PyAnySet_Check(so));
Raymond Hettingerc991db22005-08-11 07:58:45 +0000535 i = *pos_ptr;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000536 assert(i >= 0);
Raymond Hettingerc991db22005-08-11 07:58:45 +0000537 table = so->table;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000538 mask = so->mask;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000539 while (i <= mask && (table[i].key == NULL || table[i].key == dummy))
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000540 i++;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000541 *pos_ptr = i+1;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000542 if (i > mask)
543 return 0;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000544 assert(table[i].key != NULL);
545 *entry_ptr = &table[i];
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000546 return 1;
547}
548
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000549static void
550set_dealloc(PySetObject *so)
551{
552 register setentry *entry;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000553 Py_ssize_t fill = so->fill;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000554 PyObject_GC_UnTrack(so);
555 Py_TRASHCAN_SAFE_BEGIN(so)
556 if (so->weakreflist != NULL)
557 PyObject_ClearWeakRefs((PyObject *) so);
558
559 for (entry = so->table; fill > 0; entry++) {
560 if (entry->key) {
561 --fill;
562 Py_DECREF(entry->key);
563 }
564 }
565 if (so->table != so->smalltable)
566 PyMem_DEL(so->table);
Christian Heimes5b970ad2008-02-06 13:33:44 +0000567 if (numfree < PySet_MAXFREELIST && PyAnySet_CheckExact(so))
568 free_list[numfree++] = so;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000569 else
Christian Heimese93237d2007-12-19 02:37:44 +0000570 Py_TYPE(so)->tp_free(so);
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000571 Py_TRASHCAN_SAFE_END(so)
572}
573
574static int
575set_tp_print(PySetObject *so, FILE *fp, int flags)
576{
577 setentry *entry;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000578 Py_ssize_t pos=0;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000579 char *emit = ""; /* No separator emitted on first pass */
580 char *separator = ", ";
Raymond Hettinger53999102006-12-30 04:01:17 +0000581 int status = Py_ReprEnter((PyObject*)so);
582
583 if (status != 0) {
584 if (status < 0)
585 return status;
Brett Cannon01531592007-09-17 03:28:34 +0000586 Py_BEGIN_ALLOW_THREADS
Raymond Hettinger53999102006-12-30 04:01:17 +0000587 fprintf(fp, "%s(...)", so->ob_type->tp_name);
Brett Cannon01531592007-09-17 03:28:34 +0000588 Py_END_ALLOW_THREADS
Raymond Hettinger53999102006-12-30 04:01:17 +0000589 return 0;
590 }
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000591
Brett Cannon01531592007-09-17 03:28:34 +0000592 Py_BEGIN_ALLOW_THREADS
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000593 fprintf(fp, "%s([", so->ob_type->tp_name);
Brett Cannon01531592007-09-17 03:28:34 +0000594 Py_END_ALLOW_THREADS
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000595 while (set_next(so, &pos, &entry)) {
Brett Cannon01531592007-09-17 03:28:34 +0000596 Py_BEGIN_ALLOW_THREADS
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000597 fputs(emit, fp);
Brett Cannon01531592007-09-17 03:28:34 +0000598 Py_END_ALLOW_THREADS
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000599 emit = separator;
Raymond Hettinger53999102006-12-30 04:01:17 +0000600 if (PyObject_Print(entry->key, fp, 0) != 0) {
601 Py_ReprLeave((PyObject*)so);
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000602 return -1;
Raymond Hettinger53999102006-12-30 04:01:17 +0000603 }
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000604 }
Brett Cannon01531592007-09-17 03:28:34 +0000605 Py_BEGIN_ALLOW_THREADS
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000606 fputs("])", fp);
Brett Cannon01531592007-09-17 03:28:34 +0000607 Py_END_ALLOW_THREADS
Raymond Hettinger53999102006-12-30 04:01:17 +0000608 Py_ReprLeave((PyObject*)so);
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000609 return 0;
610}
611
612static PyObject *
613set_repr(PySetObject *so)
614{
Raymond Hettinger53999102006-12-30 04:01:17 +0000615 PyObject *keys, *result=NULL, *listrepr;
616 int status = Py_ReprEnter((PyObject*)so);
617
618 if (status != 0) {
619 if (status < 0)
620 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000621 return PyString_FromFormat("%s(...)", so->ob_type->tp_name);
Raymond Hettinger53999102006-12-30 04:01:17 +0000622 }
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000623
624 keys = PySequence_List((PyObject *)so);
625 if (keys == NULL)
Raymond Hettinger53999102006-12-30 04:01:17 +0000626 goto done;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000627 listrepr = PyObject_Repr(keys);
628 Py_DECREF(keys);
629 if (listrepr == NULL)
Raymond Hettinger53999102006-12-30 04:01:17 +0000630 goto done;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000631
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000632 result = PyString_FromFormat("%s(%s)", so->ob_type->tp_name,
633 PyString_AS_STRING(listrepr));
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000634 Py_DECREF(listrepr);
Raymond Hettinger53999102006-12-30 04:01:17 +0000635done:
636 Py_ReprLeave((PyObject*)so);
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000637 return result;
638}
639
Martin v. Löwis18e16552006-02-15 17:27:45 +0000640static Py_ssize_t
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000641set_len(PyObject *so)
642{
643 return ((PySetObject *)so)->used;
644}
645
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000646static int
Raymond Hettingerc991db22005-08-11 07:58:45 +0000647set_merge(PySetObject *so, PyObject *otherset)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000648{
Raymond Hettingerd7946662005-08-01 21:39:29 +0000649 PySetObject *other;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000650 register Py_ssize_t i;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000651 register setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000652
653 assert (PyAnySet_Check(so));
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000654 assert (PyAnySet_Check(otherset));
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000655
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000656 other = (PySetObject*)otherset;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000657 if (other == so || other->used == 0)
658 /* a.update(a) or a.update({}); nothing to do */
659 return 0;
660 /* Do one big resize at the start, rather than
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000661 * incrementally resizing as we insert new keys. Expect
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000662 * that there will be no (or few) overlapping keys.
663 */
664 if ((so->fill + other->used)*3 >= (so->mask+1)*2) {
665 if (set_table_resize(so, (so->used + other->used)*2) != 0)
666 return -1;
667 }
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000668 for (i = 0; i <= other->mask; i++) {
669 entry = &other->table[i];
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000670 if (entry->key != NULL &&
671 entry->key != dummy) {
672 Py_INCREF(entry->key);
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000673 if (set_insert_key(so, entry->key, entry->hash) == -1) {
674 Py_DECREF(entry->key);
675 return -1;
676 }
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000677 }
678 }
679 return 0;
680}
681
682static int
Raymond Hettingerc991db22005-08-11 07:58:45 +0000683set_contains_key(PySetObject *so, PyObject *key)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000684{
685 long hash;
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000686 setentry *entry;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000687
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000688 if (!PyString_CheckExact(key) ||
689 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000690 hash = PyObject_Hash(key);
691 if (hash == -1)
692 return -1;
693 }
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000694 entry = (so->lookup)(so, key, hash);
695 if (entry == NULL)
696 return -1;
697 key = entry->key;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000698 return key != NULL && key != dummy;
699}
700
Raymond Hettingerc991db22005-08-11 07:58:45 +0000701static int
702set_contains_entry(PySetObject *so, setentry *entry)
703{
704 PyObject *key;
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000705 setentry *lu_entry;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000706
Raymond Hettinger9bda1d62005-09-16 07:14:21 +0000707 lu_entry = (so->lookup)(so, entry->key, entry->hash);
708 if (lu_entry == NULL)
709 return -1;
710 key = lu_entry->key;
Raymond Hettingerc991db22005-08-11 07:58:45 +0000711 return key != NULL && key != dummy;
712}
713
Raymond Hettingerce8185e2005-08-13 09:28:48 +0000714static PyObject *
715set_pop(PySetObject *so)
716{
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000717 register Py_ssize_t i = 0;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000718 register setentry *entry;
719 PyObject *key;
Raymond Hettingerce8185e2005-08-13 09:28:48 +0000720
721 assert (PyAnySet_Check(so));
722 if (so->used == 0) {
723 PyErr_SetString(PyExc_KeyError, "pop from an empty set");
724 return NULL;
725 }
726
727 /* Set entry to "the first" unused or dummy set entry. We abuse
728 * the hash field of slot 0 to hold a search finger:
729 * If slot 0 has a value, use slot 0.
730 * Else slot 0 is being used to hold a search finger,
731 * and we use its hash value as the first index to look.
732 */
733 entry = &so->table[0];
734 if (entry->key == NULL || entry->key == dummy) {
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000735 i = entry->hash;
Raymond Hettingerce8185e2005-08-13 09:28:48 +0000736 /* The hash field may be a real hash value, or it may be a
737 * legit search finger, or it may be a once-legit search
738 * finger that's out of bounds now because it wrapped around
739 * or the table shrunk -- simply make sure it's in bounds now.
740 */
741 if (i > so->mask || i < 1)
742 i = 1; /* skip slot 0 */
743 while ((entry = &so->table[i])->key == NULL || entry->key==dummy) {
744 i++;
745 if (i > so->mask)
746 i = 1;
747 }
748 }
749 key = entry->key;
750 Py_INCREF(dummy);
751 entry->key = dummy;
752 so->used--;
753 so->table[0].hash = i + 1; /* next place to start */
754 return key;
755}
756
757PyDoc_STRVAR(pop_doc, "Remove and return an arbitrary set element.");
758
759static int
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000760set_traverse(PySetObject *so, visitproc visit, void *arg)
Raymond Hettingerce8185e2005-08-13 09:28:48 +0000761{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000762 Py_ssize_t pos = 0;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000763 setentry *entry;
764
765 while (set_next(so, &pos, &entry))
766 Py_VISIT(entry->key);
767 return 0;
768}
769
770static long
771frozenset_hash(PyObject *self)
772{
773 PySetObject *so = (PySetObject *)self;
774 long h, hash = 1927868237L;
775 setentry *entry;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000776 Py_ssize_t pos = 0;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000777
778 if (so->hash != -1)
779 return so->hash;
780
781 hash *= PySet_GET_SIZE(self) + 1;
782 while (set_next(so, &pos, &entry)) {
783 /* Work to increase the bit dispersion for closely spaced hash
784 values. The is important because some use cases have many
785 combinations of a small number of elements with nearby
786 hashes so that many distinct combinations collapse to only
787 a handful of distinct hash values. */
788 h = entry->hash;
789 hash ^= (h ^ (h << 16) ^ 89869747L) * 3644798167u;
790 }
791 hash = hash * 69069L + 907133923L;
792 if (hash == -1)
793 hash = 590923713L;
794 so->hash = hash;
795 return hash;
796}
797
Raymond Hettingera9d99362005-08-05 00:01:15 +0000798/***** Set iterator type ***********************************************/
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000799
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000800typedef struct {
801 PyObject_HEAD
802 PySetObject *si_set; /* Set to NULL when iterator is exhausted */
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000803 Py_ssize_t si_used;
804 Py_ssize_t si_pos;
805 Py_ssize_t len;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000806} setiterobject;
807
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000808static void
809setiter_dealloc(setiterobject *si)
810{
811 Py_XDECREF(si->si_set);
812 PyObject_Del(si);
813}
814
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000815static PyObject *
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000816setiter_len(setiterobject *si)
817{
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000818 Py_ssize_t len = 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000819 if (si->si_set != NULL && si->si_used == si->si_set->used)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000820 len = si->len;
821 return PyInt_FromLong(len);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000822}
823
Armin Rigof5b3e362006-02-11 21:32:43 +0000824PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000825
826static PyMethodDef setiter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +0000827 {"__length_hint__", (PyCFunction)setiter_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000828 {NULL, NULL} /* sentinel */
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000829};
830
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000831static PyObject *setiter_iternext(setiterobject *si)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000832{
833 PyObject *key;
Neal Norwitz0f2783c2006-06-19 05:40:44 +0000834 register Py_ssize_t i, mask;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000835 register setentry *entry;
836 PySetObject *so = si->si_set;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000837
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000838 if (so == NULL)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000839 return NULL;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000840 assert (PyAnySet_Check(so));
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000841
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000842 if (si->si_used != so->used) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000843 PyErr_SetString(PyExc_RuntimeError,
844 "Set changed size during iteration");
845 si->si_used = -1; /* Make this state sticky */
846 return NULL;
847 }
848
849 i = si->si_pos;
Raymond Hettingerf408ddf2005-08-17 00:27:42 +0000850 assert(i>=0);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000851 entry = so->table;
852 mask = so->mask;
853 while (i <= mask && (entry[i].key == NULL || entry[i].key == dummy))
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000854 i++;
855 si->si_pos = i+1;
856 if (i > mask)
857 goto fail;
858 si->len--;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000859 key = entry[i].key;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000860 Py_INCREF(key);
861 return key;
862
863fail:
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000864 Py_DECREF(so);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000865 si->si_set = NULL;
866 return NULL;
867}
868
Hye-Shik Change2956762005-08-01 05:26:41 +0000869static PyTypeObject PySetIter_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000870 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000871 "setiterator", /* tp_name */
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000872 sizeof(setiterobject), /* tp_basicsize */
873 0, /* tp_itemsize */
874 /* methods */
875 (destructor)setiter_dealloc, /* tp_dealloc */
876 0, /* tp_print */
877 0, /* tp_getattr */
878 0, /* tp_setattr */
879 0, /* tp_compare */
880 0, /* tp_repr */
881 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000882 0, /* tp_as_sequence */
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000883 0, /* tp_as_mapping */
884 0, /* tp_hash */
885 0, /* tp_call */
886 0, /* tp_str */
887 PyObject_GenericGetAttr, /* tp_getattro */
888 0, /* tp_setattro */
889 0, /* tp_as_buffer */
890 Py_TPFLAGS_DEFAULT, /* tp_flags */
891 0, /* tp_doc */
892 0, /* tp_traverse */
893 0, /* tp_clear */
894 0, /* tp_richcompare */
895 0, /* tp_weaklistoffset */
896 PyObject_SelfIter, /* tp_iter */
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000897 (iternextfunc)setiter_iternext, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000898 setiter_methods, /* tp_methods */
899 0,
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000900};
901
Martin v. Löwis72d20672006-04-11 09:04:12 +0000902static PyObject *
903set_iter(PySetObject *so)
904{
905 setiterobject *si = PyObject_New(setiterobject, &PySetIter_Type);
906 if (si == NULL)
907 return NULL;
908 Py_INCREF(so);
909 si->si_set = so;
910 si->si_used = so->used;
911 si->si_pos = 0;
912 si->len = so->used;
913 return (PyObject *)si;
914}
915
Raymond Hettingerd7946662005-08-01 21:39:29 +0000916static int
Raymond Hettingerd7946662005-08-01 21:39:29 +0000917set_update_internal(PySetObject *so, PyObject *other)
Raymond Hettingera690a992003-11-16 16:17:49 +0000918{
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000919 PyObject *key, *it;
Raymond Hettingera690a992003-11-16 16:17:49 +0000920
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +0000921 if (PyAnySet_Check(other))
Raymond Hettingerc991db22005-08-11 07:58:45 +0000922 return set_merge(so, other);
Raymond Hettingera690a992003-11-16 16:17:49 +0000923
Raymond Hettingerdb67aef2007-02-01 21:02:59 +0000924 if (PyDict_CheckExact(other)) {
Neal Norwitz0c6e2f12006-01-08 06:13:44 +0000925 PyObject *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000926 Py_ssize_t pos = 0;
Raymond Hettingerd6fc72a2007-02-19 02:03:19 +0000927 long hash;
Raymond Hettinger15cade02007-02-19 20:44:04 +0000928 Py_ssize_t dictsize = PyDict_Size(other);
Raymond Hettingerd6fc72a2007-02-19 02:03:19 +0000929
Raymond Hettinger15cade02007-02-19 20:44:04 +0000930 /* Do one big resize at the start, rather than
931 * incrementally resizing as we insert new keys. Expect
932 * that there will be no (or few) overlapping keys.
933 */
934 if (dictsize == -1)
935 return -1;
936 if ((so->fill + dictsize)*3 >= (so->mask+1)*2) {
937 if (set_table_resize(so, (so->used + dictsize)*2) != 0)
938 return -1;
939 }
Raymond Hettingerd6fc72a2007-02-19 02:03:19 +0000940 while (_PyDict_Next(other, &pos, &key, &value, &hash)) {
941 setentry an_entry;
942
943 an_entry.hash = hash;
944 an_entry.key = key;
945 if (set_add_entry(so, &an_entry) == -1)
Raymond Hettingerd7946662005-08-01 21:39:29 +0000946 return -1;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000947 }
Raymond Hettingerd7946662005-08-01 21:39:29 +0000948 return 0;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000949 }
950
Raymond Hettingera38123e2003-11-24 22:18:49 +0000951 it = PyObject_GetIter(other);
952 if (it == NULL)
Raymond Hettingerd7946662005-08-01 21:39:29 +0000953 return -1;
Raymond Hettingera690a992003-11-16 16:17:49 +0000954
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000955 while ((key = PyIter_Next(it)) != NULL) {
Raymond Hettingerc991db22005-08-11 07:58:45 +0000956 if (set_add_key(so, key) == -1) {
Raymond Hettingera38123e2003-11-24 22:18:49 +0000957 Py_DECREF(it);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000958 Py_DECREF(key);
Raymond Hettingerd7946662005-08-01 21:39:29 +0000959 return -1;
Raymond Hettingera690a992003-11-16 16:17:49 +0000960 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +0000961 Py_DECREF(key);
Raymond Hettingera690a992003-11-16 16:17:49 +0000962 }
Raymond Hettingera38123e2003-11-24 22:18:49 +0000963 Py_DECREF(it);
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +0000964 if (PyErr_Occurred())
Raymond Hettingerd7946662005-08-01 21:39:29 +0000965 return -1;
966 return 0;
967}
968
969static PyObject *
Raymond Hettingeree4bcad2008-06-09 08:33:37 +0000970set_update(PySetObject *so, PyObject *args)
Raymond Hettingerd7946662005-08-01 21:39:29 +0000971{
Raymond Hettingeree4bcad2008-06-09 08:33:37 +0000972 Py_ssize_t i;
973
974 for (i=0 ; i<PyTuple_GET_SIZE(args) ; i++) {
975 PyObject *other = PyTuple_GET_ITEM(args, i);
976 if (set_update_internal(so, other) == -1)
977 return NULL;
978 }
Raymond Hettingera38123e2003-11-24 22:18:49 +0000979 Py_RETURN_NONE;
980}
981
982PyDoc_STRVAR(update_doc,
Raymond Hettingeree4bcad2008-06-09 08:33:37 +0000983"Update a set with the union of itself and others.");
Raymond Hettingera38123e2003-11-24 22:18:49 +0000984
985static PyObject *
986make_new_set(PyTypeObject *type, PyObject *iterable)
987{
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000988 register PySetObject *so = NULL;
Raymond Hettingera38123e2003-11-24 22:18:49 +0000989
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000990 if (dummy == NULL) { /* Auto-initialize dummy */
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000991 dummy = PyString_FromString("<dummy key>");
Raymond Hettinger9f1a6792005-07-31 01:16:36 +0000992 if (dummy == NULL)
993 return NULL;
994 }
Raymond Hettingera690a992003-11-16 16:17:49 +0000995
996 /* create PySetObject structure */
Christian Heimes5b970ad2008-02-06 13:33:44 +0000997 if (numfree &&
Raymond Hettingerbc841a12005-08-07 13:02:53 +0000998 (type == &PySet_Type || type == &PyFrozenSet_Type)) {
Christian Heimes5b970ad2008-02-06 13:33:44 +0000999 so = free_list[--numfree];
Raymond Hettingerbc841a12005-08-07 13:02:53 +00001000 assert (so != NULL && PyAnySet_CheckExact(so));
Christian Heimese93237d2007-12-19 02:37:44 +00001001 Py_TYPE(so) = type;
Raymond Hettingerbc841a12005-08-07 13:02:53 +00001002 _Py_NewReference((PyObject *)so);
1003 EMPTY_TO_MINSIZE(so);
1004 PyObject_GC_Track(so);
1005 } else {
1006 so = (PySetObject *)type->tp_alloc(type, 0);
1007 if (so == NULL)
1008 return NULL;
1009 /* tp_alloc has already zeroed the structure */
1010 assert(so->table == NULL && so->fill == 0 && so->used == 0);
1011 INIT_NONZERO_SET_SLOTS(so);
1012 }
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001013
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001014 so->lookup = set_lookkey_string;
Raymond Hettinger691d8052004-05-30 07:26:47 +00001015 so->weakreflist = NULL;
Raymond Hettingera690a992003-11-16 16:17:49 +00001016
Raymond Hettingera38123e2003-11-24 22:18:49 +00001017 if (iterable != NULL) {
Raymond Hettingerd7946662005-08-01 21:39:29 +00001018 if (set_update_internal(so, iterable) == -1) {
Raymond Hettingera38123e2003-11-24 22:18:49 +00001019 Py_DECREF(so);
1020 return NULL;
1021 }
Raymond Hettingera38123e2003-11-24 22:18:49 +00001022 }
1023
Raymond Hettingera690a992003-11-16 16:17:49 +00001024 return (PyObject *)so;
1025}
1026
Raymond Hettingerd7946662005-08-01 21:39:29 +00001027/* The empty frozenset is a singleton */
1028static PyObject *emptyfrozenset = NULL;
1029
Raymond Hettingera690a992003-11-16 16:17:49 +00001030static PyObject *
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001031frozenset_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Raymond Hettingera690a992003-11-16 16:17:49 +00001032{
Raymond Hettingerd7946662005-08-01 21:39:29 +00001033 PyObject *iterable = NULL, *result;
Raymond Hettingera690a992003-11-16 16:17:49 +00001034
Raymond Hettinger9fdfadb2007-01-11 18:22:55 +00001035 if (type == &PyFrozenSet_Type && !_PyArg_NoKeywords("frozenset()", kwds))
Georg Brandl02c42872005-08-26 06:42:30 +00001036 return NULL;
1037
Raymond Hettingera690a992003-11-16 16:17:49 +00001038 if (!PyArg_UnpackTuple(args, type->tp_name, 0, 1, &iterable))
1039 return NULL;
Raymond Hettingerd7946662005-08-01 21:39:29 +00001040
1041 if (type != &PyFrozenSet_Type)
1042 return make_new_set(type, iterable);
1043
1044 if (iterable != NULL) {
1045 /* frozenset(f) is idempotent */
1046 if (PyFrozenSet_CheckExact(iterable)) {
1047 Py_INCREF(iterable);
1048 return iterable;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001049 }
Raymond Hettingerd7946662005-08-01 21:39:29 +00001050 result = make_new_set(type, iterable);
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001051 if (result == NULL || PySet_GET_SIZE(result))
Raymond Hettingerd7946662005-08-01 21:39:29 +00001052 return result;
1053 Py_DECREF(result);
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00001054 }
Raymond Hettingerd7946662005-08-01 21:39:29 +00001055 /* The empty frozenset is a singleton */
1056 if (emptyfrozenset == NULL)
1057 emptyfrozenset = make_new_set(type, NULL);
1058 Py_XINCREF(emptyfrozenset);
1059 return emptyfrozenset;
1060}
1061
1062void
1063PySet_Fini(void)
1064{
Raymond Hettingerbc841a12005-08-07 13:02:53 +00001065 PySetObject *so;
1066
Christian Heimes5b970ad2008-02-06 13:33:44 +00001067 while (numfree) {
1068 numfree--;
1069 so = free_list[numfree];
Raymond Hettingerbc841a12005-08-07 13:02:53 +00001070 PyObject_GC_Del(so);
1071 }
Martin v. Löwised8f7832006-04-15 12:47:23 +00001072 Py_CLEAR(dummy);
1073 Py_CLEAR(emptyfrozenset);
Raymond Hettingera690a992003-11-16 16:17:49 +00001074}
1075
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001076static PyObject *
1077set_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1078{
Raymond Hettinger9fdfadb2007-01-11 18:22:55 +00001079 if (type == &PySet_Type && !_PyArg_NoKeywords("set()", kwds))
Georg Brandl02c42872005-08-26 06:42:30 +00001080 return NULL;
1081
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001082 return make_new_set(type, NULL);
1083}
1084
Raymond Hettinger934d63e2005-07-31 01:33:10 +00001085/* set_swap_bodies() switches the contents of any two sets by moving their
1086 internal data pointers and, if needed, copying the internal smalltables.
1087 Semantically equivalent to:
1088
1089 t=set(a); a.clear(); a.update(b); b.clear(); b.update(t); del t
1090
1091 The function always succeeds and it leaves both objects in a stable state.
1092 Useful for creating temporary frozensets from sets for membership testing
1093 in __contains__(), discard(), and remove(). Also useful for operations
1094 that update in-place (by allowing an intermediate result to be swapped
Raymond Hettinger9dcb17c2005-07-31 13:09:28 +00001095 into one of the original inputs).
Raymond Hettinger934d63e2005-07-31 01:33:10 +00001096*/
1097
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001098static void
1099set_swap_bodies(PySetObject *a, PySetObject *b)
Raymond Hettingera690a992003-11-16 16:17:49 +00001100{
Neal Norwitz0f2783c2006-06-19 05:40:44 +00001101 Py_ssize_t t;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001102 setentry *u;
1103 setentry *(*f)(PySetObject *so, PyObject *key, long hash);
1104 setentry tab[PySet_MINSIZE];
1105 long h;
1106
1107 t = a->fill; a->fill = b->fill; b->fill = t;
1108 t = a->used; a->used = b->used; b->used = t;
1109 t = a->mask; a->mask = b->mask; b->mask = t;
1110
1111 u = a->table;
1112 if (a->table == a->smalltable)
1113 u = b->smalltable;
1114 a->table = b->table;
1115 if (b->table == b->smalltable)
1116 a->table = a->smalltable;
1117 b->table = u;
1118
1119 f = a->lookup; a->lookup = b->lookup; b->lookup = f;
1120
1121 if (a->table == a->smalltable || b->table == b->smalltable) {
1122 memcpy(tab, a->smalltable, sizeof(tab));
1123 memcpy(a->smalltable, b->smalltable, sizeof(tab));
1124 memcpy(b->smalltable, tab, sizeof(tab));
1125 }
1126
Christian Heimese93237d2007-12-19 02:37:44 +00001127 if (PyType_IsSubtype(Py_TYPE(a), &PyFrozenSet_Type) &&
1128 PyType_IsSubtype(Py_TYPE(b), &PyFrozenSet_Type)) {
Raymond Hettingera580c472005-08-05 17:19:54 +00001129 h = a->hash; a->hash = b->hash; b->hash = h;
1130 } else {
1131 a->hash = -1;
1132 b->hash = -1;
1133 }
Raymond Hettingera690a992003-11-16 16:17:49 +00001134}
1135
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00001136static PyObject *
Raymond Hettingera690a992003-11-16 16:17:49 +00001137set_copy(PySetObject *so)
1138{
Christian Heimese93237d2007-12-19 02:37:44 +00001139 return make_new_set(Py_TYPE(so), (PyObject *)so);
Raymond Hettingera690a992003-11-16 16:17:49 +00001140}
1141
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00001142static PyObject *
1143frozenset_copy(PySetObject *so)
1144{
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001145 if (PyFrozenSet_CheckExact(so)) {
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00001146 Py_INCREF(so);
1147 return (PyObject *)so;
1148 }
1149 return set_copy(so);
1150}
1151
Raymond Hettingera690a992003-11-16 16:17:49 +00001152PyDoc_STRVAR(copy_doc, "Return a shallow copy of a set.");
1153
1154static PyObject *
Raymond Hettingerc991db22005-08-11 07:58:45 +00001155set_clear(PySetObject *so)
1156{
1157 set_clear_internal(so);
1158 Py_RETURN_NONE;
1159}
1160
1161PyDoc_STRVAR(clear_doc, "Remove all elements from this set.");
1162
1163static PyObject *
Raymond Hettingeree4bcad2008-06-09 08:33:37 +00001164set_union(PySetObject *so, PyObject *args)
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001165{
1166 PySetObject *result;
Raymond Hettingeree4bcad2008-06-09 08:33:37 +00001167 PyObject *other;
1168 Py_ssize_t i;
1169
1170 result = (PySetObject *)set_copy(so);
1171 if (result == NULL)
1172 return NULL;
1173
1174 for (i=0 ; i<PyTuple_GET_SIZE(args) ; i++) {
1175 other = PyTuple_GET_ITEM(args, i);
1176 if ((PyObject *)so == other)
1177 return (PyObject *)result;
1178 if (set_update_internal(result, other) == -1) {
1179 Py_DECREF(result);
1180 return NULL;
1181 }
1182 }
1183 return (PyObject *)result;
1184}
1185
1186PyDoc_STRVAR(union_doc,
1187 "Return the union of sets as a new set.\n\
1188\n\
1189(i.e. all elements that are in either set.)");
1190
1191static PyObject *
1192set_or(PySetObject *so, PyObject *other)
1193{
1194 PySetObject *result;
1195
1196 if (!PyAnySet_Check(so) || !PyAnySet_Check(other)) {
1197 Py_INCREF(Py_NotImplemented);
1198 return Py_NotImplemented;
1199 }
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001200
1201 result = (PySetObject *)set_copy(so);
1202 if (result == NULL)
1203 return NULL;
Raymond Hettingerd8e13382005-08-17 12:27:17 +00001204 if ((PyObject *)so == other)
1205 return (PyObject *)result;
Raymond Hettingerd7946662005-08-01 21:39:29 +00001206 if (set_update_internal(result, other) == -1) {
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001207 Py_DECREF(result);
1208 return NULL;
1209 }
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001210 return (PyObject *)result;
1211}
1212
Raymond Hettingera690a992003-11-16 16:17:49 +00001213static PyObject *
1214set_ior(PySetObject *so, PyObject *other)
1215{
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001216 if (!PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001217 Py_INCREF(Py_NotImplemented);
1218 return Py_NotImplemented;
1219 }
Raymond Hettingerd7946662005-08-01 21:39:29 +00001220 if (set_update_internal(so, other) == -1)
Raymond Hettingera690a992003-11-16 16:17:49 +00001221 return NULL;
Raymond Hettingera690a992003-11-16 16:17:49 +00001222 Py_INCREF(so);
1223 return (PyObject *)so;
1224}
1225
1226static PyObject *
1227set_intersection(PySetObject *so, PyObject *other)
1228{
1229 PySetObject *result;
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001230 PyObject *key, *it, *tmp;
Raymond Hettingera690a992003-11-16 16:17:49 +00001231
Raymond Hettingerd8e13382005-08-17 12:27:17 +00001232 if ((PyObject *)so == other)
1233 return set_copy(so);
Raymond Hettingerc991db22005-08-11 07:58:45 +00001234
Christian Heimese93237d2007-12-19 02:37:44 +00001235 result = (PySetObject *)make_new_set(Py_TYPE(so), NULL);
Raymond Hettingera690a992003-11-16 16:17:49 +00001236 if (result == NULL)
1237 return NULL;
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001238
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001239 if (PyAnySet_Check(other)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001240 Py_ssize_t pos = 0;
Raymond Hettingerc991db22005-08-11 07:58:45 +00001241 setentry *entry;
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001242
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001243 if (PySet_GET_SIZE(other) > PySet_GET_SIZE(so)) {
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001244 tmp = (PyObject *)so;
1245 so = (PySetObject *)other;
1246 other = tmp;
1247 }
1248
Raymond Hettingerc991db22005-08-11 07:58:45 +00001249 while (set_next((PySetObject *)other, &pos, &entry)) {
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001250 int rv = set_contains_entry(so, entry);
1251 if (rv == -1) {
1252 Py_DECREF(result);
1253 return NULL;
1254 }
1255 if (rv) {
Raymond Hettingerc991db22005-08-11 07:58:45 +00001256 if (set_add_entry(result, entry) == -1) {
Raymond Hettingera3b11e72003-12-31 14:08:58 +00001257 Py_DECREF(result);
1258 return NULL;
1259 }
1260 }
1261 }
1262 return (PyObject *)result;
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001263 }
1264
Raymond Hettingera690a992003-11-16 16:17:49 +00001265 it = PyObject_GetIter(other);
1266 if (it == NULL) {
1267 Py_DECREF(result);
1268 return NULL;
1269 }
1270
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001271 while ((key = PyIter_Next(it)) != NULL) {
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001272 int rv;
1273 setentry entry;
1274 long hash = PyObject_Hash(key);
1275
1276 if (hash == -1) {
1277 Py_DECREF(it);
1278 Py_DECREF(result);
1279 Py_DECREF(key);
1280 return NULL;
1281 }
1282 entry.hash = hash;
1283 entry.key = key;
1284 rv = set_contains_entry(so, &entry);
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001285 if (rv == -1) {
1286 Py_DECREF(it);
1287 Py_DECREF(result);
1288 Py_DECREF(key);
1289 return NULL;
1290 }
1291 if (rv) {
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001292 if (set_add_entry(result, &entry) == -1) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001293 Py_DECREF(it);
1294 Py_DECREF(result);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001295 Py_DECREF(key);
Raymond Hettingera690a992003-11-16 16:17:49 +00001296 return NULL;
1297 }
1298 }
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001299 Py_DECREF(key);
Raymond Hettingera690a992003-11-16 16:17:49 +00001300 }
1301 Py_DECREF(it);
1302 if (PyErr_Occurred()) {
1303 Py_DECREF(result);
1304 return NULL;
1305 }
1306 return (PyObject *)result;
1307}
1308
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00001309static PyObject *
1310set_intersection_multi(PySetObject *so, PyObject *args)
1311{
1312 Py_ssize_t i;
1313 PyObject *result = (PyObject *)so;
1314
Raymond Hettinger610a93e2008-06-11 00:44:47 +00001315 if (PyTuple_GET_SIZE(args) == 0)
1316 return set_copy(so);
1317
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00001318 Py_INCREF(so);
1319 for (i=0 ; i<PyTuple_GET_SIZE(args) ; i++) {
1320 PyObject *other = PyTuple_GET_ITEM(args, i);
1321 PyObject *newresult = set_intersection((PySetObject *)result, other);
1322 if (newresult == NULL) {
1323 Py_DECREF(result);
1324 return NULL;
1325 }
1326 Py_DECREF(result);
1327 result = newresult;
1328 }
1329 return result;
1330}
1331
Raymond Hettingera690a992003-11-16 16:17:49 +00001332PyDoc_STRVAR(intersection_doc,
1333"Return the intersection of two sets as a new set.\n\
1334\n\
1335(i.e. all elements that are in both sets.)");
1336
1337static PyObject *
1338set_intersection_update(PySetObject *so, PyObject *other)
1339{
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001340 PyObject *tmp;
Raymond Hettingera690a992003-11-16 16:17:49 +00001341
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001342 tmp = set_intersection(so, other);
1343 if (tmp == NULL)
Raymond Hettingera690a992003-11-16 16:17:49 +00001344 return NULL;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001345 set_swap_bodies(so, (PySetObject *)tmp);
Raymond Hettingera690a992003-11-16 16:17:49 +00001346 Py_DECREF(tmp);
1347 Py_RETURN_NONE;
1348}
1349
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00001350static PyObject *
1351set_intersection_update_multi(PySetObject *so, PyObject *args)
1352{
1353 PyObject *tmp;
1354
1355 tmp = set_intersection_multi(so, args);
1356 if (tmp == NULL)
1357 return NULL;
1358 set_swap_bodies(so, (PySetObject *)tmp);
1359 Py_DECREF(tmp);
1360 Py_RETURN_NONE;
1361}
1362
Raymond Hettingera690a992003-11-16 16:17:49 +00001363PyDoc_STRVAR(intersection_update_doc,
1364"Update a set with the intersection of itself and another.");
1365
1366static PyObject *
1367set_and(PySetObject *so, PyObject *other)
1368{
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001369 if (!PyAnySet_Check(so) || !PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001370 Py_INCREF(Py_NotImplemented);
1371 return Py_NotImplemented;
1372 }
1373 return set_intersection(so, other);
1374}
1375
1376static PyObject *
1377set_iand(PySetObject *so, PyObject *other)
1378{
1379 PyObject *result;
1380
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001381 if (!PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001382 Py_INCREF(Py_NotImplemented);
1383 return Py_NotImplemented;
1384 }
1385 result = set_intersection_update(so, other);
1386 if (result == NULL)
1387 return NULL;
1388 Py_DECREF(result);
1389 Py_INCREF(so);
1390 return (PyObject *)so;
1391}
1392
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00001393static PyObject *
1394set_isdisjoint(PySetObject *so, PyObject *other)
1395{
1396 PyObject *key, *it, *tmp;
1397
1398 if ((PyObject *)so == other) {
1399 if (PySet_GET_SIZE(so) == 0)
1400 Py_RETURN_TRUE;
1401 else
1402 Py_RETURN_FALSE;
1403 }
1404
1405 if (PyAnySet_CheckExact(other)) {
1406 Py_ssize_t pos = 0;
1407 setentry *entry;
1408
1409 if (PySet_GET_SIZE(other) > PySet_GET_SIZE(so)) {
1410 tmp = (PyObject *)so;
1411 so = (PySetObject *)other;
1412 other = tmp;
1413 }
1414 while (set_next((PySetObject *)other, &pos, &entry)) {
1415 int rv = set_contains_entry(so, entry);
1416 if (rv == -1)
1417 return NULL;
1418 if (rv)
1419 Py_RETURN_FALSE;
1420 }
1421 Py_RETURN_TRUE;
1422 }
1423
1424 it = PyObject_GetIter(other);
1425 if (it == NULL)
1426 return NULL;
1427
1428 while ((key = PyIter_Next(it)) != NULL) {
1429 int rv;
1430 setentry entry;
1431 long hash = PyObject_Hash(key);
1432
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00001433 if (hash == -1) {
Raymond Hettingere8d58ba2007-11-08 18:47:51 +00001434 Py_DECREF(key);
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00001435 Py_DECREF(it);
1436 return NULL;
1437 }
1438 entry.hash = hash;
1439 entry.key = key;
1440 rv = set_contains_entry(so, &entry);
Raymond Hettingere8d58ba2007-11-08 18:47:51 +00001441 Py_DECREF(key);
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00001442 if (rv == -1) {
1443 Py_DECREF(it);
1444 return NULL;
1445 }
1446 if (rv) {
1447 Py_DECREF(it);
1448 Py_RETURN_FALSE;
1449 }
1450 }
1451 Py_DECREF(it);
1452 if (PyErr_Occurred())
1453 return NULL;
1454 Py_RETURN_TRUE;
1455}
1456
1457PyDoc_STRVAR(isdisjoint_doc,
1458"Return True if two sets have a null intersection.");
1459
Neal Norwitz6576bd82005-11-13 18:41:28 +00001460static int
Raymond Hettingerc991db22005-08-11 07:58:45 +00001461set_difference_update_internal(PySetObject *so, PyObject *other)
1462{
1463 if ((PyObject *)so == other)
1464 return set_clear_internal(so);
1465
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001466 if (PyAnySet_Check(other)) {
Raymond Hettingerc991db22005-08-11 07:58:45 +00001467 setentry *entry;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001468 Py_ssize_t pos = 0;
Raymond Hettingerc991db22005-08-11 07:58:45 +00001469
1470 while (set_next((PySetObject *)other, &pos, &entry))
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001471 if (set_discard_entry(so, entry) == -1)
1472 return -1;
Raymond Hettingerc991db22005-08-11 07:58:45 +00001473 } else {
1474 PyObject *key, *it;
1475 it = PyObject_GetIter(other);
1476 if (it == NULL)
1477 return -1;
1478
1479 while ((key = PyIter_Next(it)) != NULL) {
1480 if (set_discard_key(so, key) == -1) {
1481 Py_DECREF(it);
1482 Py_DECREF(key);
1483 return -1;
1484 }
1485 Py_DECREF(key);
1486 }
1487 Py_DECREF(it);
1488 if (PyErr_Occurred())
1489 return -1;
1490 }
1491 /* If more than 1/5 are dummies, then resize them away. */
1492 if ((so->fill - so->used) * 5 < so->mask)
1493 return 0;
1494 return set_table_resize(so, so->used>50000 ? so->used*2 : so->used*4);
1495}
1496
Raymond Hettingera690a992003-11-16 16:17:49 +00001497static PyObject *
Raymond Hettinger4267be62008-06-11 10:30:54 +00001498set_difference_update(PySetObject *so, PyObject *args)
Raymond Hettingera690a992003-11-16 16:17:49 +00001499{
Raymond Hettinger4267be62008-06-11 10:30:54 +00001500 Py_ssize_t i;
1501
1502 for (i=0 ; i<PyTuple_GET_SIZE(args) ; i++) {
1503 PyObject *other = PyTuple_GET_ITEM(args, i);
1504 if (set_difference_update_internal(so, other) == -1)
1505 return NULL;
1506 }
1507 Py_RETURN_NONE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001508}
1509
1510PyDoc_STRVAR(difference_update_doc,
1511"Remove all elements of another set from this set.");
1512
1513static PyObject *
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001514set_difference(PySetObject *so, PyObject *other)
1515{
Raymond Hettingerc991db22005-08-11 07:58:45 +00001516 PyObject *result;
1517 setentry *entry;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001518 Py_ssize_t pos = 0;
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001519
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001520 if (!PyAnySet_Check(other) && !PyDict_CheckExact(other)) {
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001521 result = set_copy(so);
1522 if (result == NULL)
Raymond Hettingerc991db22005-08-11 07:58:45 +00001523 return NULL;
1524 if (set_difference_update_internal((PySetObject *)result, other) != -1)
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001525 return result;
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001526 Py_DECREF(result);
1527 return NULL;
1528 }
1529
Christian Heimese93237d2007-12-19 02:37:44 +00001530 result = make_new_set(Py_TYPE(so), NULL);
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001531 if (result == NULL)
1532 return NULL;
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001533
Raymond Hettingerdb67aef2007-02-01 21:02:59 +00001534 if (PyDict_CheckExact(other)) {
Raymond Hettingerc991db22005-08-11 07:58:45 +00001535 while (set_next(so, &pos, &entry)) {
1536 setentry entrycopy;
1537 entrycopy.hash = entry->hash;
1538 entrycopy.key = entry->key;
Raymond Hettingerd6fc72a2007-02-19 02:03:19 +00001539 if (!_PyDict_Contains(other, entry->key, entry->hash)) {
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001540 if (set_add_entry((PySetObject *)result, &entrycopy) == -1) {
1541 Py_DECREF(result);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001542 return NULL;
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001543 }
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001544 }
1545 }
1546 return result;
1547 }
1548
Raymond Hettingerc991db22005-08-11 07:58:45 +00001549 while (set_next(so, &pos, &entry)) {
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001550 int rv = set_contains_entry((PySetObject *)other, entry);
1551 if (rv == -1) {
1552 Py_DECREF(result);
1553 return NULL;
1554 }
1555 if (!rv) {
1556 if (set_add_entry((PySetObject *)result, entry) == -1) {
1557 Py_DECREF(result);
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001558 return NULL;
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001559 }
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001560 }
1561 }
1562 return result;
1563}
1564
Raymond Hettinger4267be62008-06-11 10:30:54 +00001565static PyObject *
1566set_difference_multi(PySetObject *so, PyObject *args)
1567{
1568 Py_ssize_t i;
1569 PyObject *result, *other;
1570
1571 if (PyTuple_GET_SIZE(args) == 0)
1572 return set_copy(so);
1573
1574 other = PyTuple_GET_ITEM(args, 0);
1575 result = set_difference(so, other);
1576 if (result == NULL)
1577 return NULL;
1578
1579 for (i=1 ; i<PyTuple_GET_SIZE(args) ; i++) {
1580 other = PyTuple_GET_ITEM(args, i);
1581 if (set_difference_update_internal((PySetObject *)result, other) == -1) {
1582 Py_DECREF(result);
1583 return NULL;
1584 }
1585 }
1586 return result;
1587}
1588
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001589PyDoc_STRVAR(difference_doc,
Raymond Hettinger4267be62008-06-11 10:30:54 +00001590"Return the difference of two or more sets as a new set.\n\
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001591\n\
Raymond Hettinger4267be62008-06-11 10:30:54 +00001592(i.e. all elements that are in this set but not the others.)");
Raymond Hettingerfb4e33a2003-12-15 13:23:55 +00001593static PyObject *
Raymond Hettingera690a992003-11-16 16:17:49 +00001594set_sub(PySetObject *so, PyObject *other)
1595{
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001596 if (!PyAnySet_Check(so) || !PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001597 Py_INCREF(Py_NotImplemented);
1598 return Py_NotImplemented;
1599 }
1600 return set_difference(so, other);
1601}
1602
1603static PyObject *
1604set_isub(PySetObject *so, PyObject *other)
1605{
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001606 if (!PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001607 Py_INCREF(Py_NotImplemented);
1608 return Py_NotImplemented;
1609 }
Raymond Hettinger4267be62008-06-11 10:30:54 +00001610 if (set_difference_update_internal(so, other) == -1)
Raymond Hettingera690a992003-11-16 16:17:49 +00001611 return NULL;
Raymond Hettingera690a992003-11-16 16:17:49 +00001612 Py_INCREF(so);
1613 return (PyObject *)so;
1614}
1615
1616static PyObject *
Raymond Hettingera690a992003-11-16 16:17:49 +00001617set_symmetric_difference_update(PySetObject *so, PyObject *other)
1618{
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001619 PySetObject *otherset;
1620 PyObject *key;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001621 Py_ssize_t pos = 0;
Raymond Hettingerc991db22005-08-11 07:58:45 +00001622 setentry *entry;
1623
1624 if ((PyObject *)so == other)
1625 return set_clear(so);
Raymond Hettingera690a992003-11-16 16:17:49 +00001626
Raymond Hettingerdb67aef2007-02-01 21:02:59 +00001627 if (PyDict_CheckExact(other)) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001628 PyObject *value;
1629 int rv;
Raymond Hettingerd6fc72a2007-02-19 02:03:19 +00001630 long hash;
1631 while (_PyDict_Next(other, &pos, &key, &value, &hash)) {
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001632 setentry an_entry;
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001633
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001634 an_entry.hash = hash;
1635 an_entry.key = key;
1636 rv = set_discard_entry(so, &an_entry);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001637 if (rv == -1)
1638 return NULL;
1639 if (rv == DISCARD_NOTFOUND) {
Raymond Hettingerf31e1752006-12-08 03:17:18 +00001640 if (set_add_entry(so, &an_entry) == -1)
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001641 return NULL;
1642 }
1643 }
1644 Py_RETURN_NONE;
1645 }
1646
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001647 if (PyAnySet_Check(other)) {
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001648 Py_INCREF(other);
1649 otherset = (PySetObject *)other;
1650 } else {
Christian Heimese93237d2007-12-19 02:37:44 +00001651 otherset = (PySetObject *)make_new_set(Py_TYPE(so), other);
Raymond Hettingera690a992003-11-16 16:17:49 +00001652 if (otherset == NULL)
1653 return NULL;
Raymond Hettingera690a992003-11-16 16:17:49 +00001654 }
1655
Raymond Hettingerc991db22005-08-11 07:58:45 +00001656 while (set_next(otherset, &pos, &entry)) {
1657 int rv = set_discard_entry(so, entry);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001658 if (rv == -1) {
Neal Norwitz04e39ec2006-07-17 00:57:15 +00001659 Py_DECREF(otherset);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001660 return NULL;
1661 }
1662 if (rv == DISCARD_NOTFOUND) {
Raymond Hettingerc991db22005-08-11 07:58:45 +00001663 if (set_add_entry(so, entry) == -1) {
Neal Norwitz04e39ec2006-07-17 00:57:15 +00001664 Py_DECREF(otherset);
Raymond Hettingera690a992003-11-16 16:17:49 +00001665 return NULL;
1666 }
1667 }
Raymond Hettingera690a992003-11-16 16:17:49 +00001668 }
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001669 Py_DECREF(otherset);
Raymond Hettingera690a992003-11-16 16:17:49 +00001670 Py_RETURN_NONE;
1671}
1672
1673PyDoc_STRVAR(symmetric_difference_update_doc,
1674"Update a set with the symmetric difference of itself and another.");
1675
1676static PyObject *
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001677set_symmetric_difference(PySetObject *so, PyObject *other)
1678{
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001679 PyObject *rv;
1680 PySetObject *otherset;
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001681
Christian Heimese93237d2007-12-19 02:37:44 +00001682 otherset = (PySetObject *)make_new_set(Py_TYPE(so), other);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001683 if (otherset == NULL)
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001684 return NULL;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001685 rv = set_symmetric_difference_update(otherset, (PyObject *)so);
1686 if (rv == NULL)
1687 return NULL;
1688 Py_DECREF(rv);
1689 return (PyObject *)otherset;
Raymond Hettingerf5f41bf2003-11-24 02:57:33 +00001690}
1691
1692PyDoc_STRVAR(symmetric_difference_doc,
1693"Return the symmetric difference of two sets as a new set.\n\
1694\n\
1695(i.e. all elements that are in exactly one of the sets.)");
1696
1697static PyObject *
Raymond Hettingera690a992003-11-16 16:17:49 +00001698set_xor(PySetObject *so, PyObject *other)
1699{
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001700 if (!PyAnySet_Check(so) || !PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001701 Py_INCREF(Py_NotImplemented);
1702 return Py_NotImplemented;
1703 }
1704 return set_symmetric_difference(so, other);
1705}
1706
1707static PyObject *
1708set_ixor(PySetObject *so, PyObject *other)
1709{
1710 PyObject *result;
1711
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001712 if (!PyAnySet_Check(other)) {
Raymond Hettingera690a992003-11-16 16:17:49 +00001713 Py_INCREF(Py_NotImplemented);
1714 return Py_NotImplemented;
1715 }
1716 result = set_symmetric_difference_update(so, other);
1717 if (result == NULL)
1718 return NULL;
1719 Py_DECREF(result);
1720 Py_INCREF(so);
1721 return (PyObject *)so;
1722}
1723
1724static PyObject *
1725set_issubset(PySetObject *so, PyObject *other)
1726{
Raymond Hettingered6c1ef2005-08-13 08:28:03 +00001727 setentry *entry;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001728 Py_ssize_t pos = 0;
Raymond Hettingera690a992003-11-16 16:17:49 +00001729
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001730 if (!PyAnySet_Check(other)) {
Raymond Hettingered6c1ef2005-08-13 08:28:03 +00001731 PyObject *tmp, *result;
Raymond Hettinger3fbec702003-11-21 07:56:36 +00001732 tmp = make_new_set(&PySet_Type, other);
1733 if (tmp == NULL)
1734 return NULL;
1735 result = set_issubset(so, tmp);
1736 Py_DECREF(tmp);
1737 return result;
Raymond Hettingera690a992003-11-16 16:17:49 +00001738 }
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001739 if (PySet_GET_SIZE(so) > PySet_GET_SIZE(other))
Raymond Hettingera690a992003-11-16 16:17:49 +00001740 Py_RETURN_FALSE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001741
Raymond Hettingered6c1ef2005-08-13 08:28:03 +00001742 while (set_next(so, &pos, &entry)) {
Raymond Hettingerc563a1c2006-09-07 02:42:48 +00001743 int rv = set_contains_entry((PySetObject *)other, entry);
1744 if (rv == -1)
1745 return NULL;
1746 if (!rv)
Raymond Hettingera690a992003-11-16 16:17:49 +00001747 Py_RETURN_FALSE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001748 }
Raymond Hettingera690a992003-11-16 16:17:49 +00001749 Py_RETURN_TRUE;
1750}
1751
1752PyDoc_STRVAR(issubset_doc, "Report whether another set contains this set.");
1753
1754static PyObject *
1755set_issuperset(PySetObject *so, PyObject *other)
1756{
Raymond Hettinger3fbec702003-11-21 07:56:36 +00001757 PyObject *tmp, *result;
1758
Raymond Hettinger3dbd4c52008-01-25 19:24:46 +00001759 if (!PyAnySet_Check(other)) {
Raymond Hettinger3fbec702003-11-21 07:56:36 +00001760 tmp = make_new_set(&PySet_Type, other);
1761 if (tmp == NULL)
1762 return NULL;
1763 result = set_issuperset(so, tmp);
1764 Py_DECREF(tmp);
1765 return result;
Raymond Hettingera690a992003-11-16 16:17:49 +00001766 }
1767 return set_issubset((PySetObject *)other, (PyObject *)so);
1768}
1769
1770PyDoc_STRVAR(issuperset_doc, "Report whether this set contains another set.");
1771
Raymond Hettingera690a992003-11-16 16:17:49 +00001772static PyObject *
1773set_richcompare(PySetObject *v, PyObject *w, int op)
1774{
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001775 PyObject *r1, *r2;
1776
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001777 if(!PyAnySet_Check(w)) {
1778 if (op == Py_EQ)
1779 Py_RETURN_FALSE;
1780 if (op == Py_NE)
1781 Py_RETURN_TRUE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001782 PyErr_SetString(PyExc_TypeError, "can only compare to a set");
1783 return NULL;
1784 }
1785 switch (op) {
1786 case Py_EQ:
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001787 if (PySet_GET_SIZE(v) != PySet_GET_SIZE(w))
Raymond Hettingera690a992003-11-16 16:17:49 +00001788 Py_RETURN_FALSE;
Raymond Hettinger9c1491f2005-08-24 00:24:40 +00001789 if (v->hash != -1 &&
1790 ((PySetObject *)w)->hash != -1 &&
1791 v->hash != ((PySetObject *)w)->hash)
1792 Py_RETURN_FALSE;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001793 return set_issubset(v, w);
1794 case Py_NE:
Raymond Hettinger9c1491f2005-08-24 00:24:40 +00001795 r1 = set_richcompare(v, w, Py_EQ);
1796 if (r1 == NULL)
1797 return NULL;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001798 r2 = PyBool_FromLong(PyObject_Not(r1));
1799 Py_DECREF(r1);
1800 return r2;
1801 case Py_LE:
1802 return set_issubset(v, w);
1803 case Py_GE:
1804 return set_issuperset(v, w);
1805 case Py_LT:
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001806 if (PySet_GET_SIZE(v) >= PySet_GET_SIZE(w))
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001807 Py_RETURN_FALSE;
1808 return set_issubset(v, w);
1809 case Py_GT:
Raymond Hettingerbeb31012005-08-16 03:47:52 +00001810 if (PySet_GET_SIZE(v) <= PySet_GET_SIZE(w))
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001811 Py_RETURN_FALSE;
1812 return set_issuperset(v, w);
Raymond Hettingera690a992003-11-16 16:17:49 +00001813 }
1814 Py_INCREF(Py_NotImplemented);
1815 return Py_NotImplemented;
1816}
1817
Raymond Hettingered6c1ef2005-08-13 08:28:03 +00001818static int
Georg Brandl347b3002006-03-30 11:57:00 +00001819set_nocmp(PyObject *self, PyObject *other)
Raymond Hettingered6c1ef2005-08-13 08:28:03 +00001820{
1821 PyErr_SetString(PyExc_TypeError, "cannot compare sets using cmp()");
1822 return -1;
1823}
1824
Raymond Hettingera690a992003-11-16 16:17:49 +00001825static PyObject *
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001826set_add(PySetObject *so, PyObject *key)
Raymond Hettingera690a992003-11-16 16:17:49 +00001827{
Raymond Hettingerc991db22005-08-11 07:58:45 +00001828 if (set_add_key(so, key) == -1)
Raymond Hettingera690a992003-11-16 16:17:49 +00001829 return NULL;
Raymond Hettinger438e02d2003-12-13 19:38:47 +00001830 Py_RETURN_NONE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001831}
1832
1833PyDoc_STRVAR(add_doc,
1834"Add an element to a set.\n\
1835\n\
1836This has no effect if the element is already present.");
1837
Raymond Hettingerce8185e2005-08-13 09:28:48 +00001838static int
1839set_contains(PySetObject *so, PyObject *key)
1840{
1841 PyObject *tmpkey;
1842 int rv;
1843
1844 rv = set_contains_key(so, key);
1845 if (rv == -1) {
Raymond Hettingerc5a1cc52008-05-08 04:35:20 +00001846 if (!PySet_Check(key) || !PyErr_ExceptionMatches(PyExc_TypeError))
Raymond Hettingerce8185e2005-08-13 09:28:48 +00001847 return -1;
1848 PyErr_Clear();
1849 tmpkey = make_new_set(&PyFrozenSet_Type, NULL);
1850 if (tmpkey == NULL)
1851 return -1;
1852 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
1853 rv = set_contains(so, tmpkey);
1854 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
1855 Py_DECREF(tmpkey);
1856 }
1857 return rv;
1858}
1859
1860static PyObject *
1861set_direct_contains(PySetObject *so, PyObject *key)
1862{
1863 long result;
1864
1865 result = set_contains(so, key);
1866 if (result == -1)
1867 return NULL;
1868 return PyBool_FromLong(result);
1869}
1870
1871PyDoc_STRVAR(contains_doc, "x.__contains__(y) <==> y in x.");
1872
Raymond Hettingera690a992003-11-16 16:17:49 +00001873static PyObject *
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001874set_remove(PySetObject *so, PyObject *key)
Raymond Hettingera690a992003-11-16 16:17:49 +00001875{
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001876 PyObject *tmpkey, *result;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001877 int rv;
Raymond Hettingerbfd334a2003-11-22 03:55:23 +00001878
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001879 rv = set_discard_key(so, key);
1880 if (rv == -1) {
Raymond Hettingerc5a1cc52008-05-08 04:35:20 +00001881 if (!PySet_Check(key) || !PyErr_ExceptionMatches(PyExc_TypeError))
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001882 return NULL;
1883 PyErr_Clear();
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001884 tmpkey = make_new_set(&PyFrozenSet_Type, NULL);
1885 if (tmpkey == NULL)
Raymond Hettingerbfd334a2003-11-22 03:55:23 +00001886 return NULL;
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001887 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001888 result = set_remove(so, tmpkey);
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001889 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001890 Py_DECREF(tmpkey);
Raymond Hettinger0deab622003-12-13 18:53:18 +00001891 return result;
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001892 } else if (rv == DISCARD_NOTFOUND) {
Raymond Hettinger9c14ffb2006-12-08 04:57:50 +00001893 set_key_error(key);
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001894 return NULL;
1895 }
Raymond Hettinger438e02d2003-12-13 19:38:47 +00001896 Py_RETURN_NONE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001897}
1898
1899PyDoc_STRVAR(remove_doc,
1900"Remove an element from a set; it must be a member.\n\
1901\n\
1902If the element is not a member, raise a KeyError.");
1903
1904static PyObject *
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001905set_discard(PySetObject *so, PyObject *key)
Raymond Hettingera690a992003-11-16 16:17:49 +00001906{
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001907 PyObject *tmpkey, *result;
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001908 int rv;
Raymond Hettinger0deab622003-12-13 18:53:18 +00001909
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001910 rv = set_discard_key(so, key);
1911 if (rv == -1) {
Raymond Hettingerc5a1cc52008-05-08 04:35:20 +00001912 if (!PySet_Check(key) || !PyErr_ExceptionMatches(PyExc_TypeError))
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001913 return NULL;
1914 PyErr_Clear();
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001915 tmpkey = make_new_set(&PyFrozenSet_Type, NULL);
1916 if (tmpkey == NULL)
Raymond Hettinger0deab622003-12-13 18:53:18 +00001917 return NULL;
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001918 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001919 result = set_discard(so, tmpkey);
Raymond Hettingerb02c35e2005-08-12 20:48:39 +00001920 set_swap_bodies((PySetObject *)tmpkey, (PySetObject *)key);
Raymond Hettinger06d8cf82005-07-31 15:36:06 +00001921 Py_DECREF(tmpkey);
Raymond Hettinger0deab622003-12-13 18:53:18 +00001922 return result;
1923 }
Raymond Hettinger438e02d2003-12-13 19:38:47 +00001924 Py_RETURN_NONE;
Raymond Hettingera690a992003-11-16 16:17:49 +00001925}
1926
1927PyDoc_STRVAR(discard_doc,
1928"Remove an element from a set if it is a member.\n\
1929\n\
1930If the element is not a member, do nothing.");
1931
1932static PyObject *
Raymond Hettingera690a992003-11-16 16:17:49 +00001933set_reduce(PySetObject *so)
1934{
Raymond Hettinger15056a52004-11-09 07:25:31 +00001935 PyObject *keys=NULL, *args=NULL, *result=NULL, *dict=NULL;
Raymond Hettingera690a992003-11-16 16:17:49 +00001936
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001937 keys = PySequence_List((PyObject *)so);
Raymond Hettingera690a992003-11-16 16:17:49 +00001938 if (keys == NULL)
1939 goto done;
1940 args = PyTuple_Pack(1, keys);
1941 if (args == NULL)
1942 goto done;
Raymond Hettinger15056a52004-11-09 07:25:31 +00001943 dict = PyObject_GetAttrString((PyObject *)so, "__dict__");
1944 if (dict == NULL) {
1945 PyErr_Clear();
1946 dict = Py_None;
1947 Py_INCREF(dict);
1948 }
Christian Heimese93237d2007-12-19 02:37:44 +00001949 result = PyTuple_Pack(3, Py_TYPE(so), args, dict);
Raymond Hettingera690a992003-11-16 16:17:49 +00001950done:
1951 Py_XDECREF(args);
1952 Py_XDECREF(keys);
Raymond Hettinger15056a52004-11-09 07:25:31 +00001953 Py_XDECREF(dict);
Raymond Hettingera690a992003-11-16 16:17:49 +00001954 return result;
1955}
1956
1957PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
1958
Robert Schuppenies9be2ec12008-07-10 15:24:04 +00001959static PyObject *
1960set_sizeof(PySetObject *so)
1961{
1962 Py_ssize_t res;
1963
1964 res = sizeof(PySetObject);
1965 if (so->table != so->smalltable)
1966 res = res + (so->mask + 1) * sizeof(setentry);
1967 return PyInt_FromSsize_t(res);
1968}
1969
1970PyDoc_STRVAR(sizeof_doc, "S.__sizeof__() -> size of S in memory, in bytes");
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001971static int
1972set_init(PySetObject *self, PyObject *args, PyObject *kwds)
1973{
1974 PyObject *iterable = NULL;
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001975
1976 if (!PyAnySet_Check(self))
1977 return -1;
Christian Heimese93237d2007-12-19 02:37:44 +00001978 if (!PyArg_UnpackTuple(args, Py_TYPE(self)->tp_name, 0, 1, &iterable))
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001979 return -1;
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00001980 set_clear_internal(self);
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001981 self->hash = -1;
1982 if (iterable == NULL)
1983 return 0;
Raymond Hettingerd7946662005-08-01 21:39:29 +00001984 return set_update_internal(self, iterable);
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00001985}
1986
Raymond Hettingera690a992003-11-16 16:17:49 +00001987static PySequenceMethods set_as_sequence = {
Georg Brandl347b3002006-03-30 11:57:00 +00001988 set_len, /* sq_length */
Raymond Hettingera690a992003-11-16 16:17:49 +00001989 0, /* sq_concat */
1990 0, /* sq_repeat */
1991 0, /* sq_item */
1992 0, /* sq_slice */
1993 0, /* sq_ass_item */
1994 0, /* sq_ass_slice */
1995 (objobjproc)set_contains, /* sq_contains */
1996};
1997
1998/* set object ********************************************************/
1999
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002000#ifdef Py_DEBUG
2001static PyObject *test_c_api(PySetObject *so);
2002
2003PyDoc_STRVAR(test_c_api_doc, "Exercises C API. Returns True.\n\
2004All is well if assertions don't fail.");
2005#endif
2006
Raymond Hettingera690a992003-11-16 16:17:49 +00002007static PyMethodDef set_methods[] = {
2008 {"add", (PyCFunction)set_add, METH_O,
2009 add_doc},
2010 {"clear", (PyCFunction)set_clear, METH_NOARGS,
2011 clear_doc},
Raymond Hettinger0deab622003-12-13 18:53:18 +00002012 {"__contains__",(PyCFunction)set_direct_contains, METH_O | METH_COEXIST,
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002013 contains_doc},
Raymond Hettingera37430a2008-02-12 19:05:36 +00002014 {"copy", (PyCFunction)set_copy, METH_NOARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002015 copy_doc},
Raymond Hettingera690a992003-11-16 16:17:49 +00002016 {"discard", (PyCFunction)set_discard, METH_O,
2017 discard_doc},
Raymond Hettinger4267be62008-06-11 10:30:54 +00002018 {"difference", (PyCFunction)set_difference_multi, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002019 difference_doc},
Raymond Hettinger4267be62008-06-11 10:30:54 +00002020 {"difference_update", (PyCFunction)set_difference_update, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002021 difference_update_doc},
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00002022 {"intersection",(PyCFunction)set_intersection_multi, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002023 intersection_doc},
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00002024 {"intersection_update",(PyCFunction)set_intersection_update_multi, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002025 intersection_update_doc},
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00002026 {"isdisjoint", (PyCFunction)set_isdisjoint, METH_O,
2027 isdisjoint_doc},
Raymond Hettingera690a992003-11-16 16:17:49 +00002028 {"issubset", (PyCFunction)set_issubset, METH_O,
2029 issubset_doc},
2030 {"issuperset", (PyCFunction)set_issuperset, METH_O,
2031 issuperset_doc},
2032 {"pop", (PyCFunction)set_pop, METH_NOARGS,
2033 pop_doc},
2034 {"__reduce__", (PyCFunction)set_reduce, METH_NOARGS,
2035 reduce_doc},
2036 {"remove", (PyCFunction)set_remove, METH_O,
2037 remove_doc},
Robert Schuppenies9be2ec12008-07-10 15:24:04 +00002038 {"__sizeof__", (PyCFunction)set_sizeof, METH_NOARGS,
2039 sizeof_doc},
Raymond Hettingera690a992003-11-16 16:17:49 +00002040 {"symmetric_difference",(PyCFunction)set_symmetric_difference, METH_O,
2041 symmetric_difference_doc},
2042 {"symmetric_difference_update",(PyCFunction)set_symmetric_difference_update, METH_O,
2043 symmetric_difference_update_doc},
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002044#ifdef Py_DEBUG
2045 {"test_c_api", (PyCFunction)test_c_api, METH_NOARGS,
2046 test_c_api_doc},
2047#endif
Raymond Hettingeree4bcad2008-06-09 08:33:37 +00002048 {"union", (PyCFunction)set_union, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002049 union_doc},
Raymond Hettingeree4bcad2008-06-09 08:33:37 +00002050 {"update", (PyCFunction)set_update, METH_VARARGS,
Raymond Hettingera38123e2003-11-24 22:18:49 +00002051 update_doc},
Raymond Hettingera690a992003-11-16 16:17:49 +00002052 {NULL, NULL} /* sentinel */
2053};
2054
2055static PyNumberMethods set_as_number = {
2056 0, /*nb_add*/
2057 (binaryfunc)set_sub, /*nb_subtract*/
2058 0, /*nb_multiply*/
2059 0, /*nb_divide*/
2060 0, /*nb_remainder*/
2061 0, /*nb_divmod*/
2062 0, /*nb_power*/
2063 0, /*nb_negative*/
2064 0, /*nb_positive*/
2065 0, /*nb_absolute*/
2066 0, /*nb_nonzero*/
2067 0, /*nb_invert*/
2068 0, /*nb_lshift*/
2069 0, /*nb_rshift*/
2070 (binaryfunc)set_and, /*nb_and*/
2071 (binaryfunc)set_xor, /*nb_xor*/
2072 (binaryfunc)set_or, /*nb_or*/
2073 0, /*nb_coerce*/
2074 0, /*nb_int*/
2075 0, /*nb_long*/
2076 0, /*nb_float*/
2077 0, /*nb_oct*/
2078 0, /*nb_hex*/
2079 0, /*nb_inplace_add*/
2080 (binaryfunc)set_isub, /*nb_inplace_subtract*/
2081 0, /*nb_inplace_multiply*/
2082 0, /*nb_inplace_divide*/
2083 0, /*nb_inplace_remainder*/
2084 0, /*nb_inplace_power*/
2085 0, /*nb_inplace_lshift*/
2086 0, /*nb_inplace_rshift*/
2087 (binaryfunc)set_iand, /*nb_inplace_and*/
2088 (binaryfunc)set_ixor, /*nb_inplace_xor*/
2089 (binaryfunc)set_ior, /*nb_inplace_or*/
2090};
2091
2092PyDoc_STRVAR(set_doc,
2093"set(iterable) --> set object\n\
2094\n\
Andrew M. Kuchling52740be2006-07-29 15:10:32 +00002095Build an unordered collection of unique elements.");
Raymond Hettingera690a992003-11-16 16:17:49 +00002096
2097PyTypeObject PySet_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002098 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Raymond Hettingera690a992003-11-16 16:17:49 +00002099 "set", /* tp_name */
2100 sizeof(PySetObject), /* tp_basicsize */
2101 0, /* tp_itemsize */
2102 /* methods */
2103 (destructor)set_dealloc, /* tp_dealloc */
2104 (printfunc)set_tp_print, /* tp_print */
2105 0, /* tp_getattr */
2106 0, /* tp_setattr */
Georg Brandl347b3002006-03-30 11:57:00 +00002107 set_nocmp, /* tp_compare */
Raymond Hettingera690a992003-11-16 16:17:49 +00002108 (reprfunc)set_repr, /* tp_repr */
2109 &set_as_number, /* tp_as_number */
2110 &set_as_sequence, /* tp_as_sequence */
2111 0, /* tp_as_mapping */
Guido van Rossum64c06e32007-11-22 00:55:51 +00002112 0, /* tp_hash */
Raymond Hettingera690a992003-11-16 16:17:49 +00002113 0, /* tp_call */
2114 0, /* tp_str */
2115 PyObject_GenericGetAttr, /* tp_getattro */
2116 0, /* tp_setattro */
2117 0, /* tp_as_buffer */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002118 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES |
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00002119 Py_TPFLAGS_BASETYPE, /* tp_flags */
Raymond Hettingera690a992003-11-16 16:17:49 +00002120 set_doc, /* tp_doc */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002121 (traverseproc)set_traverse, /* tp_traverse */
Raymond Hettingerfe889f32005-08-06 05:43:39 +00002122 (inquiry)set_clear_internal, /* tp_clear */
Raymond Hettingera690a992003-11-16 16:17:49 +00002123 (richcmpfunc)set_richcompare, /* tp_richcompare */
Raymond Hettinger691d8052004-05-30 07:26:47 +00002124 offsetof(PySetObject, weakreflist), /* tp_weaklistoffset */
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00002125 (getiterfunc)set_iter, /* tp_iter */
Raymond Hettingera690a992003-11-16 16:17:49 +00002126 0, /* tp_iternext */
2127 set_methods, /* tp_methods */
2128 0, /* tp_members */
2129 0, /* tp_getset */
2130 0, /* tp_base */
2131 0, /* tp_dict */
2132 0, /* tp_descr_get */
2133 0, /* tp_descr_set */
2134 0, /* tp_dictoffset */
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00002135 (initproc)set_init, /* tp_init */
Raymond Hettingera690a992003-11-16 16:17:49 +00002136 PyType_GenericAlloc, /* tp_alloc */
2137 set_new, /* tp_new */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002138 PyObject_GC_Del, /* tp_free */
Raymond Hettingera690a992003-11-16 16:17:49 +00002139};
2140
2141/* frozenset object ********************************************************/
2142
2143
2144static PyMethodDef frozenset_methods[] = {
Raymond Hettinger0deab622003-12-13 18:53:18 +00002145 {"__contains__",(PyCFunction)set_direct_contains, METH_O | METH_COEXIST,
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002146 contains_doc},
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00002147 {"copy", (PyCFunction)frozenset_copy, METH_NOARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002148 copy_doc},
Raymond Hettinger4267be62008-06-11 10:30:54 +00002149 {"difference", (PyCFunction)set_difference_multi, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002150 difference_doc},
Raymond Hettinger5c4d3d02008-06-09 13:07:27 +00002151 {"intersection",(PyCFunction)set_intersection_multi, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002152 intersection_doc},
Raymond Hettinger1760c8a2007-11-08 02:52:43 +00002153 {"isdisjoint", (PyCFunction)set_isdisjoint, METH_O,
2154 isdisjoint_doc},
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00002155 {"issubset", (PyCFunction)set_issubset, METH_O,
Raymond Hettingera690a992003-11-16 16:17:49 +00002156 issubset_doc},
Raymond Hettinger49ba4c32003-11-23 02:49:05 +00002157 {"issuperset", (PyCFunction)set_issuperset, METH_O,
Raymond Hettingera690a992003-11-16 16:17:49 +00002158 issuperset_doc},
2159 {"__reduce__", (PyCFunction)set_reduce, METH_NOARGS,
2160 reduce_doc},
Robert Schuppenies9be2ec12008-07-10 15:24:04 +00002161 {"__sizeof__", (PyCFunction)set_sizeof, METH_NOARGS,
2162 sizeof_doc},
Raymond Hettingera690a992003-11-16 16:17:49 +00002163 {"symmetric_difference",(PyCFunction)set_symmetric_difference, METH_O,
2164 symmetric_difference_doc},
Raymond Hettingeree4bcad2008-06-09 08:33:37 +00002165 {"union", (PyCFunction)set_union, METH_VARARGS,
Raymond Hettingera690a992003-11-16 16:17:49 +00002166 union_doc},
2167 {NULL, NULL} /* sentinel */
2168};
2169
2170static PyNumberMethods frozenset_as_number = {
2171 0, /*nb_add*/
2172 (binaryfunc)set_sub, /*nb_subtract*/
2173 0, /*nb_multiply*/
2174 0, /*nb_divide*/
2175 0, /*nb_remainder*/
2176 0, /*nb_divmod*/
2177 0, /*nb_power*/
2178 0, /*nb_negative*/
2179 0, /*nb_positive*/
2180 0, /*nb_absolute*/
2181 0, /*nb_nonzero*/
2182 0, /*nb_invert*/
2183 0, /*nb_lshift*/
2184 0, /*nb_rshift*/
2185 (binaryfunc)set_and, /*nb_and*/
2186 (binaryfunc)set_xor, /*nb_xor*/
2187 (binaryfunc)set_or, /*nb_or*/
2188};
2189
2190PyDoc_STRVAR(frozenset_doc,
2191"frozenset(iterable) --> frozenset object\n\
2192\n\
Andrew M. Kuchling52740be2006-07-29 15:10:32 +00002193Build an immutable unordered collection of unique elements.");
Raymond Hettingera690a992003-11-16 16:17:49 +00002194
2195PyTypeObject PyFrozenSet_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002196 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Raymond Hettingera690a992003-11-16 16:17:49 +00002197 "frozenset", /* tp_name */
2198 sizeof(PySetObject), /* tp_basicsize */
Raymond Hettingera3b11e72003-12-31 14:08:58 +00002199 0, /* tp_itemsize */
2200 /* methods */
Raymond Hettingera690a992003-11-16 16:17:49 +00002201 (destructor)set_dealloc, /* tp_dealloc */
2202 (printfunc)set_tp_print, /* tp_print */
2203 0, /* tp_getattr */
2204 0, /* tp_setattr */
Georg Brandl347b3002006-03-30 11:57:00 +00002205 set_nocmp, /* tp_compare */
Raymond Hettingera690a992003-11-16 16:17:49 +00002206 (reprfunc)set_repr, /* tp_repr */
2207 &frozenset_as_number, /* tp_as_number */
2208 &set_as_sequence, /* tp_as_sequence */
2209 0, /* tp_as_mapping */
2210 frozenset_hash, /* tp_hash */
2211 0, /* tp_call */
2212 0, /* tp_str */
2213 PyObject_GenericGetAttr, /* tp_getattro */
2214 0, /* tp_setattro */
2215 0, /* tp_as_buffer */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002216 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES |
Raymond Hettinger9f1a6792005-07-31 01:16:36 +00002217 Py_TPFLAGS_BASETYPE, /* tp_flags */
Raymond Hettingera690a992003-11-16 16:17:49 +00002218 frozenset_doc, /* tp_doc */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002219 (traverseproc)set_traverse, /* tp_traverse */
Raymond Hettingerfe889f32005-08-06 05:43:39 +00002220 (inquiry)set_clear_internal, /* tp_clear */
Raymond Hettingera690a992003-11-16 16:17:49 +00002221 (richcmpfunc)set_richcompare, /* tp_richcompare */
Raymond Hettinger691d8052004-05-30 07:26:47 +00002222 offsetof(PySetObject, weakreflist), /* tp_weaklistoffset */
Raymond Hettingera690a992003-11-16 16:17:49 +00002223 (getiterfunc)set_iter, /* tp_iter */
2224 0, /* tp_iternext */
2225 frozenset_methods, /* tp_methods */
2226 0, /* tp_members */
2227 0, /* tp_getset */
2228 0, /* tp_base */
2229 0, /* tp_dict */
2230 0, /* tp_descr_get */
2231 0, /* tp_descr_set */
2232 0, /* tp_dictoffset */
2233 0, /* tp_init */
2234 PyType_GenericAlloc, /* tp_alloc */
Raymond Hettinger50a4bb32003-11-17 16:42:33 +00002235 frozenset_new, /* tp_new */
Raymond Hettingerbb999b52005-06-18 21:00:26 +00002236 PyObject_GC_Del, /* tp_free */
Raymond Hettingera690a992003-11-16 16:17:49 +00002237};
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002238
2239
2240/***** C API functions *************************************************/
2241
2242PyObject *
2243PySet_New(PyObject *iterable)
2244{
2245 return make_new_set(&PySet_Type, iterable);
2246}
2247
2248PyObject *
2249PyFrozenSet_New(PyObject *iterable)
2250{
Raymond Hettingerecdcb582008-01-28 20:34:33 +00002251 return make_new_set(&PyFrozenSet_Type, iterable);
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002252}
2253
Neal Norwitz8c49c822006-03-04 18:41:19 +00002254Py_ssize_t
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002255PySet_Size(PyObject *anyset)
2256{
2257 if (!PyAnySet_Check(anyset)) {
2258 PyErr_BadInternalCall();
2259 return -1;
2260 }
Raymond Hettinger9c1491f2005-08-24 00:24:40 +00002261 return PySet_GET_SIZE(anyset);
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002262}
2263
2264int
Barry Warsaw176014f2006-03-30 22:45:35 +00002265PySet_Clear(PyObject *set)
2266{
Raymond Hettinger7759a0c2008-01-28 21:47:42 +00002267 if (!PySet_Check(set)) {
Barry Warsaw176014f2006-03-30 22:45:35 +00002268 PyErr_BadInternalCall();
2269 return -1;
2270 }
2271 return set_clear_internal((PySetObject *)set);
2272}
2273
2274int
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002275PySet_Contains(PyObject *anyset, PyObject *key)
2276{
2277 if (!PyAnySet_Check(anyset)) {
2278 PyErr_BadInternalCall();
2279 return -1;
2280 }
2281 return set_contains_key((PySetObject *)anyset, key);
2282}
2283
2284int
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002285PySet_Discard(PyObject *set, PyObject *key)
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002286{
Raymond Hettinger7759a0c2008-01-28 21:47:42 +00002287 if (!PySet_Check(set)) {
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002288 PyErr_BadInternalCall();
2289 return -1;
2290 }
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002291 return set_discard_key((PySetObject *)set, key);
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002292}
2293
2294int
Raymond Hettingerecdcb582008-01-28 20:34:33 +00002295PySet_Add(PyObject *anyset, PyObject *key)
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002296{
Amaury Forgeot d'Arccab3d982008-02-03 22:51:43 +00002297 if (!PySet_Check(anyset) &&
2298 (!PyFrozenSet_Check(anyset) || Py_REFCNT(anyset) != 1)) {
Raymond Hettingerdee3f652008-01-26 09:31:11 +00002299 PyErr_BadInternalCall();
2300 return -1;
2301 }
Raymond Hettingerecdcb582008-01-28 20:34:33 +00002302 return set_add_key((PySetObject *)anyset, key);
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002303}
2304
Barry Warsaw176014f2006-03-30 22:45:35 +00002305int
Raymond Hettinger0bbbfc42007-03-20 21:27:24 +00002306_PySet_Next(PyObject *set, Py_ssize_t *pos, PyObject **key)
Barry Warsaw176014f2006-03-30 22:45:35 +00002307{
2308 setentry *entry_ptr;
2309
2310 if (!PyAnySet_Check(set)) {
2311 PyErr_BadInternalCall();
2312 return -1;
2313 }
2314 if (set_next((PySetObject *)set, pos, &entry_ptr) == 0)
2315 return 0;
Raymond Hettinger0bbbfc42007-03-20 21:27:24 +00002316 *key = entry_ptr->key;
2317 return 1;
2318}
2319
2320int
2321_PySet_NextEntry(PyObject *set, Py_ssize_t *pos, PyObject **key, long *hash)
2322{
2323 setentry *entry;
2324
2325 if (!PyAnySet_Check(set)) {
2326 PyErr_BadInternalCall();
2327 return -1;
2328 }
2329 if (set_next((PySetObject *)set, pos, &entry) == 0)
2330 return 0;
2331 *key = entry->key;
2332 *hash = entry->hash;
Barry Warsaw176014f2006-03-30 22:45:35 +00002333 return 1;
2334}
2335
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002336PyObject *
2337PySet_Pop(PyObject *set)
2338{
Raymond Hettinger7759a0c2008-01-28 21:47:42 +00002339 if (!PySet_Check(set)) {
Raymond Hettingerbeb31012005-08-16 03:47:52 +00002340 PyErr_BadInternalCall();
2341 return NULL;
2342 }
2343 return set_pop((PySetObject *)set);
2344}
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002345
Barry Warsaw176014f2006-03-30 22:45:35 +00002346int
2347_PySet_Update(PyObject *set, PyObject *iterable)
2348{
Raymond Hettinger7759a0c2008-01-28 21:47:42 +00002349 if (!PySet_Check(set)) {
Barry Warsaw176014f2006-03-30 22:45:35 +00002350 PyErr_BadInternalCall();
2351 return -1;
2352 }
2353 return set_update_internal((PySetObject *)set, iterable);
2354}
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002355
2356#ifdef Py_DEBUG
2357
2358/* Test code to be called with any three element set.
2359 Returns True and original set is restored. */
2360
2361#define assertRaises(call_return_value, exception) \
2362 do { \
2363 assert(call_return_value); \
2364 assert(PyErr_ExceptionMatches(exception)); \
2365 PyErr_Clear(); \
2366 } while(0)
2367
2368static PyObject *
2369test_c_api(PySetObject *so)
2370{
Neal Norwitz0f2783c2006-06-19 05:40:44 +00002371 Py_ssize_t count;
Barry Warsaw176014f2006-03-30 22:45:35 +00002372 char *s;
2373 Py_ssize_t i;
Guido van Rossum360496d2007-05-10 17:20:15 +00002374 PyObject *elem=NULL, *dup=NULL, *t, *f, *dup2, *x;
Barry Warsaw176014f2006-03-30 22:45:35 +00002375 PyObject *ob = (PyObject *)so;
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002376
2377 /* Verify preconditions and exercise type/size checks */
2378 assert(PyAnySet_Check(ob));
2379 assert(PyAnySet_CheckExact(ob));
2380 assert(!PyFrozenSet_CheckExact(ob));
2381 assert(PySet_Size(ob) == 3);
2382 assert(PySet_GET_SIZE(ob) == 3);
2383
2384 /* Raise TypeError for non-iterable constructor arguments */
2385 assertRaises(PySet_New(Py_None) == NULL, PyExc_TypeError);
2386 assertRaises(PyFrozenSet_New(Py_None) == NULL, PyExc_TypeError);
2387
2388 /* Raise TypeError for unhashable key */
2389 dup = PySet_New(ob);
2390 assertRaises(PySet_Discard(ob, dup) == -1, PyExc_TypeError);
2391 assertRaises(PySet_Contains(ob, dup) == -1, PyExc_TypeError);
2392 assertRaises(PySet_Add(ob, dup) == -1, PyExc_TypeError);
2393
2394 /* Exercise successful pop, contains, add, and discard */
2395 elem = PySet_Pop(ob);
2396 assert(PySet_Contains(ob, elem) == 0);
2397 assert(PySet_GET_SIZE(ob) == 2);
2398 assert(PySet_Add(ob, elem) == 0);
2399 assert(PySet_Contains(ob, elem) == 1);
2400 assert(PySet_GET_SIZE(ob) == 3);
2401 assert(PySet_Discard(ob, elem) == 1);
2402 assert(PySet_GET_SIZE(ob) == 2);
2403 assert(PySet_Discard(ob, elem) == 0);
2404 assert(PySet_GET_SIZE(ob) == 2);
2405
Barry Warsaw176014f2006-03-30 22:45:35 +00002406 /* Exercise clear */
2407 dup2 = PySet_New(dup);
2408 assert(PySet_Clear(dup2) == 0);
2409 assert(PySet_Size(dup2) == 0);
2410 Py_DECREF(dup2);
2411
2412 /* Raise SystemError on clear or update of frozen set */
2413 f = PyFrozenSet_New(dup);
2414 assertRaises(PySet_Clear(f) == -1, PyExc_SystemError);
2415 assertRaises(_PySet_Update(f, dup) == -1, PyExc_SystemError);
Amaury Forgeot d'Arccab3d982008-02-03 22:51:43 +00002416 assert(PySet_Add(f, elem) == 0);
2417 Py_INCREF(f);
2418 assertRaises(PySet_Add(f, elem) == -1, PyExc_SystemError);
2419 Py_DECREF(f);
Barry Warsaw176014f2006-03-30 22:45:35 +00002420 Py_DECREF(f);
2421
2422 /* Exercise direct iteration */
2423 i = 0, count = 0;
Guido van Rossum360496d2007-05-10 17:20:15 +00002424 while (_PySet_Next((PyObject *)dup, &i, &x)) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002425 s = PyString_AsString(x);
Barry Warsaw176014f2006-03-30 22:45:35 +00002426 assert(s && (s[0] == 'a' || s[0] == 'b' || s[0] == 'c'));
2427 count++;
2428 }
2429 assert(count == 3);
2430
2431 /* Exercise updates */
2432 dup2 = PySet_New(NULL);
2433 assert(_PySet_Update(dup2, dup) == 0);
2434 assert(PySet_Size(dup2) == 3);
2435 assert(_PySet_Update(dup2, dup) == 0);
2436 assert(PySet_Size(dup2) == 3);
2437 Py_DECREF(dup2);
2438
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002439 /* Raise SystemError when self argument is not a set or frozenset. */
2440 t = PyTuple_New(0);
2441 assertRaises(PySet_Size(t) == -1, PyExc_SystemError);
2442 assertRaises(PySet_Contains(t, elem) == -1, PyExc_SystemError);
2443 Py_DECREF(t);
2444
2445 /* Raise SystemError when self argument is not a set. */
2446 f = PyFrozenSet_New(dup);
2447 assert(PySet_Size(f) == 3);
2448 assert(PyFrozenSet_CheckExact(f));
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002449 assertRaises(PySet_Discard(f, elem) == -1, PyExc_SystemError);
2450 assertRaises(PySet_Pop(f) == NULL, PyExc_SystemError);
2451 Py_DECREF(f);
2452
2453 /* Raise KeyError when popping from an empty set */
Raymond Hettingerd8e13382005-08-17 12:27:17 +00002454 assert(PyNumber_InPlaceSubtract(ob, ob) == ob);
2455 Py_DECREF(ob);
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002456 assert(PySet_GET_SIZE(ob) == 0);
2457 assertRaises(PySet_Pop(ob) == NULL, PyExc_KeyError);
2458
Raymond Hettingerd8e13382005-08-17 12:27:17 +00002459 /* Restore the set from the copy using the PyNumber API */
2460 assert(PyNumber_InPlaceOr(ob, dup) == ob);
2461 Py_DECREF(ob);
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002462
2463 /* Verify constructors accept NULL arguments */
2464 f = PySet_New(NULL);
2465 assert(f != NULL);
2466 assert(PySet_GET_SIZE(f) == 0);
2467 Py_DECREF(f);
2468 f = PyFrozenSet_New(NULL);
2469 assert(f != NULL);
2470 assert(PyFrozenSet_CheckExact(f));
2471 assert(PySet_GET_SIZE(f) == 0);
2472 Py_DECREF(f);
2473
2474 Py_DECREF(elem);
2475 Py_DECREF(dup);
2476 Py_RETURN_TRUE;
2477}
2478
Raymond Hettinger9bda1d62005-09-16 07:14:21 +00002479#undef assertRaises
2480
Raymond Hettingerc47e01d2005-08-16 10:44:15 +00002481#endif