1/* The MIT License
2
3   Copyright (c) 2008, 2009, 2011 by Attractive Chaos <attractor@live.co.uk>
4
5   Permission is hereby granted, free of charge, to any person obtaining
6   a copy of this software and associated documentation files (the
7   "Software"), to deal in the Software without restriction, including
8   without limitation the rights to use, copy, modify, merge, publish,
9   distribute, sublicense, and/or sell copies of the Software, and to
10   permit persons to whom the Software is furnished to do so, subject to
11   the following conditions:
12
13   The above copyright notice and this permission notice shall be
14   included in all copies or substantial portions of the Software.
15
16   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23   SOFTWARE.
24*/
25
26/*
27  An example:
28
29#include "khash.h"
30KHASH_MAP_INIT_INT(32, char)
31int main() {
32	int ret, is_missing;
33	khiter_t k;
34	khash_t(32) *h = kh_init(32);
35	k = kh_put(32, h, 5, &ret);
36	kh_value(h, k) = 10;
37	k = kh_get(32, h, 10);
38	is_missing = (k == kh_end(h));
39	k = kh_get(32, h, 5);
40	kh_del(32, h, k);
41	for (k = kh_begin(h); k != kh_end(h); ++k)
42		if (kh_exist(h, k)) kh_value(h, k) = 1;
43	kh_destroy(32, h);
44	return 0;
45}
46*/
47
48/*
49  2013-05-02 (0.2.8):
50
51	* Use quadratic probing. When the capacity is power of 2, stepping function
52	  i*(i+1)/2 guarantees to traverse each bucket. It is better than double
53	  hashing on cache performance and is more robust than linear probing.
54
55	  In theory, double hashing should be more robust than quadratic probing.
56	  However, my implementation is probably not for large hash tables, because
57	  the second hash function is closely tied to the first hash function,
58	  which reduce the effectiveness of double hashing.
59
60	Reference: http://research.cs.vt.edu/AVresearch/hashing/quadratic.php
61
62  2011-12-29 (0.2.7):
63
64    * Minor code clean up; no actual effect.
65
66  2011-09-16 (0.2.6):
67
68	* The capacity is a power of 2. This seems to dramatically improve the
69	  speed for simple keys. Thank Zilong Tan for the suggestion. Reference:
70
71	   - http://code.google.com/p/ulib/
72	   - http://nothings.org/computer/judy/
73
74	* Allow to optionally use linear probing which usually has better
75	  performance for random input. Double hashing is still the default as it
76	  is more robust to certain non-random input.
77
78	* Added Wang's integer hash function (not used by default). This hash
79	  function is more robust to certain non-random input.
80
81  2011-02-14 (0.2.5):
82
83    * Allow to declare global functions.
84
85  2009-09-26 (0.2.4):
86
87    * Improve portability
88
89  2008-09-19 (0.2.3):
90
91	* Corrected the example
92	* Improved interfaces
93
94  2008-09-11 (0.2.2):
95
96	* Improved speed a little in kh_put()
97
98  2008-09-10 (0.2.1):
99
100	* Added kh_clear()
101	* Fixed a compiling error
102
103  2008-09-02 (0.2.0):
104
105	* Changed to token concatenation which increases flexibility.
106
107  2008-08-31 (0.1.2):
108
109	* Fixed a bug in kh_get(), which has not been tested previously.
110
111  2008-08-31 (0.1.1):
112
113	* Added destructor
114*/
115
116
117#ifndef __AC_KHASH_H
118#define __AC_KHASH_H
119
120/*!
121  @header
122
123  Generic hash table library.
124 */
125
126#define AC_VERSION_KHASH_H "0.2.8"
127
128#include <stdlib.h>
129#include <string.h>
130#include <limits.h>
131
132/* compiler specific configuration */
133
134#if UINT_MAX == 0xffffffffu
135typedef unsigned int khint32_t;
136#elif ULONG_MAX == 0xffffffffu
137typedef unsigned long khint32_t;
138#endif
139
140#if ULONG_MAX == ULLONG_MAX
141typedef unsigned long khint64_t;
142#else
143typedef unsigned long long khint64_t;
144#endif
145
146#ifndef kh_inline
147#ifdef _MSC_VER
148#define kh_inline __inline
149#else
150#define kh_inline inline
151#endif
152#endif /* kh_inline */
153
154#ifndef klib_unused
155#if (defined __clang__ && __clang_major__ >= 3) || (defined __GNUC__ && __GNUC__ >= 3)
156#define klib_unused __attribute__ ((__unused__))
157#else
158#define klib_unused
159#endif
160#endif /* klib_unused */
161
162typedef khint32_t khint_t;
163typedef khint_t khiter_t;
164
165#define __ac_isempty(flag, i) ((flag[i>>4]>>((i&0xfU)<<1))&2)
166#define __ac_isdel(flag, i) ((flag[i>>4]>>((i&0xfU)<<1))&1)
167#define __ac_iseither(flag, i) ((flag[i>>4]>>((i&0xfU)<<1))&3)
168#define __ac_set_isdel_false(flag, i) (flag[i>>4]&=~(1ul<<((i&0xfU)<<1)))
169#define __ac_set_isempty_false(flag, i) (flag[i>>4]&=~(2ul<<((i&0xfU)<<1)))
170#define __ac_set_isboth_false(flag, i) (flag[i>>4]&=~(3ul<<((i&0xfU)<<1)))
171#define __ac_set_isdel_true(flag, i) (flag[i>>4]|=1ul<<((i&0xfU)<<1))
172
173#define __ac_fsize(m) ((m) < 16? 1 : (m)>>4)
174
175#ifndef kroundup32
176#define kroundup32(x) (--(x), (x)|=(x)>>1, (x)|=(x)>>2, (x)|=(x)>>4, (x)|=(x)>>8, (x)|=(x)>>16, ++(x))
177#endif
178
179#ifndef kcalloc
180#define kcalloc(N,Z) calloc(N,Z)
181#endif
182#ifndef kmalloc
183#define kmalloc(Z) malloc(Z)
184#endif
185#ifndef krealloc
186#define krealloc(P,Z) realloc(P,Z)
187#endif
188#ifndef kfree
189#define kfree(P) free(P)
190#endif
191
192/* He we replace an FPU computation FLOOR((x * .77) + 0.5) with FLOOR(((x * 77) + 50)/100).
193 * Implement x/100 with (((x)*1374389535llu)>>37) as 0.01 approximately equals 1374389535/BIT(37).
194 * This allows the computation to be achieved without using an FPU.
195 */
196//static const double __ac_HASH_UPPER = 0.77;
197
198#define DIV_100(num) (((num)*1374389535llu)>>37)
199#define COMPUTE_SIZE(num) DIV_100((num)*77llu + 50)
200
201#define __KHASH_TYPE(name, khkey_t, khval_t) \
202	typedef struct kh_##name##_s { \
203		khint_t n_buckets, size, n_occupied, upper_bound; \
204		khint32_t *flags; \
205		khkey_t *keys; \
206		khval_t *vals; \
207	} kh_##name##_t;
208
209#define __KHASH_PROTOTYPES(name, khkey_t, khval_t)	 					\
210	extern kh_##name##_t *kh_init_##name(void);							\
211	extern void kh_destroy_##name(kh_##name##_t *h);					\
212	extern void kh_clear_##name(kh_##name##_t *h);						\
213	extern khint_t kh_get_##name(const kh_##name##_t *h, khkey_t key); 	\
214	extern int kh_resize_##name(kh_##name##_t *h, khint_t new_n_buckets); \
215	extern khint_t kh_put_##name(kh_##name##_t *h, khkey_t key, int *ret); \
216	extern void kh_del_##name(kh_##name##_t *h, khint_t x);
217
218#define __KHASH_IMPL(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal) \
219	SCOPE kh_##name##_t *kh_init_##name(void) {							\
220		return (kh_##name##_t*)kcalloc(1, sizeof(kh_##name##_t));		\
221	}																	\
222	SCOPE void kh_destroy_##name(kh_##name##_t *h)						\
223	{																	\
224		if (h) {														\
225			kfree((void *)h->keys); kfree(h->flags);					\
226			kfree((void *)h->vals);										\
227			kfree(h);													\
228		}																\
229	}																	\
230	SCOPE void kh_clear_##name(kh_##name##_t *h)						\
231	{																	\
232		if (h && h->flags) {											\
233			memset(h->flags, 0xaa, __ac_fsize(h->n_buckets) * sizeof(khint32_t)); \
234			h->size = h->n_occupied = 0;								\
235		}																\
236	}																	\
237	SCOPE khint_t kh_get_##name(const kh_##name##_t *h, khkey_t key) 	\
238	{																	\
239		if (h->n_buckets) {												\
240			khint_t k, i, last, mask, step = 0; \
241			mask = h->n_buckets - 1;									\
242			k = __hash_func(key); i = k & mask;							\
243			last = i; \
244			while (!__ac_isempty(h->flags, i) && (__ac_isdel(h->flags, i) || !__hash_equal(h->keys[i], key))) { \
245				i = (i + (++step)) & mask; \
246				if (i == last) return h->n_buckets;						\
247			}															\
248			return __ac_iseither(h->flags, i)? h->n_buckets : i;		\
249		} else return 0;												\
250	}																	\
251	SCOPE int kh_resize_##name(kh_##name##_t *h, khint_t new_n_buckets) \
252	{ /* This function uses 0.25*n_buckets bytes of working space instead of [sizeof(key_t+val_t)+.25]*n_buckets. */ \
253		khint32_t *new_flags = 0;										\
254		khint_t j = 1;													\
255		{																\
256			kroundup32(new_n_buckets); 									\
257			if (new_n_buckets < 4) new_n_buckets = 4;					\
258			if (h->size >= (khint_t)(COMPUTE_SIZE(new_n_buckets))) j = 0;	/* requested size is too small */ \
259			else { /* hash table size to be changed (shrink or expand); rehash */ \
260				new_flags = (khint32_t*)kmalloc(__ac_fsize(new_n_buckets) * sizeof(khint32_t));	\
261				if (!new_flags) return -1;								\
262				memset(new_flags, 0xaa, __ac_fsize(new_n_buckets) * sizeof(khint32_t)); \
263				if (h->n_buckets < new_n_buckets) {	/* expand */		\
264					khkey_t *new_keys = (khkey_t*)krealloc((void *)h->keys, new_n_buckets * sizeof(khkey_t)); \
265					if (!new_keys) { kfree(new_flags); return -1; }		\
266					h->keys = new_keys;									\
267					if (kh_is_map) {									\
268						khval_t *new_vals = (khval_t*)krealloc((void *)h->vals, new_n_buckets * sizeof(khval_t)); \
269						if (!new_vals) { kfree(new_flags); return -1; }	\
270						h->vals = new_vals;								\
271					}													\
272				} /* otherwise shrink */								\
273			}															\
274		}																\
275		if (j) { /* rehashing is needed */								\
276			for (j = 0; j != h->n_buckets; ++j) {						\
277				if (__ac_iseither(h->flags, j) == 0) {					\
278					khkey_t key = h->keys[j];							\
279					khval_t val;										\
280					khint_t new_mask;									\
281					new_mask = new_n_buckets - 1; 						\
282					if (kh_is_map) val = h->vals[j];					\
283					__ac_set_isdel_true(h->flags, j);					\
284					while (1) { /* kick-out process; sort of like in Cuckoo hashing */ \
285						khint_t k, i, step = 0; \
286						k = __hash_func(key);							\
287						i = k & new_mask;								\
288						while (!__ac_isempty(new_flags, i)) i = (i + (++step)) & new_mask; \
289						__ac_set_isempty_false(new_flags, i);			\
290						if (i < h->n_buckets && __ac_iseither(h->flags, i) == 0) { /* kick out the existing element */ \
291							{ khkey_t tmp = h->keys[i]; h->keys[i] = key; key = tmp; } \
292							if (kh_is_map) { khval_t tmp = h->vals[i]; h->vals[i] = val; val = tmp; } \
293							__ac_set_isdel_true(h->flags, i); /* mark it as deleted in the old hash table */ \
294						} else { /* write the element and jump out of the loop */ \
295							h->keys[i] = key;							\
296							if (kh_is_map) h->vals[i] = val;			\
297							break;										\
298						}												\
299					}													\
300				}														\
301			}															\
302			if (h->n_buckets > new_n_buckets) { /* shrink the hash table */ \
303				h->keys = (khkey_t*)krealloc((void *)h->keys, new_n_buckets * sizeof(khkey_t)); \
304				if (kh_is_map) h->vals = (khval_t*)krealloc((void *)h->vals, new_n_buckets * sizeof(khval_t)); \
305			}															\
306			kfree(h->flags); /* free the working space */				\
307			h->flags = new_flags;										\
308			h->n_buckets = new_n_buckets;								\
309			h->n_occupied = h->size;									\
310			h->upper_bound = (khint_t)COMPUTE_SIZE(h->n_buckets); \
311		}																\
312		return 0;														\
313	}																	\
314	SCOPE khint_t kh_put_##name(kh_##name##_t *h, khkey_t key, int *ret) \
315	{																	\
316		khint_t x;														\
317		if (h->n_occupied >= h->upper_bound) { /* update the hash table */ \
318			if (h->n_buckets > (h->size<<1)) {							\
319				if (kh_resize_##name(h, h->n_buckets - 1) < 0) { /* clear "deleted" elements */ \
320					*ret = -1; return h->n_buckets;						\
321				}														\
322			} else if (kh_resize_##name(h, h->n_buckets + 1) < 0) { /* expand the hash table */ \
323				*ret = -1; return h->n_buckets;							\
324			}															\
325		} /* TODO: to implement automatically shrinking; resize() already support shrinking */ \
326		{																\
327			khint_t k, i, site, last, mask = h->n_buckets - 1, step = 0; \
328			x = site = h->n_buckets; k = __hash_func(key); i = k & mask; \
329			if (__ac_isempty(h->flags, i)) x = i; /* for speed up */	\
330			else {														\
331				last = i; \
332				while (!__ac_isempty(h->flags, i) && (__ac_isdel(h->flags, i) || !__hash_equal(h->keys[i], key))) { \
333					if (__ac_isdel(h->flags, i)) site = i;				\
334					i = (i + (++step)) & mask; \
335					if (i == last) { x = site; break; }					\
336				}														\
337				if (x == h->n_buckets) {								\
338					if (__ac_isempty(h->flags, i) && site != h->n_buckets) x = site; \
339					else x = i;											\
340				}														\
341			}															\
342		}																\
343		if (__ac_isempty(h->flags, x)) { /* not present at all */		\
344			h->keys[x] = key;											\
345			__ac_set_isboth_false(h->flags, x);							\
346			++h->size; ++h->n_occupied;									\
347			*ret = 1;													\
348		} else if (__ac_isdel(h->flags, x)) { /* deleted */				\
349			h->keys[x] = key;											\
350			__ac_set_isboth_false(h->flags, x);							\
351			++h->size;													\
352			*ret = 2;													\
353		} else *ret = 0; /* Don't touch h->keys[x] if present and not deleted */ \
354		return x;														\
355	}																	\
356	SCOPE void kh_del_##name(kh_##name##_t *h, khint_t x)				\
357	{																	\
358		if (x != h->n_buckets && !__ac_iseither(h->flags, x)) {			\
359			__ac_set_isdel_true(h->flags, x);							\
360			--h->size;													\
361		}																\
362	}
363
364#define KHASH_DECLARE(name, khkey_t, khval_t)		 					\
365	__KHASH_TYPE(name, khkey_t, khval_t) 								\
366	__KHASH_PROTOTYPES(name, khkey_t, khval_t)
367
368#define KHASH_INIT2(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal) \
369	__KHASH_TYPE(name, khkey_t, khval_t) 								\
370	__KHASH_IMPL(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)
371
372#define KHASH_INIT(name, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal) \
373	KHASH_INIT2(name, static kh_inline klib_unused, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)
374
375/* --- BEGIN OF HASH FUNCTIONS --- */
376
377/*! @function
378  @abstract     Integer hash function
379  @param  key   The integer [khint32_t]
380  @return       The hash value [khint_t]
381 */
382#define kh_int_hash_func(key) (khint32_t)(key)
383/*! @function
384  @abstract     Integer comparison function
385 */
386#define kh_int_hash_equal(a, b) ((a) == (b))
387/*! @function
388  @abstract     64-bit integer hash function
389  @param  key   The integer [khint64_t]
390  @return       The hash value [khint_t]
391 */
392#define kh_int64_hash_func(key) (khint32_t)((key)>>33^(key)^(key)<<11)
393/*! @function
394  @abstract     64-bit integer comparison function
395 */
396#define kh_int64_hash_equal(a, b) ((a) == (b))
397/*! @function
398  @abstract     const char* hash function
399  @param  s     Pointer to a null terminated string
400  @return       The hash value
401 */
402static kh_inline khint_t __ac_X31_hash_string(const char *s)
403{
404	khint_t h = (khint_t)*s;
405	if (h) for (++s ; *s; ++s) h = (h << 5) - h + (khint_t)*s;
406	return h;
407}
408/*! @function
409  @abstract     Another interface to const char* hash function
410  @param  key   Pointer to a null terminated string [const char*]
411  @return       The hash value [khint_t]
412 */
413#define kh_str_hash_func(key) __ac_X31_hash_string(key)
414/*! @function
415  @abstract     Const char* comparison function
416 */
417#define kh_str_hash_equal(a, b) (strcmp(a, b) == 0)
418
419static kh_inline khint_t __ac_Wang_hash(khint_t key)
420{
421    key += ~(key << 15);
422    key ^=  (key >> 10);
423    key +=  (key << 3);
424    key ^=  (key >> 6);
425    key += ~(key << 11);
426    key ^=  (key >> 16);
427    return key;
428}
429#define kh_int_hash_func2(key) __ac_Wang_hash((khint_t)key)
430
431/* --- END OF HASH FUNCTIONS --- */
432
433/* Other convenient macros... */
434
435/*!
436  @abstract Type of the hash table.
437  @param  name  Name of the hash table [symbol]
438 */
439#define khash_t(name) kh_##name##_t
440
441/*! @function
442  @abstract     Initiate a hash table.
443  @param  name  Name of the hash table [symbol]
444  @return       Pointer to the hash table [khash_t(name)*]
445 */
446#define kh_init(name) kh_init_##name()
447
448/*! @function
449  @abstract     Destroy a hash table.
450  @param  name  Name of the hash table [symbol]
451  @param  h     Pointer to the hash table [khash_t(name)*]
452 */
453#define kh_destroy(name, h) kh_destroy_##name(h)
454
455/*! @function
456  @abstract     Reset a hash table without deallocating memory.
457  @param  name  Name of the hash table [symbol]
458  @param  h     Pointer to the hash table [khash_t(name)*]
459 */
460#define kh_clear(name, h) kh_clear_##name(h)
461
462/*! @function
463  @abstract     Resize a hash table.
464  @param  name  Name of the hash table [symbol]
465  @param  h     Pointer to the hash table [khash_t(name)*]
466  @param  s     New size [khint_t]
467 */
468#define kh_resize(name, h, s) kh_resize_##name(h, s)
469
470/*! @function
471  @abstract     Insert a key to the hash table.
472  @param  name  Name of the hash table [symbol]
473  @param  h     Pointer to the hash table [khash_t(name)*]
474  @param  k     Key [type of keys]
475  @param  r     Extra return code: -1 if the operation failed;
476                0 if the key is present in the hash table;
477                1 if the bucket is empty (never used); 2 if the element in
478				the bucket has been deleted [int*]
479  @return       Iterator to the inserted element [khint_t]
480 */
481#define kh_put(name, h, k, r) kh_put_##name(h, k, r)
482
483/*! @function
484  @abstract     Retrieve a key from the hash table.
485  @param  name  Name of the hash table [symbol]
486  @param  h     Pointer to the hash table [khash_t(name)*]
487  @param  k     Key [type of keys]
488  @return       Iterator to the found element, or kh_end(h) if the element is absent [khint_t]
489 */
490#define kh_get(name, h, k) kh_get_##name(h, k)
491
492/*! @function
493  @abstract     Remove a key from the hash table.
494  @param  name  Name of the hash table [symbol]
495  @param  h     Pointer to the hash table [khash_t(name)*]
496  @param  k     Iterator to the element to be deleted [khint_t]
497 */
498#define kh_del(name, h, k) kh_del_##name(h, k)
499
500/*! @function
501  @abstract     Test whether a bucket contains data.
502  @param  h     Pointer to the hash table [khash_t(name)*]
503  @param  x     Iterator to the bucket [khint_t]
504  @return       1 if containing data; 0 otherwise [int]
505 */
506#define kh_exist(h, x) (!__ac_iseither((h)->flags, (x)))
507
508/*! @function
509  @abstract     Get key given an iterator
510  @param  h     Pointer to the hash table [khash_t(name)*]
511  @param  x     Iterator to the bucket [khint_t]
512  @return       Key [type of keys]
513 */
514#define kh_key(h, x) ((h)->keys[x])
515
516/*! @function
517  @abstract     Get value given an iterator
518  @param  h     Pointer to the hash table [khash_t(name)*]
519  @param  x     Iterator to the bucket [khint_t]
520  @return       Value [type of values]
521  @discussion   For hash sets, calling this results in segfault.
522 */
523#define kh_val(h, x) ((h)->vals[x])
524
525/*! @function
526  @abstract     Alias of kh_val()
527 */
528#define kh_value(h, x) ((h)->vals[x])
529
530/*! @function
531  @abstract     Get the start iterator
532  @param  h     Pointer to the hash table [khash_t(name)*]
533  @return       The start iterator [khint_t]
534 */
535#define kh_begin(h) (khint_t)(0)
536
537/*! @function
538  @abstract     Get the end iterator
539  @param  h     Pointer to the hash table [khash_t(name)*]
540  @return       The end iterator [khint_t]
541 */
542#define kh_end(h) ((h)->n_buckets)
543
544/*! @function
545  @abstract     Get the number of elements in the hash table
546  @param  h     Pointer to the hash table [khash_t(name)*]
547  @return       Number of elements in the hash table [khint_t]
548 */
549#define kh_size(h) ((h)->size)
550
551/*! @function
552  @abstract     Get the number of buckets in the hash table
553  @param  h     Pointer to the hash table [khash_t(name)*]
554  @return       Number of buckets in the hash table [khint_t]
555 */
556#define kh_n_buckets(h) ((h)->n_buckets)
557
558/*! @function
559  @abstract     Iterate over the entries in the hash table
560  @param  h     Pointer to the hash table [khash_t(name)*]
561  @param  kvar  Variable to which key will be assigned
562  @param  vvar  Variable to which value will be assigned
563  @param  code  Block of code to execute
564 */
565#define kh_foreach(h, kvar, vvar, code) { khint_t __i;		\
566	for (__i = kh_begin(h); __i != kh_end(h); ++__i) {		\
567		if (!kh_exist(h,__i)) continue;						\
568		(kvar) = kh_key(h,__i);								\
569		(vvar) = kh_val(h,__i);								\
570		code;												\
571	} }
572
573/*! @function
574  @abstract     Iterate over the values in the hash table
575  @param  h     Pointer to the hash table [khash_t(name)*]
576  @param  vvar  Variable to which value will be assigned
577  @param  code  Block of code to execute
578 */
579#define kh_foreach_value(h, vvar, code) { khint_t __i;		\
580	for (__i = kh_begin(h); __i != kh_end(h); ++__i) {		\
581		if (!kh_exist(h,__i)) continue;						\
582		(vvar) = kh_val(h,__i);								\
583		code;												\
584	} }
585
586/* More convenient interfaces */
587
588/*! @function
589  @abstract     Instantiate a hash set containing integer keys
590  @param  name  Name of the hash table [symbol]
591 */
592#define KHASH_SET_INIT_INT(name)										\
593	KHASH_INIT(name, khint32_t, char, 0, kh_int_hash_func, kh_int_hash_equal)
594
595/*! @function
596  @abstract     Instantiate a hash map containing integer keys
597  @param  name  Name of the hash table [symbol]
598  @param  khval_t  Type of values [type]
599 */
600#define KHASH_MAP_INIT_INT(name, khval_t)								\
601	KHASH_INIT(name, khint32_t, khval_t, 1, kh_int_hash_func, kh_int_hash_equal)
602
603/*! @function
604  @abstract     Instantiate a hash set containing 64-bit integer keys
605  @param  name  Name of the hash table [symbol]
606 */
607#define KHASH_SET_INIT_INT64(name)										\
608	KHASH_INIT(name, khint64_t, char, 0, kh_int64_hash_func, kh_int64_hash_equal)
609
610/*! @function
611  @abstract     Instantiate a hash map containing 64-bit integer keys
612  @param  name  Name of the hash table [symbol]
613  @param  khval_t  Type of values [type]
614 */
615#define KHASH_MAP_INIT_INT64(name, khval_t)								\
616	KHASH_INIT(name, khint64_t, khval_t, 1, kh_int64_hash_func, kh_int64_hash_equal)
617
618typedef const char *kh_cstr_t;
619/*! @function
620  @abstract     Instantiate a hash map containing const char* keys
621  @param  name  Name of the hash table [symbol]
622 */
623#define KHASH_SET_INIT_STR(name)										\
624	KHASH_INIT(name, kh_cstr_t, char, 0, kh_str_hash_func, kh_str_hash_equal)
625
626/*! @function
627  @abstract     Instantiate a hash map containing const char* keys
628  @param  name  Name of the hash table [symbol]
629  @param  khval_t  Type of values [type]
630 */
631#define KHASH_MAP_INIT_STR(name, khval_t)								\
632	KHASH_INIT(name, kh_cstr_t, khval_t, 1, kh_str_hash_func, kh_str_hash_equal)
633
634#endif /* __AC_KHASH_H */
635