X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=hashtable.h;h=a337df41ea03f7856595ab1d9aa15579dce51f51;hb=d2cbbe4ce6d8f6e1aa23b8fe639ed58edf1789b7;hp=4eae7571d24af74369b0f5ba55ebce40cd297a48;hpb=e3da449eadbf2c92bb80b8fff073c0fa7aea5ede;p=model-checker.git

diff --git a/hashtable.h b/hashtable.h
index 4eae757..a337df4 100644
--- a/hashtable.h
+++ b/hashtable.h
@@ -7,23 +7,74 @@
 
 #include <stdlib.h>
 #include <stdio.h>
+#include "mymemory.h"
+
+/**
+ * Hashtable linked node class, for chained storage of hash table conflicts. By
+ * default it is snapshotting, but you can pass in your own allocation
+ * functions.
+ *
+ * @tparam _Key    Type name for the key
+ * @tparam _Val    Type name for the values to be stored
+ * @tparam _malloc Provide your own 'malloc' for the table, or default to
+ *                 snapshotting.
+ * @tparam _calloc Provide your own 'calloc' for the table, or default to
+ *                 snapshotting.
+ * @tparam _free   Provide your own 'free' for the table, or default to
+ *                 snapshotting.
+ */
+template<typename _Key, typename _Val, void * (* _malloc)(size_t), void * (* _calloc)(size_t, size_t), void (*_free)(void *)>
+struct hashlistnode {
+	_Key key;
+	_Val val;
+	struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *next;
+
+	void * operator new(size_t size) {
+		return _malloc(size);
+	}
 
-template<typename _Key, typename _Val>
-	struct hashlistnode {
-		_Key key;
-		_Val val;
-		struct hashlistnode<_Key,_Val> *next;
-	};
+	void operator delete(void *p, size_t size) {
+		_free(p);
+	}
 
-/** Hashtable class.  By default it is snapshotting, but you can pass
-		in your own allocation functions. */
+	void * operator new[](size_t size) {
+		return _malloc(size);
+	}
 
-template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (* _malloc)(size_t)=malloc, void * (* _calloc)(size_t, size_t)=calloc, void (*_free)(void *)=free>
+	void operator delete[](void *p, size_t size) {
+		_free(p);
+	}
+};
+
+/**
+ * Hashtable class. By default it is snapshotting, but you can pass in your own
+ * allocation functions.
+ *
+ * @tparam _Key    Type name for the key
+ * @tparam _Val    Type name for the values to be stored
+ * @tparam _KeyInt Integer type that is at least as large as _Key. Used for key
+ *                 manipulation and storage.
+ * @tparam _Shift  Logical shift to apply to all keys. Default 0.
+ * @tparam _malloc Provide your own 'malloc' for the table, or default to
+ *                 snapshotting.
+ * @tparam _calloc Provide your own 'calloc' for the table, or default to
+ *                 snapshotting.
+ * @tparam _free   Provide your own 'free' for the table, or default to
+ *                 snapshotting.
+ */
+template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (* _malloc)(size_t)=snapshot_malloc, void * (* _calloc)(size_t, size_t)=snapshot_calloc, void (*_free)(void *)=snapshot_free>
 	class HashTable {
  public:
+	/**
+	 * Constructor
+	 * @param initialcapacity Sets the initial capacity of the hash table.
+	 * Default size 1024.
+	 * @param factor Sets the percentage full before the hashtable is
+	 * resized. Default ratio 0.5.
+	 */
 	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, _malloc, _calloc,_free> **) _calloc(initialcapacity, sizeof(struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *));
 		loadfactor = factor;
 		capacity = initialcapacity;
 		threshold = (unsigned int) (initialcapacity*loadfactor);
@@ -31,11 +82,12 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 		size = 0; // Initial number of elements in the hash
 	}
 
+	/** Destructor */
 	~HashTable() {
 		for(unsigned int i=0;i<capacity;i++) {
-			struct hashlistnode<_Key,_Val> * bin = table[i];
+			struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> * bin = table[i];
 			while(bin!=NULL) {
-				struct hashlistnode<_Key,_Val> * next=bin->next;
+				struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> * next=bin->next;
 				delete bin;
 				bin=next;
 			}
@@ -43,47 +95,47 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 		_free(table);
 	}
 
+	/** Override: new operator */
 	void * operator new(size_t size) {
 		return _malloc(size);
 	}
 
+	/** Override: delete operator */
 	void operator delete(void *p, size_t size) {
 		_free(p);
 	}
 
+	/** Override: new[] operator */
 	void * operator new[](size_t size) {
 		return _malloc(size);
 	}
 
-	void operator delete[](void *p, size_t size) {\
+	/** Override: delete[] operator */
+	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];
+		for(unsigned int i=0;i<capacity;i++) {
+			struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> * bin = table[i];
 			while(bin!=NULL) {
-				struct hashlistnode<_Key,_Val> * next=bin->next;
+				struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> * next=bin->next;
 				delete bin;
 				bin=next;
 			}
 		}
-		memset(table, 0, capacity*sizeof(struct hashlistnode<_Key, _Val> *));
+		memset(table, 0, capacity*sizeof(struct hashlistnode<_Key, _Val, _malloc, _calloc, _free> *));
 		size=0;
 	}
 
 	/** Put a key value pair into the table. */
 	void put(_Key key, _Val val) {
-		if(size > threshold) {
-			//Resize
-			unsigned int newsize = capacity << 1;
-			resize(newsize);
-		}
+		if (size > threshold)
+			resize(capacity << 1);
 
-		struct hashlistnode<_Key,_Val> *ptr = table[(((_KeyInt)key) & mask)>>_Shift];
-		size++;
-		struct hashlistnode<_Key,_Val> *search = ptr;
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *ptr = table[(((_KeyInt)key) & mask)>>_Shift];
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *search = ptr;
 
 		while(search!=NULL) {
 			if (search->key==key) {
@@ -93,24 +145,30 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 			search=search->next;
 		}
 
-		struct hashlistnode<_Key,_Val> *newptr=(struct hashlistnode<_Key,_Val> *)new struct hashlistnode<_Key,_Val>;
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *newptr=(struct hashlistnode<_Key,_Val,_malloc,_calloc,_free> *)new struct hashlistnode<_Key,_Val, _malloc, _calloc, _free>;
 		newptr->key=key;
 		newptr->val=val;
 		newptr->next=ptr;
 		table[(((_KeyInt)key)&mask)>>_Shift]=newptr;
+		size++;
 	}
 
-	/** Put a key entry into the table. */
-  _Val * ensureptr(_Key key) {
-		if(size > threshold) {
-			//Resize
-		  unsigned int newsize = capacity << 1;
-		  resize(newsize);
-	  }
-
-	  struct hashlistnode<_Key,_Val> *ptr = table[(((_KeyInt)key) & mask)>>_Shift];
-		size++;
-		struct hashlistnode<_Key,_Val> *search = ptr;
+	/**
+	 * @brief Get a valid pointer to a value corresponding to a given key
+	 *
+	 * Ensure that key is present in the hash table, then return a pointer
+	 * to its value bin. This may require either creating a new bin for
+	 * this key (with a default-constructed value) or simply locating and
+	 * returning a pointer to an existing value.
+	 * @param key The key to check
+	 * @return A pointer to the value in the table
+	 */
+	_Val * get_safe_ptr(_Key key) {
+		if (size > threshold)
+			resize(capacity << 1);
+
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *ptr = table[(((_KeyInt)key) & mask)>>_Shift];
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *search = ptr;
 
 		while(search!=NULL) {
 			if (search->key==key) {
@@ -119,16 +177,17 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 			search=search->next;
 		}
 
-		struct hashlistnode<_Key,_Val> *newptr=(struct hashlistnode<_Key,_Val> *)new struct hashlistnode<_Key,_Val>;
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *newptr=(struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *)new struct hashlistnode<_Key,_Val, _malloc, _calloc, _free>;
 		newptr->key=key;
 		newptr->next=ptr;
 		table[(((_KeyInt)key)&mask)>>_Shift]=newptr;
+		size++;
 		return &newptr->val;
 	}
 
 	/** Lookup the corresponding value for the given key. */
 	_Val get(_Key key) {
-		struct hashlistnode<_Key,_Val> *search = table[(((_KeyInt)key) & mask)>>_Shift];
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *search = table[(((_KeyInt)key) & mask)>>_Shift];
 
 		while(search!=NULL) {
 			if (search->key==key) {
@@ -141,7 +200,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 
 	/** Lookup the corresponding value for the given key. */
 	_Val * getptr(_Key key) {
-		struct hashlistnode<_Key,_Val> *search = table[(((_KeyInt)key) & mask)>>_Shift];
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *search = table[(((_KeyInt)key) & mask)>>_Shift];
 
 		while(search!=NULL) {
 			if (search->key==key) {
@@ -154,7 +213,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 
 	/** 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];
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *search = table[(((_KeyInt)key) & mask)>>_Shift];
 
 		while(search!=NULL) {
 			if (search->key==key) {
@@ -167,11 +226,11 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 
 	/** Resize the table. */
 	void resize(unsigned int newsize) {
-		struct hashlistnode<_Key,_Val> ** oldtable = table;
-		struct hashlistnode<_Key,_Val> ** newtable;
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> ** oldtable = table;
+		struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> ** 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, _malloc, _calloc, _free> **) _calloc(newsize, sizeof(struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> *))) == NULL) {
 			printf("Calloc error %s %d\n", __FILE__, __LINE__);
 			exit(-1);
 		}
@@ -182,14 +241,14 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 		mask = (newsize << _Shift)-1;
 
 		for(unsigned int i = 0; i < oldcapacity; i++) {
-			struct hashlistnode<_Key, _Val> * bin = oldtable[i];
+			struct hashlistnode<_Key, _Val, _malloc, _calloc, _free> * bin = oldtable[i];
 
 			while(bin!=NULL) {
 				_Key key=bin->key;
-				struct hashlistnode<_Key, _Val> * next=bin->next;
+				struct hashlistnode<_Key, _Val, _malloc, _calloc, _free> * next=bin->next;
 
 				unsigned int index = (((_KeyInt)key) & mask) >>_Shift;
-				struct hashlistnode<_Key, _Val> * tmp=newtable[index];
+				struct hashlistnode<_Key, _Val, _malloc, _calloc, _free> * tmp=newtable[index];
 				bin->next=tmp;
 				newtable[index]=bin;
 				bin = next;
@@ -200,7 +259,7 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 	}
 
  private:
-	struct hashlistnode<_Key,_Val> **table;
+	struct hashlistnode<_Key,_Val, _malloc, _calloc, _free> **table;
 	unsigned int capacity;
 	_KeyInt mask;
 	unsigned int size;