hashset.c 16.3 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
87

#ifdef DO_REHASH
#define HashSetEntry                   ValueType
#define EntrySetHash(entry,new_hash)
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
98
99

#ifndef Alloc
#include "xmalloc.h"
#define Alloc(size)    (HashSetEntry*) xmalloc((size) * sizeof(HashSetEntry))
#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
146
147
148
149
150
#ifndef SetRangeEmpty
#define SetRangeEmpty(ptr,size)                \
{                                              \
	size_t _i;                                 \
	size_t _size = (size);                     \
	HashSetEntry *entries = (ptr);             \
	for(_i = 0; _i < _size; ++_i) {            \
		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
195
196
197
198
199
200
201
202
203
204
205
206
207
#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
#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

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

/**
 * 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
 */
Andreas Schösser's avatar
Andreas Schösser committed
219
static INLINE
220
InsertReturnValue insert_nogrow(HashSet *self, KeyType key)
Matthias Braun's avatar
Matthias Braun committed
221
{
Matthias Braun's avatar
Matthias Braun committed
222
223
224
225
226
227
	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
228
229
230
231

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

	while(1) {
232
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
233
234
235
236
237
238
239
240
241
242
243

		if(EntryIsEmpty(*entry)) {
			size_t p;
			HashSetEntry *nentry;

			if(insert_pos != ILLEGAL_POS) {
				p = insert_pos;
			} else {
				p = bucknum;
			}

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

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

/**
 * 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
 */
static
272
void insert_new(HashSet *self, unsigned hash, ValueType value)
Matthias Braun's avatar
Matthias Braun committed
273
{
Matthias Braun's avatar
Matthias Braun committed
274
	size_t num_probes  = 0;
275
	size_t num_buckets = self->num_buckets;
Matthias Braun's avatar
Matthias Braun committed
276
277
278
	size_t hashmask    = num_buckets - 1;
	size_t bucknum     = hash & hashmask;
	size_t insert_pos  = ILLEGAL_POS;
Matthias Braun's avatar
Matthias Braun committed
279

Matthias Braun's avatar
Matthias Braun committed
280
	//assert(value != NullValue);
Matthias Braun's avatar
Matthias Braun committed
281
282

	while(1) {
283
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
284
285

		if(EntryIsEmpty(*entry)) {
286
			size_t        p;
Matthias Braun's avatar
Matthias Braun committed
287
288
289
290
291
292
293
			HashSetEntry *nentry;

			if(insert_pos != ILLEGAL_POS) {
				p = insert_pos;
			} else {
				p = bucknum;
			}
294
			nentry = &self->entries[p];
Matthias Braun's avatar
Matthias Braun committed
295
296
297

			EntryGetValue(*nentry) = value;
			EntrySetHash(*nentry, hash);
298
			self->num_elements++;
Matthias Braun's avatar
Matthias Braun committed
299
300
301
302
303
304
305
306
307
308
309
310
311
312
			return;
		}
		assert(!EntryIsDeleted(*entry));

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

/**
 * calculate shrink and enlarge limits
 * @internal
 */
Andreas Schösser's avatar
Andreas Schösser committed
313
static INLINE
314
void reset_thresholds(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
315
{
316
	self->enlarge_threshold = (size_t) HT_OCCUPANCY_FLT(self->num_buckets);
Matthias Braun's avatar
Matthias Braun committed
317
318
	self->shrink_threshold  = (size_t) HT_EMPTY_FLT(self->num_buckets);
	self->consider_shrink   = 0;
Matthias Braun's avatar
Matthias Braun committed
319
320
321
322
323
324
}

/**
 * Resize the hashset
 * @internal
 */
Andreas Schösser's avatar
Andreas Schösser committed
325
static INLINE
326
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
348
349
350
351
352

	/* reinsert all elements */
	for(i = 0; i < num_buckets; ++i) {
		HashSetEntry *entry = & old_entries[i];
		if(EntryIsEmpty(*entry) || EntryIsDeleted(*entry))
			continue;

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

	/* now we can free the old array */
	Free(old_entries);
}

/**
 * grow the hashset if adding 1 more elements would make it too crowded
 * @internal
 */
Andreas Schösser's avatar
Andreas Schösser committed
364
static INLINE
365
void maybe_grow(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
366
367
368
{
	size_t resize_to;

369
	if(LIKELY(self->num_elements + 1 <= self->enlarge_threshold))
Matthias Braun's avatar
Matthias Braun committed
370
371
372
		return;

	/* double table size */
373
374
	resize_to = self->num_buckets * 2;
	resize(self, resize_to);
Matthias Braun's avatar
Matthias Braun committed
375
376
377
378
379
380
}

/**
 * shrink the hashset if it is only sparsely filled
 * @internal
 */
Andreas Schösser's avatar
Andreas Schösser committed
381
static INLINE
382
void maybe_shrink(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
383
384
385
386
{
	size_t size;
	size_t resize_to;

387
	if(!self->consider_shrink)
Matthias Braun's avatar
Matthias Braun committed
388
389
		return;

390
	self->consider_shrink = 0;
391
	size                  = hashset_size(self);
392
393
394
	if(size <= HT_MIN_BUCKETS)
		return;

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

	resize_to = ceil_po2(size);

	if(resize_to < 4)
		resize_to = 4;

403
	resize(self, resize_to);
Matthias Braun's avatar
Matthias Braun committed
404
405
406
407
408
409
410
411
}

/**
 * Insert an element into the hashset. If no element with key key exists yet,
 * then a new one is created and initialized with the InitData function.
 * Otherwise the exisiting element is returned (for hashs where key is equal to
 * value, nothing is returned.)
 *
412
 * @param self   the hashset
Matthias Braun's avatar
Matthias Braun committed
413
414
415
 * @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)
 */
416
InsertReturnValue hashset_insert(HashSet *self, KeyType key)
Matthias Braun's avatar
Matthias Braun committed
417
418
{
#ifndef NDEBUG
419
	self->entries_version++;
Matthias Braun's avatar
Matthias Braun committed
420
421
#endif

422
423
424
	maybe_shrink(self);
	maybe_grow(self);
	return insert_nogrow(self, key);
Matthias Braun's avatar
Matthias Braun committed
425
426
427
428
429
}

/**
 * Searchs for an element with key @p key.
 *
430
 * @param self      the hashset
Matthias Braun's avatar
Matthias Braun committed
431
432
433
 * @param key       the key to search for
 * @returns         the found value or NullValue if nothing was found
 */
Matthias Braun's avatar
Matthias Braun committed
434
InsertReturnValue hashset_find(const HashSet *self, ConstKeyType key)
Matthias Braun's avatar
Matthias Braun committed
435
{
Matthias Braun's avatar
Matthias Braun committed
436
437
438
439
440
	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
441
442

	while(1) {
443
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
444
445

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

		++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.
 *
467
 * @param self    the hashset
Matthias Braun's avatar
Matthias Braun committed
468
469
 * @param key     key that identifies the data to remove
 */
470
void hashset_remove(HashSet *self, ConstKeyType key)
Matthias Braun's avatar
Matthias Braun committed
471
{
Matthias Braun's avatar
Matthias Braun committed
472
473
474
475
476
	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
477
478

#ifndef NDEBUG
479
	self->entries_version++;
Matthias Braun's avatar
Matthias Braun committed
480
481
482
#endif

	while(1) {
483
		HashSetEntry *entry = & self->entries[bucknum];
Matthias Braun's avatar
Matthias Braun committed
484
485
486
487
488
489

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

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

/**
 * Initializes hashset with a specific size
 * @internal
 */
Andreas Schösser's avatar
Andreas Schösser committed
509
static INLINE
510
void init_size(HashSet *self, size_t initial_size)
Matthias Braun's avatar
Matthias Braun committed
511
512
513
514
{
	if(initial_size < 4)
		initial_size = 4;

Matthias Braun's avatar
Matthias Braun committed
515
	self->entries         = Alloc(initial_size);
516
	SetRangeEmpty(self->entries, initial_size);
Matthias Braun's avatar
Matthias Braun committed
517
	self->num_buckets     = initial_size;
518
	self->consider_shrink = 0;
Matthias Braun's avatar
Matthias Braun committed
519
520
	self->num_elements    = 0;
	self->num_deleted     = 0;
Matthias Braun's avatar
Matthias Braun committed
521
#ifndef NDEBUG
522
	self->entries_version = 0;
Matthias Braun's avatar
Matthias Braun committed
523
524
#endif

525
	reset_thresholds(self);
Matthias Braun's avatar
Matthias Braun committed
526
527
528
529
530
531
}

/**
 * Initialializes a hashset with the default size. The memory for the set has to
 * already allocated.
 */
532
void hashset_init(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
533
{
534
	init_size(self, HT_MIN_BUCKETS);
Matthias Braun's avatar
Matthias Braun committed
535
536
537
538
539
540
}

/**
 * Destroys a hashset, freeing all used memory (except the memory for the
 * HashSet struct itself).
 */
541
void hashset_destroy(HashSet *self)
Matthias Braun's avatar
Matthias Braun committed
542
{
543
	Free(self->entries);
Matthias Braun's avatar
Matthias Braun committed
544
#ifndef NDEBUG
545
	self->entries = NULL;
Matthias Braun's avatar
Matthias Braun committed
546
547
548
549
550
551
#endif
}

/**
 * Initializes a hashset expecting expected_element size
 */
552
void hashset_init_size(HashSet *self, size_t expected_elements)
Matthias Braun's avatar
Matthias Braun committed
553
554
555
556
557
558
559
560
{
	size_t needed_size;
	size_t po2size;

	if(expected_elements >= UINT_MAX/2) {
		abort();
	}

561
	needed_size = expected_elements * HT_1_DIV_OCCUPANCY_FLT;
Matthias Braun's avatar
Matthias Braun committed
562
	po2size     = ceil_po2(needed_size);
563
	init_size(self, po2size);
Matthias Braun's avatar
Matthias Braun committed
564
565
566
567
568
569
570
}

/**
 * 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
 */
571
void hashset_iterator_init(HashSetIterator *self, const HashSet *hashset)
Matthias Braun's avatar
Matthias Braun committed
572
{
573
	self->current_bucket = hashset->entries - 1;
Matthias Braun's avatar
Matthias Braun committed
574
	self->end            = hashset->entries + hashset->num_buckets;
Matthias Braun's avatar
Matthias Braun committed
575
#ifndef NDEBUG
Matthias Braun's avatar
Matthias Braun committed
576
	self->set             = hashset;
577
	self->entries_version = hashset->entries_version;
Matthias Braun's avatar
Matthias Braun committed
578
579
580
581
582
583
584
585
#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
 */
586
ValueType hashset_iterator_next(HashSetIterator *self)
Matthias Braun's avatar
Matthias Braun committed
587
{
588
	HashSetEntry *current_bucket = self->current_bucket;
Matthias Braun's avatar
Matthias Braun committed
589
	HashSetEntry *end            = self->end;
Matthias Braun's avatar
Matthias Braun committed
590
591

	/* using hashset_insert or hashset_remove is not allowed while iterating */
592
	assert(self->entries_version == self->set->entries_version);
Matthias Braun's avatar
Matthias Braun committed
593
594
595

	do {
		current_bucket++;
596
597
598
		if(current_bucket >= end)
			return NullValue;
	} while(EntryIsEmpty(*current_bucket) || EntryIsDeleted(*current_bucket));
Matthias Braun's avatar
Matthias Braun committed
599

600
	self->current_bucket = current_bucket;
Matthias Braun's avatar
Matthias Braun committed
601
602
603
604
605
606
607
	return EntryGetValue(*current_bucket);
}

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

	/* iterator_next needs to have been called at least once */
613
	assert(entry >= self->entries);
Matthias Braun's avatar
Matthias Braun committed
614
	/* needs to be on a valid element */
615
	assert(entry < self->entries + self->num_buckets);
Matthias Braun's avatar
Matthias Braun committed
616
617
618
619
620

	if(EntryIsDeleted(*entry))
		return;

	EntrySetDeleted(*entry);
621
622
	self->num_deleted++;
	self->consider_shrink = 1;
Matthias Braun's avatar
Matthias Braun committed
623
624
625
}

#endif