hashtable: make more flexible
[model-checker.git] / hashtable.h
index b1cd3273290a47e94d0c3000c06e88a43e2cb97d..e59a995fd92347a361a785a2d5e36c646b1a7656 100644 (file)
@@ -1,3 +1,7 @@
+/** @file hashtable.h
+ *  @brief Hashtable.  Standard chained bucket variety.
+ */
+
 #ifndef HASHTABLE_H
 #define HASHTABLE_H
 
@@ -11,12 +15,15 @@ template<typename _Key, typename _Val>
                struct hashlistnode<_Key,_Val> *next;
        };
 
-template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
+/** Hashtable class.  By default it is snapshotting, but you can pass
+               in your own allocation functions. */
+
+template<typename _Key, typename _Val, typename _KeyInt, int _Shift, void * (* _malloc)(size_t)=malloc, void * (* _calloc)(size_t, size_t)=calloc, void (*_free)(void *)=free>
        class HashTable {
  public:
        HashTable(unsigned int initialcapacity=1024, double factor=0.5) {
                // Allocate space for the hash table
-               table = (struct hashlistnode<_Key,_Val> **) calloc(initialcapacity, sizeof(struct hashlistnode<_Key,_Val> *));
+               table = (struct hashlistnode<_Key,_Val> **) _calloc(initialcapacity, sizeof(struct hashlistnode<_Key,_Val> *));
                loadfactor = factor;
                capacity = initialcapacity;
                threshold = (unsigned int) (initialcapacity*loadfactor);
@@ -29,19 +36,36 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                        struct hashlistnode<_Key,_Val> * bin = table[i];
                        while(bin!=NULL) {
                                struct hashlistnode<_Key,_Val> * next=bin->next;
-                               free(bin);
+                               _free(bin);
                                bin=next;
                        }
                }
-               free(table);
+               _free(table);
+       }
+
+       void * operator new(size_t size) {
+               return _malloc(size);
+       }
+
+       void operator delete(void *p, size_t size) {
+               _free(p);
+       }
+
+       void * operator new[](size_t size) {
+               return _malloc(size);
+       }
+
+       void operator delete[](void *p, size_t size) {\
+               _free(p);
        }
 
+       /** Reset the table to its initial state. */
        void reset() {
                for(int i=0;i<capacity;i++) {
                        struct hashlistnode<_Key,_Val> * bin = table[i];
                        while(bin!=NULL) {
                                struct hashlistnode<_Key,_Val> * next=bin->next;
-                               free(bin);
+                               _free(bin);
                                bin=next;
                        }
                }
@@ -49,6 +73,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                size=0;
        }
 
+       /** Put a key value pair into the table. */
        void put(_Key key, _Val val) {
                if(size > threshold) {
                        //Resize
@@ -68,13 +93,14 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                        search=search->next;
                }
 
-               struct hashlistnode<_Key,_Val> *newptr=(struct hashlistnode<_Key,_Val> *)malloc(sizeof(struct hashlistnode<_Key,_Val>));
+               struct hashlistnode<_Key,_Val> *newptr=(struct hashlistnode<_Key,_Val> *)_malloc(sizeof(struct hashlistnode<_Key,_Val>));
                newptr->key=key;
                newptr->val=val;
                newptr->next=ptr;
                table[(((_KeyInt)key)&mask)>>_Shift]=newptr;
        }
 
+       /** Lookup the corresponding value for the given key. */
        _Val get(_Key key) {
                struct hashlistnode<_Key,_Val> *search = table[(((_KeyInt)key) & mask)>>_Shift];
 
@@ -87,6 +113,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                return (_Val)0;
        }
 
+       /** Check whether the table contains a value for the given key. */
        bool contains(_Key key) {
                struct hashlistnode<_Key,_Val> *search = table[(((_KeyInt)key) & mask)>>_Shift];
 
@@ -99,12 +126,13 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                return false;
        }
 
+       /** Resize the table. */
        void resize(unsigned int newsize) {
                struct hashlistnode<_Key,_Val> ** oldtable = table;
                struct hashlistnode<_Key,_Val> ** newtable;
                unsigned int oldcapacity = capacity;
 
-               if((newtable = (struct hashlistnode<_Key,_Val> **) calloc(newsize, sizeof(struct hashlistnode<_Key,_Val> *))) == NULL) {
+               if((newtable = (struct hashlistnode<_Key,_Val> **) _calloc(newsize, sizeof(struct hashlistnode<_Key,_Val> *))) == NULL) {
                        printf("Calloc error %s %d\n", __FILE__, __LINE__);
                        exit(-1);
                }
@@ -129,7 +157,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift>
                        }
                }
 
-               free(oldtable);            //Free the memory of the old hash table
+               _free(oldtable);            //Free the memory of the old hash table
        }
 
  private: