chashtbl.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: chashtbl.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Fri Mar 22 12:40:45 GMT 2013
 * Version : 0.51
 * ---
 * Description: A chained hash table - implemented as a pure, generic ADT container. 
 * 
 * Revision history - coming up below:
 *
 * Date        Revision message
 * 2013-01-30  Created this file initially
 * 2013-02-19  Made some revision to the Doxygen documentation. Enhanced the description of
 *             in/out parameters - i.e. double-pointers.             
 * 2013-03-21  Minor documentation clarifications.
 * 2015-03-31  This code ready for version 0.51
 *
 */

#ifndef _CHASHTBL_H_
#define _CHASHTBL_H_

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "slist.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct CHtbl_ *CHtbl;

  /* FUNCTION DECLARATIONS */


  CHtbl CHTBLinit(int buckets, 
                  int (*h)(const void *key),
                  int (*match)(const void *key1, const void *key2),
                  void (*destroy)(void *data));

  void CHTBLdestroy(CHtbl htbl);

  int CHTBLinsert(CHtbl htbl, const void *data);

  int CHTBLremove(CHtbl htbl, void **data);

  int CHTBLlookup(const CHtbl htbl, void **data);

  int CHTBLsize(CHtbl htbl);

  void CHTBLprint(CHtbl htbl, void (*callback)(const void *data));


#ifdef __cplusplus
}
#endif 

#endif /* _CHASHTBL_H_ */