libdict/html/hashtable_8h_source.html

/*

 * libdict -- hash-value sorted, chained hash-table interface.

 *

 * Copyright (c) 2001-2014, Farooq Mela

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR

 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */


#ifndef LIBDICT_HASHTABLE_H__

#define LIBDICT_HASHTABLE_H__


#include "dict.h"


BEGIN_DECL


typedef struct hashtable hashtable;


hashtable*      hashtable_new(dict_compare_func cmp_func, dict_hash_func hash_func, unsigned size);

dict*           hashtable_dict_new(dict_compare_func cmp_func, dict_hash_func hash_func, unsigned size);

size_t          hashtable_free(hashtable* table, dict_delete_func delete_func);


dict_insert_result

                hashtable_insert(hashtable* table, void* key);

void**          hashtable_search(hashtable* table, const void* key);

dict_remove_result

                hashtable_remove(hashtable* table, const void* key);

size_t          hashtable_clear(hashtable* table, dict_delete_func delete_func);

size_t          hashtable_traverse(hashtable* table, dict_visit_func visit, void* user_data);

size_t          hashtable_count(const hashtable* table);

size_t          hashtable_size(const hashtable* table);

size_t          hashtable_slots_used(const hashtable* table);

bool            hashtable_verify(const hashtable* table);

bool            hashtable_resize(hashtable* table, unsigned size);


typedef struct hashtable_itor hashtable_itor;


hashtable_itor* hashtable_itor_new(hashtable* table);

dict_itor*      hashtable_dict_itor_new(hashtable* table);

void            hashtable_itor_free(hashtable_itor* itor);


bool            hashtable_itor_valid(const hashtable_itor* itor);

void            hashtable_itor_invalidate(hashtable_itor* itor);

bool            hashtable_itor_next(hashtable_itor* itor);

bool            hashtable_itor_prev(hashtable_itor* itor);

bool            hashtable_itor_nextn(hashtable_itor* itor, size_t count);

bool            hashtable_itor_prevn(hashtable_itor* itor, size_t count);

bool            hashtable_itor_first(hashtable_itor* itor);

bool            hashtable_itor_last(hashtable_itor* itor);

bool            hashtable_itor_search(hashtable_itor* itor, const void* key);

const void*     hashtable_itor_key(const hashtable_itor* itor);

void**          hashtable_itor_datum(hashtable_itor* itor);

bool            hashtable_itor_remove(hashtable_itor* itor);


END_DECL


#endif /* !LIBDICT_HASHTABLE_H__ */

dict.h

BEGIN_DECL
#define BEGIN_DECL
Definition dict.h:42

dict_compare_func
int(* dict_compare_func)(const void *, const void *)
A pointer to a function that compares two keys.
Definition dict.h:59

dict_delete_func
void(* dict_delete_func)(void *, void *)
A pointer to a function that is called when a key-value pair gets removed from a dictionary.
Definition dict.h:62

dict_hash_func
unsigned(* dict_hash_func)(const void *)
A pointer to a function that returns the hash value of a key.
Definition dict.h:66

END_DECL
#define END_DECL
Definition dict.h:43

dict_visit_func
bool(* dict_visit_func)(const void *, void *, void *)
A pointer to a function used for iterating over dictionary contents.
Definition dict.h:64

hashtable_free
size_t hashtable_free(hashtable *table, dict_delete_func delete_func)
Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL,...
Definition hashtable.c:187

hashtable_resize
bool hashtable_resize(hashtable *table, unsigned size)
Rehash the table into at least |size| slots, rounded up as in hashtable_new().
Definition hashtable.c:345

hashtable_itor_search
bool hashtable_itor_search(hashtable_itor *itor, const void *key)
Position |itor| on |key| and return true, or unposition it and return false if |key| is not present.
Definition hashtable.c:574

hashtable_remove
dict_remove_result hashtable_remove(hashtable *table, const void *key)
Remove the element with key |key|.
Definition hashtable.c:272

hashtable_dict_itor_new
dict_itor * hashtable_dict_itor_new(hashtable *table)
Like hashtable_itor_new(), but wrapped in a generic dict_itor for use with the dict_itor_* macros.
Definition hashtable.c:420

hashtable_itor_new
hashtable_itor * hashtable_itor_new(hashtable *table)
Create an iterator over |table| that is not positioned on any element yet.
Definition hashtable.c:407

hashtable_verify
bool hashtable_verify(const hashtable *table)
Check the internal invariants of the table and return true if they hold, or print the first failed ch...
Definition hashtable.c:386

hashtable_itor_last
bool hashtable_itor_last(hashtable_itor *itor)
Position |itor| on the last element in table order (unspecified) and return true, or unposition it an...
Definition hashtable.c:555

hashtable_itor_next
bool hashtable_itor_next(hashtable_itor *itor)
Move |itor| to the next element in table order (unspecified) and return true, or unposition it and re...
Definition hashtable.c:472

hashtable_itor_first
bool hashtable_itor_first(hashtable_itor *itor)
Position |itor| on the first element in table order (unspecified) and return true,...
Definition hashtable.c:539

hashtable_count
size_t hashtable_count(const hashtable *table)
Return the number of elements.
Definition hashtable.c:323

hashtable_itor_prevn
bool hashtable_itor_prevn(hashtable_itor *itor, size_t count)
Move |itor| |count| elements back and return whether it is still positioned.
Definition hashtable.c:529

hashtable_insert
dict_insert_result hashtable_insert(hashtable *table, void *key)
Insert |key| unless an equal key is present.
Definition hashtable.c:198

hashtable_itor_datum
void ** hashtable_itor_datum(hashtable_itor *itor)
Return the address of the datum |itor| is positioned on, through which it can be read or replaced,...
Definition hashtable.c:600

hashtable_itor_remove
bool hashtable_itor_remove(hashtable_itor *itor)
Remove the element |itor| is positioned on and unposition |itor|; return false if it was not position...
Definition hashtable.c:606

hashtable_itor_free
void hashtable_itor_free(hashtable_itor *itor)
Free an iterator.
Definition hashtable.c:434

hashtable_itor_nextn
bool hashtable_itor_nextn(hashtable_itor *itor, size_t count)
Move |itor| |count| elements forward and return whether it is still positioned.
Definition hashtable.c:519

hashtable_clear
size_t hashtable_clear(hashtable *table, dict_delete_func delete_func)
Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL.
Definition hashtable.c:290

hashtable_itor_prev
bool hashtable_itor_prev(hashtable_itor *itor)
Move |itor| to the previous element in table order (unspecified) and return true, or unposition it an...
Definition hashtable.c:494

hashtable_itor_invalidate
void hashtable_itor_invalidate(hashtable_itor *itor)
Unposition |itor|, so that it is not positioned on any element.
Definition hashtable.c:465

hashtable_traverse
size_t hashtable_traverse(hashtable *table, dict_visit_func visit, void *user_data)
Call |visit|(key, datum, |user_data|) for each element in table order (unspecified),...
Definition hashtable.c:310

hashtable_dict_new
dict * hashtable_dict_new(dict_compare_func cmp_func, dict_hash_func hash_func, unsigned size)
Like hashtable_new(), but wrapped in a generic dict for use with the dict_* macros.
Definition hashtable.c:168

hashtable_itor_valid
bool hashtable_itor_valid(const hashtable_itor *itor)
Return whether |itor| is positioned on an element.
Definition hashtable.c:459

hashtable_search
void ** hashtable_search(hashtable *table, const void *key)
Return the address of the datum stored for |key|, or NULL if |key| is not present.
Definition hashtable.c:243

hashtable_size
size_t hashtable_size(const hashtable *table)
Return the current number of slots in the table.
Definition hashtable.c:329

hashtable_slots_used
size_t hashtable_slots_used(const hashtable *table)
Return the number of slots whose chain is not empty.
Definition hashtable.c:335

hashtable_itor_key
const void * hashtable_itor_key(const hashtable_itor *itor)
Return the key |itor| is positioned on, or NULL if it is not positioned.
Definition hashtable.c:594

hashtable_new
hashtable * hashtable_new(dict_compare_func cmp_func, dict_hash_func hash_func, unsigned size)
Create an empty hash table that compares keys with |cmp_func| and hashes them with |hash_func| (neith...
Definition hashtable.c:144

dict_insert_result
Definition dict.h:80

dict_itor
Definition dict.h:234

dict_remove_result
Definition dict.h:85

dict
Definition dict.h:164

hashtable_itor
Definition hashtable.c:69

hashtable_itor::table
hashtable * table
Definition hashtable.c:70

hashtable
Definition hashtable.c:57

hashtable::size
unsigned size
Definition hashtable.c:62

hashtable::cmp_func
dict_compare_func cmp_func
Definition hashtable.c:59

hashtable::table
hash_node ** table
Definition hashtable.c:58

hashtable::hash_func
dict_hash_func hash_func
Definition hashtable.c:60