hashset.c 16.7 KB
Newer Older
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Matthias Braun's avatar
Matthias Braun committed
20
21
/**
 * @file
22
 * @brief   Generic hashset implementation
Matthias Braun's avatar
Matthias Braun committed
23
24
 * @author  Matthias Braun, inspiration from densehash from google sparsehash
 *          package
25
 * @date    17.03.2007
Matthias Braun's avatar
Matthias Braun committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 * @version $Id$
 *
 *
 * You have to specialize this file by defining:
 *
 * <ul>
 *  <li><b>HashSet</b>         The name of the hashset type</li>
 *  <li><b>HashSetIterator</b> The name of the hashset iterator type</li>
 *  <li><b>ValueType</b>       The type of the stored data values</li>
 *  <li><b>NullValue</b>       A special value representing no values</li>
 *  <li><b>DeletedValue</b>    A special value representing deleted entries</li>
 *  <li><b>Hash(hashset,key)</b> calculates the hash value for a given key</li>
 * </ul>
 *
 * Note that by default it is assumed that the data values themselfes are used
 * as keys. However you can change that with additional defines:
 *
 * <ul>
 *  <li><b>KeyType</b>         The type of the keys identifying data values.
 *                             Defining this implies, that a data value contains
 *                             more than just the key.</li>
 *  <li><b>GetKey(value)</b>   Extracts the key from a data value</li>
 *  <li><b>KeysEqual(hashset,key1,key2)</b>  Tests wether 2 keys are equal</li>
 *  <li><b>DO_REHASH</b>       Instead of storing the hash-values, recalculate
 *                             them on demand from the datavalues. (usefull if
 *                             calculating the hash-values takes less time than
 *                             a memory access)</li>
 * </ul>
 *
 * You can further fine tune your hashset by defining the following:
 *
 * <ul>
 *  <li><b>JUMP(num_probes)</b> The probing method</li>
 *  <li><b>Alloc(count)</b>     Allocates count hashset entries (NOT bytes)</li>
 *  <li><b>Free(ptr)</b>        Frees a block of memory allocated by Alloc</li>
 *  <li><b>SetRangeEmpty(ptr,count)</b> Efficiently sets a range of elements to
 *                                      the Null value</li>
 *  <li><b>ADDITIONAL_DATA<b>   Additional fields appended to the hashset struct</li>
 * </ul>
 */
#ifdef HashSet

#include <stdlib.h>
#include <string.h>
#include <assert.h>

#include "bitfiddle.h"
#include "util.h"

/* quadratic probing */
#ifndef JUMP
#define JUMP(num_probes)      (num_probes)
Christian Würdig's avatar
Christian Würdig committed
78
#endif /* JUMP */
Matthias Braun's avatar
Matthias Braun committed
79
80
81

#ifndef Hash
#define ID_HASH
Michael Beck's avatar
Michael Beck committed
82
#define Hash(self,key)        ((unsigned)(((char *)key) - (char *)0))
Christian Würdig's avatar
Christian Würdig committed
83
#endif /* Hash */
Matthias Braun's avatar
Matthias Braun committed
84
85
86

#ifdef DO_REHASH
#define HashSetEntry                   ValueType
87
#define EntrySetHash(entry,new_hash)   (void)0
Matthias Braun's avatar
Matthias Braun committed
88
#define EntryGetHash(self,entry)       Hash(self, GetKey(entry))
Matthias Braun's avatar
Matthias Braun committed
89
#define EntryGetValue(entry)           (entry)
Christian Würdig's avatar
Christian Würdig committed
90
#else /* ! DO_REHASH */
91
#define EntryGetHash(self,entry)       (entry).hash
Matthias Braun's avatar
Matthias Braun committed
92
93
#define EntrySetHash(entry,new_hash)   (entry).hash = (new_hash)
#define EntryGetValue(entry)           (entry).data
Christian Würdig's avatar
Christian Würdig committed
94
#endif /* DO_REHASH */
Matthias Braun's avatar
Matthias Braun committed
95
96
97

#ifndef Alloc
#include "xmalloc.h"
98
#define Alloc(size) XMALLOCN(HashSetEntry, (size))
Matthias Braun's avatar
Matthias Braun committed
99
#define Free(ptr)      free(ptr)
Christian Würdig's avatar
Christian Würdig committed
100
#endif /* Alloc */
Matthias Braun's avatar
Matthias Braun committed
101
102

#ifdef ID_HASH
Matthias Braun's avatar
Matthias Braun committed
103
104
105
#define InsertReturnValue                 int
#define GetInsertReturnValue(entry,found) (found)
#define NullReturnValue                   0
Christian Würdig's avatar
Christian Würdig committed
106
#else /* ! ID_HASH */
Matthias Braun's avatar
Matthias Braun committed
107
108
109
110
111
112
113
114
115
#ifdef SCALAR_RETURN
#define InsertReturnValue                 ValueType
#define GetInsertReturnValue(entry,found) EntryGetValue(entry)
#define NullReturnValue                   NullValue
#else
#define InsertReturnValue                 ValueType*
#define GetInsertReturnValue(entry,found) & EntryGetValue(entry)
#define NullReturnValue                   & NullValue
#endif
Christian Würdig's avatar
Christian Würdig committed
116
#endif /* ID_HASH */
Matthias Braun's avatar
Matthias Braun committed
117
118
119
120

#ifndef KeyType
#define KeyType                  ValueType
#define GetKey(value)            (value)
121
#define InitData(self,value,key) (value) = (key)
Christian Würdig's avatar
Christian Würdig committed
122
#endif /* KeyType */
Matthias Braun's avatar
Matthias Braun committed
123
124
125

#ifndef ConstKeyType
#define ConstKeyType             const KeyType
Christian Würdig's avatar
Christian Würdig committed
126
#endif /* ConstKeyType */
Matthias Braun's avatar
Matthias Braun committed
127
128
129

#ifndef EntrySetEmpty
#define EntrySetEmpty(entry)    EntryGetValue(entry) = NullValue
Christian Würdig's avatar
Christian Würdig committed
130
#endif /* EntrySetEmpty */
Matthias Braun's avatar
Matthias Braun committed
131
132
#ifndef EntrySetDeleted
#define EntrySetDeleted(entry)  EntryGetValue(entry) = DeletedValue
Christian Würdig's avatar
Christian Würdig committed
133
#endif /* EntrySetDeleted */
Matthias Braun's avatar
Matthias Braun committed
134
135
#ifndef EntryIsEmpty
#define EntryIsEmpty(entry)     (EntryGetValue(entry) == NullValue)
Christian Würdig's avatar
Christian Würdig committed
136
#endif /* EntryIsEmpty */
Matthias Braun's avatar
Matthias Braun committed
137
138
#ifndef EntryIsDeleted
#define EntryIsDeleted(entry)   (EntryGetValue(entry) == DeletedValue)
Christian Würdig's avatar
Christian Würdig committed
139
#endif /* EntryIsDeleted */
Matthias Braun's avatar
Matthias Braun committed
140
141
142
143
144
145
#ifndef SetRangeEmpty
#define SetRangeEmpty(ptr,size)                \
{                                              \
	size_t _i;                                 \
	size_t _size = (size);                     \
	HashSetEntry *entries = (ptr);             \
146
	for (_i = 0; _i < _size; ++_i) {            \
Matthias Braun's avatar
Matthias Braun committed
147
148
149
150
		HashSetEntry *entry = & entries[_i];   \
		EntrySetEmpty(*entry);                 \
	}                                          \
}
Christian Würdig's avatar
Christian Würdig committed
151
#endif /* SetRangeEmpty */
Matthias Braun's avatar
Matthias Braun committed
152
153
154

#ifndef HT_OCCUPANCY_FLT
/** how full before we double size */
155
#define HT_OCCUPANCY_FLT(x) ((x)/2)
Christian Würdig's avatar
Christian Würdig committed
156
#endif /* HT_OCCUPANCY_FLT */
157
158
159
#ifndef HT_1_DIV_OCCUPANCY_FLT
#define HT_1_DIV_OCCUPANCY_FLT 2
#endif
Matthias Braun's avatar
Matthias Braun committed
160
161
162

#ifndef HT_EMPTY_FLT
/** how empty before we half size */
163
#define HT_EMPTY_FLT(x)     ((x)/5)
Christian Würdig's avatar
Christian Würdig committed
164
#endif /* HT_EMPTY_FLT */
Matthias Braun's avatar
Matthias Braun committed
165
166
167
168

#ifndef HT_MIN_BUCKETS
/** default smallest bucket size */
#define HT_MIN_BUCKETS    32
Christian Würdig's avatar
Christian Würdig committed
169
#endif /* HT_MIN_BUCKETS */
Matthias Braun's avatar
Matthias Braun committed
170
171
172

#define ILLEGAL_POS       ((size_t)-1)

Christian Würdig's avatar
Christian Würdig committed
173
/* check that all needed functions are defined */
Matthias Braun's avatar
Matthias Braun committed
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
#ifndef hashset_init
#error You have to redefine hashset_init
#endif
#ifndef hashset_init_size
#error You have to redefine hashset_init_size
#endif
#ifndef hashset_destroy
#error You have to redefine hashset_destroy
#endif
#ifndef hashset_insert
#error You have to redefine hashset_insert
#endif
#ifndef hashset_remove
#error You have to redefine hashset_remove
#endif
#ifndef hashset_find
#error You have to redefine hashset_find
#endif
#ifndef hashset_size
#error You have to redefine hashset_size
#endif
Michael Beck's avatar
Michael Beck committed
195
196

#ifndef NO_ITERATOR
Matthias Braun's avatar
Matthias Braun committed
197
198
199
200
201
202
203
204
205
#ifndef hashset_iterator_init
#error You have to redefine hashset_iterator_init
#endif
#ifndef hashset_iterator_next
#error You have to redefine hashset_iterator_next
#endif
#ifndef hashset_remove_iterator
#error You have to redefine hashset_remove_iterator
#endif
Matthias Braun's avatar
Matthias Braun committed
206
#endif
Matthias Braun's avatar
Matthias Braun committed
207
208
209
210

/**
 * Returns the number of elements in the hashset
 */
211
size_t hashset_size(const HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
212
{
213
	return self->num_elements - self->num_deleted;
Matthias Braun's avatar
Matthias Braun committed
214
215
216
217
218
219
220
221
}

/**
 * Inserts an element into a hashset without growing the set (you have to make
 * sure there's enough room for that.
 * @note also see comments for hashset_insert()
 * @internal
 */
222
static inline InsertReturnValue insert_nogrow(HashSet *self, KeyType key)
Matthias Braun's avatar
Matthias Braun committed
223
{
Matthias Braun's avatar
Matthias Braun committed
224
225
226
227
228
229
	size_t   num_probes  = 0;
	size_t   num_buckets = self->num_buckets;
	size_t   hashmask    = num_buckets - 1;
	unsigned hash        = Hash(self, key);
	size_t   bucknum     = hash & hashmask;
	size_t   insert_pos  = ILLEGAL_POS;
Matthias Braun's avatar
Matthias Braun committed
230
231
232

	assert((num_buckets & (num_buckets - 1)) == 0);

233
	for (;;) {
234
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
235

236
		if (EntryIsEmpty(*entry)) {
Matthias Braun's avatar
Matthias Braun committed
237
238
239
			size_t p;
			HashSetEntry *nentry;

240
			if (insert_pos != ILLEGAL_POS) {
Matthias Braun's avatar
Matthias Braun committed
241
242
243
244
245
				p = insert_pos;
			} else {
				p = bucknum;
			}

246
247
			nentry = &self->entries[p];
			InitData(self, EntryGetValue(*nentry), key);
Matthias Braun's avatar
Matthias Braun committed
248
			EntrySetHash(*nentry, hash);
249
			self->num_elements++;
Matthias Braun's avatar
Matthias Braun committed
250
			return GetInsertReturnValue(*nentry, 0);
Matthias Braun's avatar
Matthias Braun committed
251
		}
252
253
		if (EntryIsDeleted(*entry)) {
			if (insert_pos == ILLEGAL_POS)
Matthias Braun's avatar
Matthias Braun committed
254
				insert_pos = bucknum;
255
256
		} else if (EntryGetHash(self, *entry) == hash) {
			if (KeysEqual(self, GetKey(EntryGetValue(*entry)), key)) {
Matthias Braun's avatar
Matthias Braun committed
257
				// Value already in the set, return it
Matthias Braun's avatar
Matthias Braun committed
258
				return GetInsertReturnValue(*entry, 1);
Matthias Braun's avatar
Matthias Braun committed
259
260
261
262
263
264
265
266
267
			}
		}

		++num_probes;
		bucknum = (bucknum + JUMP(num_probes)) & hashmask;
		assert(num_probes < num_buckets);
	}
}

Michael Beck's avatar
Michael Beck committed
268
269
270
271
/**
 * calculate shrink and enlarge limits
 * @internal
 */
272
static inline void reset_thresholds(HashSet *self)
Michael Beck's avatar
Michael Beck committed
273
274
275
276
277
278
279
{
	self->enlarge_threshold = (size_t) HT_OCCUPANCY_FLT(self->num_buckets);
	self->shrink_threshold  = (size_t) HT_EMPTY_FLT(self->num_buckets);
	self->consider_shrink   = 0;
}

#ifndef HAVE_OWN_RESIZE
Matthias Braun's avatar
Matthias Braun committed
280
281
282
283
284
/**
 * Inserts an element into a hashset under the assumption that the hashset
 * contains no deleted entries and the element doesn't exist in the hashset yet.
 * @internal
 */
285
static void insert_new(HashSet *self, unsigned hash, ValueType value)
Matthias Braun's avatar
Matthias Braun committed
286
{
Matthias Braun's avatar
Matthias Braun committed
287
	size_t num_probes  = 0;
288
	size_t num_buckets = self->num_buckets;
Matthias Braun's avatar
Matthias Braun committed
289
290
291
	size_t hashmask    = num_buckets - 1;
	size_t bucknum     = hash & hashmask;
	size_t insert_pos  = ILLEGAL_POS;
Matthias Braun's avatar
Matthias Braun committed
292

Matthias Braun's avatar
Matthias Braun committed
293
	//assert(value != NullValue);
Matthias Braun's avatar
Matthias Braun committed
294

295
	for (;;) {
296
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
297

298
		if (EntryIsEmpty(*entry)) {
299
			size_t        p;
Matthias Braun's avatar
Matthias Braun committed
300
301
			HashSetEntry *nentry;

302
			if (insert_pos != ILLEGAL_POS) {
Matthias Braun's avatar
Matthias Braun committed
303
304
305
306
				p = insert_pos;
			} else {
				p = bucknum;
			}
307
			nentry = &self->entries[p];
Matthias Braun's avatar
Matthias Braun committed
308
309
310

			EntryGetValue(*nentry) = value;
			EntrySetHash(*nentry, hash);
311
			self->num_elements++;
Matthias Braun's avatar
Matthias Braun committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
			return;
		}
		assert(!EntryIsDeleted(*entry));

		++num_probes;
		bucknum = (bucknum + JUMP(num_probes)) & hashmask;
		assert(num_probes < num_buckets);
	}
}

/**
 * Resize the hashset
 * @internal
 */
326
static inline void resize(HashSet *self, size_t new_size)
Matthias Braun's avatar
Matthias Braun committed
327
{
328
	size_t num_buckets = self->num_buckets;
Matthias Braun's avatar
Matthias Braun committed
329
	size_t i;
330
	HashSetEntry *old_entries = self->entries;
Matthias Braun's avatar
Matthias Braun committed
331
332
333
334
335
336
337
	HashSetEntry *new_entries;

	/* allocate a new array with double size */
	new_entries = Alloc(new_size);
	SetRangeEmpty(new_entries, new_size);

	/* use the new array */
Matthias Braun's avatar
Matthias Braun committed
338
339
	self->entries      = new_entries;
	self->num_buckets  = new_size;
340
	self->num_elements = 0;
Matthias Braun's avatar
Matthias Braun committed
341
	self->num_deleted  = 0;
Matthias Braun's avatar
Matthias Braun committed
342
#ifndef NDEBUG
343
	self->entries_version++;
Matthias Braun's avatar
Matthias Braun committed
344
#endif
345
	reset_thresholds(self);
Matthias Braun's avatar
Matthias Braun committed
346
347

	/* reinsert all elements */
348
	for (i = 0; i < num_buckets; ++i) {
Matthias Braun's avatar
Matthias Braun committed
349
		HashSetEntry *entry = & old_entries[i];
350
		if (EntryIsEmpty(*entry) || EntryIsDeleted(*entry))
Matthias Braun's avatar
Matthias Braun committed
351
352
			continue;

353
		insert_new(self, EntryGetHash(self, *entry), EntryGetValue(*entry));
Matthias Braun's avatar
Matthias Braun committed
354
355
356
357
358
	}

	/* now we can free the old array */
	Free(old_entries);
}
359
360
361
#else

/* resize must be defined outside */
362
static inline void resize(HashSet *self, size_t new_size);
363
364

#endif
Matthias Braun's avatar
Matthias Braun committed
365
366
367
368
369

/**
 * grow the hashset if adding 1 more elements would make it too crowded
 * @internal
 */
370
static inline void maybe_grow(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
371
372
373
{
	size_t resize_to;

374
	if (LIKELY(self->num_elements + 1 <= self->enlarge_threshold))
Matthias Braun's avatar
Matthias Braun committed
375
376
377
		return;

	/* double table size */
378
379
	resize_to = self->num_buckets * 2;
	resize(self, resize_to);
Matthias Braun's avatar
Matthias Braun committed
380
381
382
383
384
385
}

/**
 * shrink the hashset if it is only sparsely filled
 * @internal
 */
386
static inline void maybe_shrink(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
387
388
389
390
{
	size_t size;
	size_t resize_to;

391
	if (!self->consider_shrink)
Matthias Braun's avatar
Matthias Braun committed
392
393
		return;

394
	self->consider_shrink = 0;
395
	size                  = hashset_size(self);
396
	if (size <= HT_MIN_BUCKETS)
397
398
		return;

399
	if (LIKELY(size > self->shrink_threshold))
Matthias Braun's avatar
Matthias Braun committed
400
401
402
403
		return;

	resize_to = ceil_po2(size);

404
	if (resize_to < 4)
Matthias Braun's avatar
Matthias Braun committed
405
406
		resize_to = 4;

407
	resize(self, resize_to);
Matthias Braun's avatar
Matthias Braun committed
408
409
410
}

/**
Michael Beck's avatar
Michael Beck committed
411
 * Insert an element into the hashset. If no element with the given key exists yet,
Matthias Braun's avatar
Matthias Braun committed
412
 * then a new one is created and initialized with the InitData function.
Michael Beck's avatar
Michael Beck committed
413
 * Otherwise the existing element is returned (for hashs where key is equal to
Matthias Braun's avatar
Matthias Braun committed
414
415
 * value, nothing is returned.)
 *
416
 * @param self   the hashset
Matthias Braun's avatar
Matthias Braun committed
417
418
419
 * @param key    the key that identifies the data
 * @returns      the existing or newly created data element (or nothing in case of hashs where keys are the while value)
 */
420
InsertReturnValue hashset_insert(HashSet *self, KeyType key)
Matthias Braun's avatar
Matthias Braun committed
421
422
{
#ifndef NDEBUG
423
	self->entries_version++;
Matthias Braun's avatar
Matthias Braun committed
424
425
#endif

426
427
428
	maybe_shrink(self);
	maybe_grow(self);
	return insert_nogrow(self, key);
Matthias Braun's avatar
Matthias Braun committed
429
430
431
}

/**
Michael Beck's avatar
Michael Beck committed
432
 * Searches for an element with key @p key.
Matthias Braun's avatar
Matthias Braun committed
433
 *
434
 * @param self      the hashset
Matthias Braun's avatar
Matthias Braun committed
435
436
437
 * @param key       the key to search for
 * @returns         the found value or NullValue if nothing was found
 */
Matthias Braun's avatar
Matthias Braun committed
438
InsertReturnValue hashset_find(const HashSet *self, ConstKeyType key)
Matthias Braun's avatar
Matthias Braun committed
439
{
Matthias Braun's avatar
Matthias Braun committed
440
441
442
443
444
	size_t   num_probes  = 0;
	size_t   num_buckets = self->num_buckets;
	size_t   hashmask    = num_buckets - 1;
	unsigned hash        = Hash(self, key);
	size_t   bucknum     = hash & hashmask;
Matthias Braun's avatar
Matthias Braun committed
445

446
	for (;;) {
447
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
448

449
		if (EntryIsEmpty(*entry)) {
Matthias Braun's avatar
Matthias Braun committed
450
			return NullReturnValue;
Matthias Braun's avatar
Matthias Braun committed
451
		}
452
		if (EntryIsDeleted(*entry)) {
Matthias Braun's avatar
Matthias Braun committed
453
			// value is deleted
454
455
		} else if (EntryGetHash(self, *entry) == hash) {
			if (KeysEqual(self, GetKey(EntryGetValue(*entry)), key)) {
Matthias Braun's avatar
Matthias Braun committed
456
				// found the value
Matthias Braun's avatar
Matthias Braun committed
457
				return GetInsertReturnValue(*entry, 1);
Matthias Braun's avatar
Matthias Braun committed
458
459
460
461
462
463
464
465
466
467
468
469
470
			}
		}

		++num_probes;
		bucknum = (bucknum + JUMP(num_probes)) & hashmask;
		assert(num_probes < num_buckets);
	}
}

/**
 * Removes an element from a hashset. Does nothing if the set doesn't contain
 * the element.
 *
471
 * @param self    the hashset
Matthias Braun's avatar
Matthias Braun committed
472
473
 * @param key     key that identifies the data to remove
 */
474
void hashset_remove(HashSet *self, ConstKeyType key)
Matthias Braun's avatar
Matthias Braun committed
475
{
Matthias Braun's avatar
Matthias Braun committed
476
477
478
479
480
	size_t   num_probes  = 0;
	size_t   num_buckets = self->num_buckets;
	size_t   hashmask    = num_buckets - 1;
	unsigned hash        = Hash(self, key);
	size_t   bucknum     = hash & hashmask;
Matthias Braun's avatar
Matthias Braun committed
481
482

#ifndef NDEBUG
483
	self->entries_version++;
Matthias Braun's avatar
Matthias Braun committed
484
485
#endif

486
	for (;;) {
487
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
488

489
		if (EntryIsEmpty(*entry)) {
Matthias Braun's avatar
Matthias Braun committed
490
491
			return;
		}
492
		if (EntryIsDeleted(*entry)) {
Matthias Braun's avatar
Matthias Braun committed
493
			// entry is deleted
494
495
		} else if (EntryGetHash(self, *entry) == hash) {
			if (KeysEqual(self, GetKey(EntryGetValue(*entry)), key)) {
Matthias Braun's avatar
Matthias Braun committed
496
				EntrySetDeleted(*entry);
497
498
				self->num_deleted++;
				self->consider_shrink = 1;
Matthias Braun's avatar
Matthias Braun committed
499
500
501
502
503
504
505
506
507
508
509
510
511
512
				return;
			}
		}

		++num_probes;
		bucknum = (bucknum + JUMP(num_probes)) & hashmask;
		assert(num_probes < num_buckets);
	}
}

/**
 * Initializes hashset with a specific size
 * @internal
 */
513
static inline void init_size(HashSet *self, size_t initial_size)
Matthias Braun's avatar
Matthias Braun committed
514
{
515
	if (initial_size < 4)
Matthias Braun's avatar
Matthias Braun committed
516
517
		initial_size = 4;

Matthias Braun's avatar
Matthias Braun committed
518
	self->entries         = Alloc(initial_size);
519
	SetRangeEmpty(self->entries, initial_size);
Matthias Braun's avatar
Matthias Braun committed
520
	self->num_buckets     = initial_size;
521
	self->consider_shrink = 0;
Matthias Braun's avatar
Matthias Braun committed
522
523
	self->num_elements    = 0;
	self->num_deleted     = 0;
Matthias Braun's avatar
Matthias Braun committed
524
#ifndef NDEBUG
525
	self->entries_version = 0;
Matthias Braun's avatar
Matthias Braun committed
526
#endif
Michael Beck's avatar
Michael Beck committed
527
528
529
#ifdef ADDITIONAL_INIT
	ADDITIONAL_INIT
#endif
Matthias Braun's avatar
Matthias Braun committed
530

531
	reset_thresholds(self);
Matthias Braun's avatar
Matthias Braun committed
532
533
534
}

/**
Michael Beck's avatar
Michael Beck committed
535
 * Initializes a hashset with the default size. The memory for the set has to
Matthias Braun's avatar
Matthias Braun committed
536
537
 * already allocated.
 */
538
void hashset_init(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
539
{
540
	init_size(self, HT_MIN_BUCKETS);
Matthias Braun's avatar
Matthias Braun committed
541
542
543
544
545
546
}

/**
 * Destroys a hashset, freeing all used memory (except the memory for the
 * HashSet struct itself).
 */
547
void hashset_destroy(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
548
{
Michael Beck's avatar
Michael Beck committed
549
550
551
#ifdef ADDITIONAL_TERM
	ADDITIONAL_TERM
#endif
552
	Free(self->entries);
Matthias Braun's avatar
Matthias Braun committed
553
#ifndef NDEBUG
554
	self->entries = NULL;
Matthias Braun's avatar
Matthias Braun committed
555
556
557
558
#endif
}

/**
Michael Beck's avatar
Michael Beck committed
559
 * Initializes a hashset expecting expected_element size.
Matthias Braun's avatar
Matthias Braun committed
560
 */
561
void hashset_init_size(HashSet *self, size_t expected_elements)
Matthias Braun's avatar
Matthias Braun committed
562
563
564
565
{
	size_t needed_size;
	size_t po2size;

566
	if (expected_elements >= UINT_MAX/2) {
Matthias Braun's avatar
Matthias Braun committed
567
568
569
		abort();
	}

570
	needed_size = expected_elements * HT_1_DIV_OCCUPANCY_FLT;
Matthias Braun's avatar
Matthias Braun committed
571
	po2size     = ceil_po2(needed_size);
572
	init_size(self, po2size);
Matthias Braun's avatar
Matthias Braun committed
573
574
}

Michael Beck's avatar
Michael Beck committed
575
#ifndef NO_ITERATOR
Matthias Braun's avatar
Matthias Braun committed
576
577
578
579
580
/**
 * Initializes a hashset iterator. The memory for the allocator has to be
 * already allocated.
 * @note it is not allowed to remove or insert elements while iterating
 */
581
void hashset_iterator_init(HashSetIterator *self, const HashSet *hashset)
Matthias Braun's avatar
Matthias Braun committed
582
{
583
	self->current_bucket = hashset->entries - 1;
Matthias Braun's avatar
Matthias Braun committed
584
	self->end            = hashset->entries + hashset->num_buckets;
Matthias Braun's avatar
Matthias Braun committed
585
#ifndef NDEBUG
Matthias Braun's avatar
Matthias Braun committed
586
	self->set             = hashset;
587
	self->entries_version = hashset->entries_version;
Matthias Braun's avatar
Matthias Braun committed
588
589
590
591
592
593
594
595
#endif
}

/**
 * Returns the next value in the iterator or NULL if no value is left
 * in the hashset.
 * @note it is not allowed to remove or insert elements while iterating
 */
596
ValueType hashset_iterator_next(HashSetIterator *self)
Matthias Braun's avatar
Matthias Braun committed
597
{
598
	HashSetEntry *current_bucket = self->current_bucket;
Matthias Braun's avatar
Matthias Braun committed
599
	HashSetEntry *end            = self->end;
Matthias Braun's avatar
Matthias Braun committed
600
601

	/* using hashset_insert or hashset_remove is not allowed while iterating */
602
	assert(self->entries_version == self->set->entries_version);
Matthias Braun's avatar
Matthias Braun committed
603
604
605

	do {
		current_bucket++;
606
		if (current_bucket >= end)
607
			return NullValue;
608
	} while (EntryIsEmpty(*current_bucket) || EntryIsDeleted(*current_bucket));
Matthias Braun's avatar
Matthias Braun committed
609

610
	self->current_bucket = current_bucket;
Matthias Braun's avatar
Matthias Braun committed
611
612
613
614
615
616
617
	return EntryGetValue(*current_bucket);
}

/**
 * Removes the element the iterator points to. Removing an element a second time
 * has no result.
 */
618
void hashset_remove_iterator(HashSet *self, const HashSetIterator *iter)
Matthias Braun's avatar
Matthias Braun committed
619
620
621
622
{
	HashSetEntry *entry = iter->current_bucket;

	/* iterator_next needs to have been called at least once */
623
	assert(entry >= self->entries);
Matthias Braun's avatar
Matthias Braun committed
624
	/* needs to be on a valid element */
625
	assert(entry < self->entries + self->num_buckets);
Matthias Braun's avatar
Matthias Braun committed
626

627
	if (EntryIsDeleted(*entry))
Matthias Braun's avatar
Matthias Braun committed
628
629
630
		return;

	EntrySetDeleted(*entry);
631
632
	self->num_deleted++;
	self->consider_shrink = 1;
Matthias Braun's avatar
Matthias Braun committed
633
}
Michael Beck's avatar
Michael Beck committed
634
#endif /* NO_ITERATOR */
Matthias Braun's avatar
Matthias Braun committed
635

Michael Beck's avatar
Michael Beck committed
636
#endif /* HashSet */