hash_table.h

Go to the documentation of this file.

/*
Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
Copyright (C) 2022 The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
 
#ifndef HASH_TABLE_H
#define HASH_TABLE_H
 
typedef unsigned (*hash_func_t) (const char *key);
 
struct hash_table *hash_table_create(int buckets, hash_func_t func);
 
void hash_table_clear(struct hash_table *h, void (*delete_func)( void *) );
 
 
void hash_table_delete(struct hash_table *h);
 
int hash_table_size(struct hash_table *h);
 
double hash_table_load(struct hash_table *h);
 
int hash_table_insert(struct hash_table *h, const char *key, const void *value);
 
void *hash_table_lookup(struct hash_table *h, const char *key);
 
void *hash_table_remove(struct hash_table *h, const char *key);
 
void hash_table_firstkey(struct hash_table *h);
 
int hash_table_nextkey(struct hash_table *h, char **key, void **value);
 
void hash_table_randomkey(struct hash_table *h, int *offset_bookkeep);
 
int hash_table_nextkey_with_offset(struct hash_table *h, int offset_bookkeep, char **key, void **value);
 
int hash_table_fromkey(struct hash_table *h, const char *key);
 
unsigned hash_string(const char *s);
 
char **hash_table_keys_array(struct hash_table *h);
 
 
void hash_table_free_keys_array(char **keys);
 
#define HASH_TABLE_ITERATE( table, key, value ) hash_table_firstkey(table); while(hash_table_nextkey(table,&key,(void**)&value))
 
#define HASH_TABLE_ITERATE_RANDOM_START( table, offset_bookkeep, key, value ) hash_table_randomkey(table, &offset_bookkeep); while(hash_table_nextkey_with_offset(table, offset_bookkeep, &key, (void **)&value))
 
#define HASH_TABLE_ITERATE_FROM_KEY( table, iter_control, iter_count_var, key_start, key, value ) \
        iter_control = 0; \
        iter_count_var = 0; \
  hash_table_fromkey(table, key_start); \
        while(iter_count_var < hash_table_size(table) && (iter_count_var+=1 && (hash_table_nextkey(table, &key, (void **)&value) || (!iter_control && (iter_control+=1) && hash_table_fromkey(table, NULL) && hash_table_nextkey(table, &key, (void **)&value)))))
 
#endif