The basics are all covered. hash_table_new creates a hash table,
and hash_table_destroy deletes it. hash_table_put establishes a
mapping between a key and a value. hash_table_get retrieves the
- value that corresponds to a key. hash_table_exists queries whether
- a key is stored in a table at all. hash_table_remove removes a
- mapping that corresponds to a key. hash_table_map allows you to
- map through all the entries in a hash table. hash_table_clear
- clears all the entries from the hash table.
+ value that corresponds to a key. hash_table_contains queries
+ whether a key is stored in a table at all. hash_table_remove
+ removes a mapping that corresponds to a key. hash_table_map allows
+ you to map through all the entries in a hash table.
+ hash_table_clear clears all the entries from the hash table.
The number of mappings in a table is not limited, except by the
amount of memory. As you add new elements to a table, it regrows
The hashing and equality functions are normally provided by the
user. For the special (and frequent) case of hashing strings, you
- can use the pre-canned make_string_hash_table(), which provides the
- string hashing function from the Dragon Book, and a string equality
- wrapper around strcmp().
+ can use the pre-canned make_string_hash_table(), which provides an
+ efficient string hashing function, and a string equality wrapper
+ around strcmp().
When specifying your own hash and test functions, make sure the
following holds true:
int count; /* number of non-empty, non-deleted
fields. */
+ int resize_threshold; /* after size exceeds this number of
+ entries, resize the table. */
+
struct mapping *mappings;
};
/* Find a prime near, but greather than or equal to SIZE. */
-int
+static int
prime_size (int size)
{
static const unsigned long primes [] = {
}
/* Create a hash table of INITIAL_SIZE with hash function
- HASH_FUNCTION and test function TEST_FUNCTION. If you wish to
- start out with a "small" table which will be regrown as needed,
- specify 0 as INITIAL_SIZE. */
+ HASH_FUNCTION and test function TEST_FUNCTION. INITIAL_SIZE will
+ be rounded to the next prime, so you don't have to worry about it
+ being a prime number.
+
+ Consequently, if you wish to start out with a "small" table which
+ will be regrown as needed, specify INITIAL_SIZE 0. */
struct hash_table *
hash_table_new (int initial_size,
{
struct hash_table *ht
= (struct hash_table *)xmalloc (sizeof (struct hash_table));
+
ht->hash_function = hash_function;
ht->test_function = test_function;
+
ht->size = prime_size (initial_size);
+ ht->resize_threshold = ht->size * 3 / 4;
+
ht->count = 0;
+
ht->mappings = xmalloc (ht->size * sizeof (struct mapping));
memset (ht->mappings, '\0', ht->size * sizeof (struct mapping));
+
return ht;
}
}
/* The heart of almost all functions in this file -- find the mapping
- whose KEY is equal to key, using a linear probing loop. Returns
- the offset of the mapping in ht->mappings. */
+ whose KEY is equal to key, using linear probing. Returns the
+ mapping that matches KEY, or NULL if none matches. */
static inline struct mapping *
find_mapping (struct hash_table *ht, const void *key)
/* Get the value that corresponds to the key KEY in the hash table HT.
If no value is found, return NULL. Note that NULL is a legal value
for value; if you are storing NULLs in your hash table, you can use
- hash_table_exists to be sure that a (possibly NULL) value exists in
- the table. Or, you can use hash_table_get_pair instead of this
+ hash_table_contains to be sure that a (possibly NULL) value exists
+ in the table. Or, you can use hash_table_get_pair instead of this
function. */
void *
return 0;
}
-/* Return 1 if KEY exists in HT, 0 otherwise. */
+/* Return 1 if HT contains KEY, 0 otherwise. */
int
-hash_table_exists (struct hash_table *ht, const void *key)
+hash_table_contains (struct hash_table *ht, const void *key)
{
return find_mapping (ht, key) != NULL;
}
-#define MAX(i, j) (((i) >= (j)) ? (i) : (j))
-
/* Grow hash table HT as necessary, and rehash all the key-value
mappings. */
{
struct mapping *old_mappings = ht->mappings;
struct mapping *old_end = ht->mappings + ht->size;
- struct mapping *mp;
- int old_count = ht->count; /* for assert() below */
+ struct mapping *mp, *mappings;
+ int newsize;
+ newsize = prime_size (ht->size * 2);
#if 0
- printf ("growing from %d to %d\n", ht->size, prime_size (ht->size * 2));
+ printf ("growing from %d to %d\n", ht->size, newsize);
#endif
- ht->size = prime_size (ht->size * 2);
+ ht->size = newsize;
+ ht->resize_threshold = newsize * 3 / 4;
- ht->mappings = xmalloc (ht->size * sizeof (struct mapping));
- memset (ht->mappings, '\0', ht->size * sizeof (struct mapping));
-
- /* Need to reset this; hash_table_put will reinitialize it. */
- ht->count = 0;
+ mappings = xmalloc (ht->size * sizeof (struct mapping));
+ memset (mappings, '\0', ht->size * sizeof (struct mapping));
+ ht->mappings = mappings;
for (mp = old_mappings; mp < old_end; mp++)
if (!EMPTY_MAPPING_P (mp))
- hash_table_put (ht, mp->key, mp->value);
+ {
+ struct mapping *new_mp = mappings + HASH_POSITION (ht, mp->key);
+ /* We don't need to call test function and worry about
+ collisions because all the keys come from the hash table
+ and are therefore guaranteed to be unique. */
+ LOOP_NON_EMPTY (new_mp, mappings, newsize)
+ ;
+ *new_mp = *mp;
+ }
- assert (ht->count == old_count);
xfree (old_mappings);
}
mp->key = (void *)key; /* const? */
mp->value = value;
- if (ht->count > ht->size * 3 / 4)
+ if (ht->count > ht->resize_threshold)
/* When table is 75% full, regrow it. */
grow_hash_table (ht);
}
--ht->count;
/* Rehash all the entries following MP. The alternative
- approach is to mark entry as deleted, but that leaves a lot
- of garbage. More importantly, this method makes
- hash_table_get and hash_table_put measurably faster. */
+ approach is to mark the entry as deleted, i.e. create a
+ "tombstone". That makes remove faster, but leaves a lot of
+ garbage and slows down hash_table_get and hash_table_put. */
mp = NEXT_MAPPING (mp, mappings, size);
LOOP_NON_EMPTY (mp, mappings, size)
hash_table_clear (struct hash_table *ht)
{
memset (ht->mappings, '\0', ht->size * sizeof (struct mapping));
- ht->count = 0;
+ ht->count = 0;
}
/* Map MAPFUN over all the mappings in hash table HT. MAPFUN is
key = mp->key;
if (mapfun (key, mp->value, closure))
return;
+ /* hash_table_remove might have moved the adjacent
+ mappings. */
if (mp->key != key && !EMPTY_MAPPING_P (mp))
goto repeat;
}
/* Return the number of elements in the hash table. This is not the
same as the physical size of the hash table, which is always
greater than the number of elements. */
+
int
hash_table_count (struct hash_table *ht)
{
return ht->count;
}
\f
-/* Support for hash tables whose keys are strings. */
+/* Functions from this point onward are meant for convenience and
+ don't strictly belong to this file. However, this is as good a
+ place for them as any. */
+
+/* ========
+ Support for hash tables whose keys are strings.
+ ======== */
+
+/* 31 bit hash function. Taken from Gnome's glib, modified to use
+ standard C types.
+
+ We used to use the popular hash function from the Dragon Book, but
+ this one seems to perform much better. */
-/* 31 bit hash function. Taken from Gnome's glib. This seems to
- perform much better than the above. */
unsigned long
string_hash (const void *key)
{
return h;
}
+/* Frontend for strcmp usable for hash tables. */
+
+int
+string_cmp (const void *s1, const void *s2)
+{
+ return !strcmp ((const char *)s1, (const char *)s2);
+}
+
+/* Return a hash table of initial size INITIAL_SIZE suitable to use
+ strings as keys. */
+
+struct hash_table *
+make_string_hash_table (int initial_size)
+{
+ return hash_table_new (initial_size, string_hash, string_cmp);
+}
+
+/* ========
+ Support for hash tables whose keys are strings, but which are
+ compared case-insensitively.
+ ======== */
+
+/* Like string_hash, but produce the same hash regardless of the case. */
+
+static unsigned long
+string_hash_nocase (const void *key)
+{
+ const char *p = key;
+ unsigned int h = TOLOWER (*p);
+
+ if (h)
+ for (p += 1; *p != '\0'; p++)
+ h = (h << 5) - h + TOLOWER (*p);
+
+ return h;
+}
+
+/* Like string_cmp, but doing case-insensitive compareison. */
+
+static int
+string_cmp_nocase (const void *s1, const void *s2)
+{
+ return !strcasecmp ((const char *)s1, (const char *)s2);
+}
+
+/* Like make_string_hash_table, but uses string_hash_nocase and
+ string_cmp_nocase. */
+
+struct hash_table *
+make_nocase_string_hash_table (int initial_size)
+{
+ return hash_table_new (initial_size, string_hash_nocase, string_cmp_nocase);
+}
+
#if 0
/* If I ever need it: hashing of integers. */
return key;
}
#endif
-
-int
-string_cmp (const void *s1, const void *s2)
-{
- return !strcmp ((const char *)s1, (const char *)s2);
-}
-
-/* Return a hash table of initial size INITIAL_SIZE suitable to use
- strings as keys. */
-
-struct hash_table *
-make_string_hash_table (int initial_size)
-{
- return hash_table_new (initial_size, string_hash, string_cmp);
-}
-
\f
#ifdef STANDALONE
if (len <= 1)
continue;
line[--len] = '\0';
- if (!hash_table_exists (ht, line))
+ if (!hash_table_contains (ht, line))
hash_table_put (ht, strdup (line), "here I am!");
#if 1
if (len % 5 == 0)
projects / wget / blobdiff