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"
30 KHASH_MAP_INIT_INT(32, char)
31 int 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
135 typedef unsigned int khint32_t;
136 #elif ULONG_MAX == 0xffffffffu
137 typedef unsigned long khint32_t;
138 #endif
139 
140 #if ULONG_MAX == ULLONG_MAX
141 typedef unsigned long khint64_t;
142 #else
143 typedef 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 
162 typedef khint32_t khint_t;
163 typedef 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 static const double __ac_HASH_UPPER = 0.77;
193 
194 #define __KHASH_TYPE(name, khkey_t, khval_t)                                                                    \
195   typedef struct kh_##name##_s {                                                                                \
196     khint_t n_buckets, size, n_occupied, upper_bound;                                                           \
197     khint32_t *flags;                                                                                           \
198     khkey_t *keys;                                                                                              \
199     khval_t *vals;                                                                                              \
200   } kh_##name##_t;
201 
202 #define __KHASH_PROTOTYPES(name, khkey_t, khval_t)                                                              \
203   extern kh_##name##_t *kh_init_##name(void);                                                                   \
204   extern void kh_destroy_##name(kh_##name##_t *h);                                                              \
205   extern void kh_clear_##name(kh_##name##_t *h);                                                                \
206   extern khint_t kh_get_##name(const kh_##name##_t *h, khkey_t key);                                            \
207   extern int kh_resize_##name(kh_##name##_t *h, khint_t new_n_buckets);                                         \
208   extern khint_t kh_put_##name(kh_##name##_t *h, khkey_t key, int *ret);                                        \
209   extern void kh_del_##name(kh_##name##_t *h, khint_t x);                                                       \
210 
211 #define __KHASH_IMPL(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)                       \
212   SCOPE kh_##name##_t *kh_init_##name(void) {                                                                   \
213     return (kh_##name##_t*) kcalloc(1, sizeof(kh_##name##_t));                                                  \
214   }                                                                                                             \
215   SCOPE void kh_destroy_##name(kh_##name##_t *h)                                                                \
216   {                                                                                                             \
217     if (h) {                                                                                                    \
218       kfree ((void *) h->keys);                                                                                 \
219       kfree (h->flags);                                                                                         \
220       kfree ((void *) h->vals);                                                                                 \
221       kfree (h);                                                                                                \
222     }                                                                                                           \
223   }                                                                                                             \
224   SCOPE void kh_clear_##name(kh_##name##_t *h)                                                                  \
225   {                                                                                                             \
226     if (h && h->flags) {                                                                                        \
227       memset (h->flags, 0xaa, __ac_fsize (h->n_buckets) * sizeof (khint32_t));                                  \
228       h->size = h->n_occupied = 0;                                                                              \
229     }                                                                                                           \
230   }                                                                                                             \
231   SCOPE khint_t kh_get_##name(const kh_##name##_t *h, khkey_t key)                                              \
232   {                                                                                                             \
233     if (h->n_buckets) {                                                                                         \
234       khint_t k, i, last, mask, step = 0;                                                                       \
235       mask = h->n_buckets - 1;                                                                                  \
236       k = __hash_func (key);                                                                                    \
237       i = k & mask;                                                                                             \
238       last = i;                                                                                                 \
239       while (!__ac_isempty (h->flags, i) &&                                                                     \
240              (__ac_isdel (h->flags, i) || !__hash_equal (h->keys[i], key))) {                                   \
241         i = (i + (++step)) & mask;                                                                              \
242         if (i == last)                                                                                          \
243           return h->n_buckets;                                                                                  \
244       }                                                                                                         \
245       return __ac_iseither (h->flags, i) ? h->n_buckets : i;                                                    \
246     } else                                                                                                      \
247       return 0;                                                                                                 \
248   }                                                                                                             \
249   SCOPE int kh_resize_##name(kh_##name##_t *h, khint_t new_n_buckets)                                           \
250   {                                                                                                             \
251     /* This function uses 0.25*n_buckets bytes of working space instead of */                                   \
252     /* [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)                                                                                    \
258         new_n_buckets = 4;                                                                                      \
259       if (h->size >= (khint_t) (new_n_buckets * __ac_HASH_UPPER + 0.5))                                         \
260         j = 0;    /* requested size is too small */                                                             \
261       else {      /* hash table size to be changed (shrink or expand); rehash */                                \
262         new_flags = (khint32_t *) kmalloc (__ac_fsize (new_n_buckets) * sizeof (khint32_t));                    \
263         if (!new_flags)                                                                                         \
264           return -1;                                                                                            \
265         memset (new_flags, 0xaa, __ac_fsize (new_n_buckets) * sizeof (khint32_t));                              \
266         if (h->n_buckets < new_n_buckets) {       /* expand */                                                  \
267           khkey_t *new_keys = (khkey_t *) krealloc ((void *) h->keys, new_n_buckets * sizeof (khkey_t));        \
268           if (!new_keys) {                                                                                      \
269             kfree (new_flags);                                                                                  \
270             return -1;                                                                                          \
271           }                                                                                                     \
272           h->keys = new_keys;                                                                                   \
273           if (kh_is_map) {                                                                                      \
274             khval_t *new_vals = (khval_t *) krealloc ((void *) h->vals, new_n_buckets * sizeof (khval_t));      \
275             if (!new_vals) {                                                                                    \
276               kfree (new_flags);                                                                                \
277               return -1;                                                                                        \
278             }                                                                                                   \
279             h->vals = new_vals;                                                                                 \
280           }                                                                                                     \
281         } /* otherwise shrink */                                                                                \
282       }                                                                                                         \
283     }                                                                                                           \
284     if (j) {      /* rehashing is needed */                                                                     \
285       for (j = 0; j != h->n_buckets; ++j) {                                                                     \
286         if (__ac_iseither (h->flags, j) == 0) {                                                                 \
287           khkey_t key = h->keys[j];                                                                             \
288           khval_t val;                                                                                          \
289           khint_t new_mask;                                                                                     \
290           new_mask = new_n_buckets - 1;                                                                         \
291           if (kh_is_map)                                                                                        \
292             val = h->vals[j];                                                                                   \
293           __ac_set_isdel_true (h->flags, j);                                                                    \
294           while (1) {     /* kick-out process; sort of like in Cuckoo hashing */                                \
295             khint_t k, i, step = 0;                                                                             \
296             k = __hash_func (key);                                                                              \
297             i = k & new_mask;                                                                                   \
298             while (!__ac_isempty (new_flags, i))                                                                \
299               i = (i + (++step)) & new_mask;                                                                    \
300             __ac_set_isempty_false (new_flags, i);                                                              \
301             if (i < h->n_buckets && __ac_iseither (h->flags, i) == 0) {   /* kick out the existing element */   \
302               {                                                                                                 \
303                 khkey_t tmp = h->keys[i];                                                                       \
304                 h->keys[i] = key;                                                                               \
305                 key = tmp;                                                                                      \
306               }                                                                                                 \
307               if (kh_is_map) {                                                                                  \
308                 khval_t tmp = h->vals[i];                                                                       \
309                 h->vals[i] = val;                                                                               \
310                 val = tmp;                                                                                      \
311               }                                                                                                 \
312               __ac_set_isdel_true (h->flags, i);  /* mark it as deleted in the old hash table */                \
313             } else {      /* write the element and jump out of the loop */                                      \
314               h->keys[i] = key;                                                                                 \
315               if (kh_is_map)                                                                                    \
316                 h->vals[i] = val;                                                                               \
317               break;                                                                                            \
318             }                                                                                                   \
319           }                                                                                                     \
320         }                                                                                                       \
321       }                                                                                                         \
322       if (h->n_buckets > new_n_buckets) { /* shrink the hash table */                                           \
323         h->keys = (khkey_t *) krealloc ((void *) h->keys, new_n_buckets * sizeof (khkey_t));                    \
324         if (kh_is_map)                                                                                          \
325           h->vals = (khval_t *) krealloc ((void *) h->vals, new_n_buckets * sizeof (khval_t));                  \
326       }                                                                                                         \
327       kfree (h->flags);   /* free the working space */                                                          \
328       h->flags = new_flags;                                                                                     \
329       h->n_buckets = new_n_buckets;                                                                             \
330       h->n_occupied = h->size;                                                                                  \
331       h->upper_bound = (khint_t) (h->n_buckets * __ac_HASH_UPPER + 0.5);                                        \
332     }                                                                                                           \
333     return 0;                                                                                                   \
334   }                                                                                                             \
335   SCOPE khint_t kh_put_##name(kh_##name##_t *h, khkey_t key, int *ret)                                          \
336   {                                                                                                             \
337     khint_t x;                                                                                                  \
338     if (h->n_occupied >= h->upper_bound) {        /* update the hash table */                                   \
339       if (h->n_buckets > (h->size << 1)) {                                                                      \
340         if (kh_resize_##name (h, h->n_buckets - 1) < 0) {   /* clear "deleted" elements */                      \
341           *ret = -1;                                                                                            \
342           return h->n_buckets;                                                                                  \
343         }                                                                                                       \
344       } else if (kh_resize_##name (h, h->n_buckets + 1) < 0) {      /* expand the hash table */                 \
345         *ret = -1;                                                                                              \
346         return h->n_buckets;                                                                                    \
347       }                                                                                                         \
348     }     /* TODO: to implement automatically shrinking; resize() already support shrinking */                  \
349     {                                                                                                           \
350       khint_t k, i, site, last, mask = h->n_buckets - 1, step = 0;                                              \
351       x = site = h->n_buckets;                                                                                  \
352       k = __hash_func (key);                                                                                    \
353       i = k & mask;                                                                                             \
354       if (__ac_isempty (h->flags, i))                                                                           \
355         x = i;    /* for speed up */                                                                            \
356       else {                                                                                                    \
357         last = i;                                                                                               \
358         while (!__ac_isempty (h->flags, i) && (__ac_isdel (h->flags, i) || !__hash_equal (h->keys[i], key))) {  \
359           if (__ac_isdel (h->flags, i))                                                                         \
360             site = i;                                                                                           \
361           i = (i + (++step)) & mask;                                                                            \
362           if (i == last) {                                                                                      \
363             x = site;                                                                                           \
364             break;                                                                                              \
365           }                                                                                                     \
366         }                                                                                                       \
367         if (x == h->n_buckets) {                                                                                \
368           if (__ac_isempty (h->flags, i) && site != h->n_buckets)                                               \
369             x = site;                                                                                           \
370           else                                                                                                  \
371             x = i;                                                                                              \
372         }                                                                                                       \
373       }                                                                                                         \
374     }                                                                                                           \
375     if (__ac_isempty (h->flags, x)) {     /* not present at all */                                              \
376       h->keys[x] = key;                                                                                         \
377       __ac_set_isboth_false (h->flags, x);                                                                      \
378       ++h->size;                                                                                                \
379       ++h->n_occupied;                                                                                          \
380       *ret = 1;                                                                                                 \
381     } else if (__ac_isdel (h->flags, x)) {        /* deleted */                                                 \
382       h->keys[x] = key;                                                                                         \
383       __ac_set_isboth_false (h->flags, x);                                                                      \
384       ++h->size;                                                                                                \
385       *ret = 2;                                                                                                 \
386     } else                                                                                                      \
387       *ret = 0;   /* Don't touch h->keys[x] if present and not deleted */                                       \
388     return x;                                                                                                   \
389   }                                                                                                             \
390   SCOPE void kh_del_##name(kh_##name##_t *h, khint_t x)                                                         \
391   {                                                                                                             \
392     if (x != h->n_buckets && !__ac_iseither (h->flags, x)) {                                                    \
393       __ac_set_isdel_true (h->flags, x);                                                                        \
394       --h->size;                                                                                                \
395     }                                                                                                           \
396   }                                                                                                             \
397 
398 #define KHASH_DECLARE(name, khkey_t, khval_t)                                                                   \
399   __KHASH_TYPE(name, khkey_t, khval_t)                                                                          \
400   __KHASH_PROTOTYPES(name, khkey_t, khval_t)
401 
402 #define KHASH_INIT2(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)                        \
403   __KHASH_TYPE(name, khkey_t, khval_t)                                                                          \
404   __KHASH_IMPL(name, SCOPE, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)
405 
406 #define KHASH_INIT(name, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)                                \
407   KHASH_INIT2(name, static kh_inline klib_unused, khkey_t, khval_t, kh_is_map, __hash_func, __hash_equal)       \
408 
409 /* --- BEGIN OF HASH FUNCTIONS --- */
410 
411 /*! @function
412   @abstract     Integer hash function
413   @param  key   The integer [khint32_t]
414   @return       The hash value [khint_t]
415  */
416 #define kh_int_hash_func(key) (khint32_t)(key)
417 /*! @function
418   @abstract     Integer comparison function
419  */
420 #define kh_int_hash_equal(a, b) ((a) == (b))
421 /*! @function
422   @abstract     64-bit integer hash function
423   @param  key   The integer [khint64_t]
424   @return       The hash value [khint_t]
425  */
426 #define kh_int64_hash_func(key) (khint32_t)((key)>>33^(key)^(key)<<11)
427 /*! @function
428   @abstract     64-bit integer comparison function
429  */
430 #define kh_int64_hash_equal(a, b) ((a) == (b))
431 /*! @function
432   @abstract     const char* hash function
433   @param  s     Pointer to a null terminated string
434   @return       The hash value
435  */
436 #if defined(__clang__) && defined(__clang_major__) && (__clang_major__ >= 4)
437 __attribute__((no_sanitize ("unsigned-integer-overflow")))
438 #endif
__ac_X31_hash_string(const char * s)439   static kh_inline khint_t __ac_X31_hash_string (const char *s) {
440   khint_t h = (khint_t) * s;
441   if (h)
442     for (++s; *s; ++s)
443       h = (h << 5) - h + (khint_t) * s;
444   return h;
445   }
446 
447 /*! @function
448   @abstract     Another interface to const char* hash function
449   @param  key   Pointer to a null terminated string [const char*]
450   @return       The hash value [khint_t]
451  */
452 #define kh_str_hash_func(key) __ac_X31_hash_string(key)
453 /*! @function
454   @abstract     Const char* comparison function
455  */
456 #define kh_str_hash_equal(a, b) (strcmp(a, b) == 0)
457 
458 static kh_inline khint_t
__ac_Wang_hash(khint_t key)459 __ac_Wang_hash (khint_t key) {
460   key += ~(key << 15);
461   key ^= (key >> 10);
462   key += (key << 3);
463   key ^= (key >> 6);
464   key += ~(key << 11);
465   key ^= (key >> 16);
466   return key;
467 }
468 
469 #define kh_int_hash_func2(k) __ac_Wang_hash((khint_t)key)
470 
471 /* --- END OF HASH FUNCTIONS --- */
472 
473 /* Other convenient macros... */
474 
475 /*!
476   @abstract Type of the hash table.
477   @param  name  Name of the hash table [symbol]
478  */
479 #define khash_t(name) kh_##name##_t
480 
481 /*! @function
482   @abstract     Initiate a hash table.
483   @param  name  Name of the hash table [symbol]
484   @return       Pointer to the hash table [khash_t(name)*]
485  */
486 #define kh_init(name) kh_init_##name()
487 
488 /*! @function
489   @abstract     Destroy a hash table.
490   @param  name  Name of the hash table [symbol]
491   @param  h     Pointer to the hash table [khash_t(name)*]
492  */
493 #define kh_destroy(name, h) kh_destroy_##name(h)
494 
495 /*! @function
496   @abstract     Reset a hash table without deallocating memory.
497   @param  name  Name of the hash table [symbol]
498   @param  h     Pointer to the hash table [khash_t(name)*]
499  */
500 #define kh_clear(name, h) kh_clear_##name(h)
501 
502 /*! @function
503   @abstract     Resize a hash table.
504   @param  name  Name of the hash table [symbol]
505   @param  h     Pointer to the hash table [khash_t(name)*]
506   @param  s     New size [khint_t]
507  */
508 #define kh_resize(name, h, s) kh_resize_##name(h, s)
509 
510 /*! @function
511   @abstract     Insert a key to the hash table.
512   @param  name  Name of the hash table [symbol]
513   @param  h     Pointer to the hash table [khash_t(name)*]
514   @param  k     Key [type of keys]
515   @param  r     Extra return code: -1 if the operation failed;
516                 0 if the key is present in the hash table;
517                 1 if the bucket is empty (never used); 2 if the element in
518         the bucket has been deleted [int*]
519   @return       Iterator to the inserted element [khint_t]
520  */
521 #define kh_put(name, h, k, r) kh_put_##name(h, k, r)
522 
523 /*! @function
524   @abstract     Retrieve a key from the hash table.
525   @param  name  Name of the hash table [symbol]
526   @param  h     Pointer to the hash table [khash_t(name)*]
527   @param  k     Key [type of keys]
528   @return       Iterator to the found element, or kh_end(h) if the element is absent [khint_t]
529  */
530 #define kh_get(name, h, k) kh_get_##name(h, k)
531 
532 /*! @function
533   @abstract     Remove a key from the hash table.
534   @param  name  Name of the hash table [symbol]
535   @param  h     Pointer to the hash table [khash_t(name)*]
536   @param  k     Iterator to the element to be deleted [khint_t]
537  */
538 #define kh_del(name, h, k) kh_del_##name(h, k)
539 
540 /*! @function
541   @abstract     Test whether a bucket contains data.
542   @param  h     Pointer to the hash table [khash_t(name)*]
543   @param  x     Iterator to the bucket [khint_t]
544   @return       1 if containing data; 0 otherwise [int]
545  */
546 #define kh_exist(h, x) (!__ac_iseither((h)->flags, (x)))
547 
548 /*! @function
549   @abstract     Get key given an iterator
550   @param  h     Pointer to the hash table [khash_t(name)*]
551   @param  x     Iterator to the bucket [khint_t]
552   @return       Key [type of keys]
553  */
554 #define kh_key(h, x) ((h)->keys[x])
555 
556 /*! @function
557   @abstract     Get value given an iterator
558   @param  h     Pointer to the hash table [khash_t(name)*]
559   @param  x     Iterator to the bucket [khint_t]
560   @return       Value [type of values]
561   @discussion   For hash sets, calling this results in segfault.
562  */
563 #define kh_val(h, x) ((h)->vals[x])
564 
565 /*! @function
566   @abstract     Alias of kh_val()
567  */
568 #define kh_value(h, x) ((h)->vals[x])
569 
570 /*! @function
571   @abstract     Get the start iterator
572   @param  h     Pointer to the hash table [khash_t(name)*]
573   @return       The start iterator [khint_t]
574  */
575 #define kh_begin(h) (khint_t)(0)
576 
577 /*! @function
578   @abstract     Get the end iterator
579   @param  h     Pointer to the hash table [khash_t(name)*]
580   @return       The end iterator [khint_t]
581  */
582 #define kh_end(h) ((h)->n_buckets)
583 
584 /*! @function
585   @abstract     Get the number of elements in the hash table
586   @param  h     Pointer to the hash table [khash_t(name)*]
587   @return       Number of elements in the hash table [khint_t]
588  */
589 #define kh_size(h) ((h)->size)
590 
591 /*! @function
592   @abstract     Get the number of buckets in the hash table
593   @param  h     Pointer to the hash table [khash_t(name)*]
594   @return       Number of buckets in the hash table [khint_t]
595  */
596 #define kh_n_buckets(h) ((h)->n_buckets)
597 
598 /*! @function
599   @abstract     Iterate over the entries in the hash table
600   @param  h     Pointer to the hash table [khash_t(name)*]
601   @param  kvar  Variable to which key will be assigned
602   @param  vvar  Variable to which value will be assigned
603   @param  code  Block of code to execute
604  */
605 #define kh_foreach(h, kvar, vvar, code) { khint_t __i;                                                          \
606   for (__i = kh_begin(h); __i != kh_end(h); ++__i) {                                                            \
607     if (!kh_exist(h,__i)) continue;                                                                             \
608     (kvar) = kh_key(h,__i);                                                                                     \
609     (vvar) = kh_val(h,__i);                                                                                     \
610     code;                                                                                                       \
611   } }
612 
613 /*! @function
614   @abstract     Iterate over the values in the hash table
615   @param  h     Pointer to the hash table [khash_t(name)*]
616   @param  vvar  Variable to which value will be assigned
617   @param  code  Block of code to execute
618  */
619 #define kh_foreach_value(h, vvar, code) { khint_t __i;                                                          \
620   for (__i = kh_begin (h); __i != kh_end (h); ++__i) {                                                          \
621     if (!kh_exist (h, __i))                                                                                     \
622       continue;                                                                                                 \
623     (vvar) = kh_val (h, __i);                                                                                   \
624     code;                                                                                                       \
625   } }
626 
627 /* More convenient interfaces */
628 
629 /*! @function
630   @abstract     Instantiate a hash set containing integer keys
631   @param  name  Name of the hash table [symbol]
632  */
633 #define KHASH_SET_INIT_INT(name)                                                                                \
634   KHASH_INIT(name, khint32_t, char, 0, kh_int_hash_func, kh_int_hash_equal)
635 
636 /*! @function
637   @abstract     Instantiate a hash map containing integer keys
638   @param  name  Name of the hash table [symbol]
639   @param  khval_t  Type of values [type]
640  */
641 #define KHASH_MAP_INIT_INT(name, khval_t)                                                                       \
642   KHASH_INIT(name, khint32_t, khval_t, 1, kh_int_hash_func, kh_int_hash_equal)
643 
644 /*! @function
645   @abstract     Instantiate a hash map containing 64-bit integer keys
646   @param  name  Name of the hash table [symbol]
647  */
648 #define KHASH_SET_INIT_INT64(name)                                                                              \
649   KHASH_INIT(name, khint64_t, char, 0, kh_int64_hash_func, kh_int64_hash_equal)
650 
651 /*! @function
652   @abstract     Instantiate a hash map containing 64-bit integer keys
653   @param  name  Name of the hash table [symbol]
654   @param  khval_t  Type of values [type]
655  */
656 #define KHASH_MAP_INIT_INT64(name, khval_t)                                                                     \
657   KHASH_INIT(name, khint64_t, khval_t, 1, kh_int64_hash_func, kh_int64_hash_equal)
658 
659 typedef const char *kh_cstr_t;
660 /*! @function
661   @abstract     Instantiate a hash map containing const char* keys
662   @param  name  Name of the hash table [symbol]
663  */
664 #define KHASH_SET_INIT_STR(name)                                                                                \
665   KHASH_INIT(name, kh_cstr_t, char, 0, kh_str_hash_func, kh_str_hash_equal)
666 
667 /*! @function
668   @abstract     Instantiate a hash map containing const char* keys
669   @param  name  Name of the hash table [symbol]
670   @param  khval_t  Type of values [type]
671  */
672 #define KHASH_MAP_INIT_STR(name, khval_t)                                                                       \
673   KHASH_INIT(name, kh_cstr_t, khval_t, 1, kh_str_hash_func, kh_str_hash_equal)
674 
675 #endif /* __AC_KHASH_H */
676