Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/avl_8c.html b/docs/doxygen/html/avl_8c.html index e9bd0c7..9403f2c 100644 --- a/docs/doxygen/html/avl_8c.html +++ b/docs/doxygen/html/avl_8c.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

avl.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/avl_8c_source.html b/docs/doxygen/html/avl_8c_source.html index 84e40e1..f8e5c2b 100644 --- a/docs/doxygen/html/avl_8c_source.html +++ b/docs/doxygen/html/avl_8c_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

avl.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/avl_8h.html b/docs/doxygen/html/avl_8h.html index 5a7ce81..e55f45c 100644 --- a/docs/doxygen/html/avl_8h.html +++ b/docs/doxygen/html/avl_8h.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

avl.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/avl_8h_source.html b/docs/doxygen/html/avl_8h_source.html index 8d266c6..a38c2f0 100644 --- a/docs/doxygen/html/avl_8h_source.html +++ b/docs/doxygen/html/avl_8h_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

avl.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/bt_8c.html b/docs/doxygen/html/bt_8c.html index 02213a5..31cf3b6 100644 --- a/docs/doxygen/html/bt_8c.html +++ b/docs/doxygen/html/bt_8c.html @@ -330,7 +330,7 @@ Functions

bt.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/bt_8c_source.html b/docs/doxygen/html/bt_8c_source.html index bcfb809..979994a 100644 --- a/docs/doxygen/html/bt_8c_source.html +++ b/docs/doxygen/html/bt_8c_source.html @@ -144,7 +144,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

bt.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/bt_8h.html b/docs/doxygen/html/bt_8h.html index d610afb..e45315e 100644 --- a/docs/doxygen/html/bt_8h.html +++ b/docs/doxygen/html/bt_8h.html @@ -409,7 +409,7 @@ Functions

bt.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/bt_8h_source.html b/docs/doxygen/html/bt_8h_source.html index 6e2731e..07aaa48 100644 --- a/docs/doxygen/html/bt_8h_source.html +++ b/docs/doxygen/html/bt_8h_source.html @@ -143,7 +143,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

bt.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/classes.html b/docs/doxygen/html/classes.html index db1741b..c5627cd 100644 --- a/docs/doxygen/html/classes.html +++ b/docs/doxygen/html/classes.html @@ -92,7 +92,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/dll_8c.html b/docs/doxygen/html/dll_8c.html index fc17b8f..92c8c94 100644 --- a/docs/doxygen/html/dll_8c.html +++ b/docs/doxygen/html/dll_8c.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

dll.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/dll_8c_source.html b/docs/doxygen/html/dll_8c_source.html index 8a30adf..d0cfb7f 100644 --- a/docs/doxygen/html/dll_8c_source.html +++ b/docs/doxygen/html/dll_8c_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

dll.c
Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/dll_8h.html b/docs/doxygen/html/dll_8h.html index c43f5fa..3aa837f 100644 --- a/docs/doxygen/html/dll_8h.html +++ b/docs/doxygen/html/dll_8h.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

dll.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/dll_8h_source.html b/docs/doxygen/html/dll_8h_source.html index bffbfee..e2a7c11 100644 --- a/docs/doxygen/html/dll_8h_source.html +++ b/docs/doxygen/html/dll_8h_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

dll.h
Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/files.html b/docs/doxygen/html/files.html index 8424042..4d45af9 100644 --- a/docs/doxygen/html/files.html +++ b/docs/doxygen/html/files.html @@ -99,7 +99,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/functions.html b/docs/doxygen/html/functions.html index 45fd20f..939727b 100644 --- a/docs/doxygen/html/functions.html +++ b/docs/doxygen/html/functions.html @@ -125,7 +125,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/functions_vars.html b/docs/doxygen/html/functions_vars.html index c8faa65..0c5e9ff 100644 --- a/docs/doxygen/html/functions_vars.html +++ b/docs/doxygen/html/functions_vars.html @@ -125,7 +125,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/globals.html b/docs/doxygen/html/globals.html index 392fe15..9d1737f 100644 --- a/docs/doxygen/html/globals.html +++ b/docs/doxygen/html/globals.html @@ -135,13 +135,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : ht.c , ht.h +

ht_find() +: ht.h +

ht_free() -: ht.h -, ht.c +: ht.c +, ht.h

ht_get() : ht.c -, ht.h

ht_hash_func : ht.h @@ -150,6 +152,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : ht.c , ht.h

ht_insert() +: ht.h +

ht_new() : ht.c , ht.h @@ -159,11 +164,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

ht_put() : ht.c -, ht.h

ht_resize() -: ht.h -, ht.c +: ht.c +, ht.h

@@ -206,11 +210,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

sll_pop_back() : sll.c -, sll.h +, sll.h

sll_pop_front() : sll.c -, sll.h +, sll.h

sll_push_back() : sll.h @@ -225,7 +229,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/globals_func.html b/docs/doxygen/html/globals_func.html index 2fb27bc..0956072 100644 --- a/docs/doxygen/html/globals_func.html +++ b/docs/doxygen/html/globals_func.html @@ -126,29 +126,33 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : ht.c , ht.h +

ht_find() +: ht.h +

ht_free() -: ht.h -, ht.c +: ht.c +, ht.h

ht_get() : ht.c -, ht.h

ht_hash_string() : ht.h , ht.c

ht_insert() +: ht.h +

ht_new() -: ht.c -, ht.h +: ht.h +, ht.c

ht_put() : ht.c -, ht.h

ht_resize() -: ht.h -, ht.c +: ht.c +, ht.h

@@ -188,11 +192,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

sll_pop_back() : sll.c -, sll.h +, sll.h

sll_pop_front() : sll.c -, sll.h +, sll.h

sll_push_back() : sll.c @@ -207,7 +211,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/globals_type.html b/docs/doxygen/html/globals_type.html index 9dcaace..8f43b6e 100644 --- a/docs/doxygen/html/globals_type.html +++ b/docs/doxygen/html/globals_type.html @@ -108,7 +108,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/graph_legend.html b/docs/doxygen/html/graph_legend.html index 9d76d8d..31f19c9 100644 --- a/docs/doxygen/html/graph_legend.html +++ b/docs/doxygen/html/graph_legend.html @@ -143,7 +143,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem

Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/ht_8c.html b/docs/doxygen/html/ht_8c.html index 5ea0a51..1fefc95 100644 --- a/docs/doxygen/html/ht_8c.html +++ b/docs/doxygen/html/ht_8c.html @@ -102,13 +102,11 @@ Functions unsigned int ht_hash_string (void *key) Takes a string key value and returns it's hashed value.
ht_table * ht_new (unsigned int size, ht_hash_func fn) - Creates a new hash table of the given size using the provided hash function or the built-in string hashing function otherwise.
+ Creates a new hash table.
void ht_free (ht_table *table, int free_key, int free_value) Frees all memory used by the provided hash table.
void ht_put (ht_table *table, void *key, void *val) - Inserts a key/value pair into the provided table.
void * ht_get (ht_table *table, void *key) - Retrieves a value from the provided table.
void ht_delete (ht_table *table, void *key, int free_key, int free_value) Deletes a key/value pair from the provided hash table.
ht_table * ht_resize (ht_table *table, unsigned int size) @@ -153,6 +151,7 @@ Functions

Deletes a key/value pair from the provided hash table.

This function looks up an entry in the table by hashing the key with the table's hash function. If an entry is found then the memory allocated for the entry is freed. If free_key or free_value are non-zero values then the key or value pointers are freed respectively.

Parameters:

@@ -199,6 +198,7 @@ Functions

Frees all memory used by the provided hash table.

This function frees all memory allocated for the given table. If free_key or free_value are non-zero values then the key or value pointers are freed respectively.

Parameters:

table The table from which the key/value pait will be deleted.

@@ -237,16 +237,6 @@ Functions

Retrieves a value from the provided table.

Parameters:: -

table The table to be freed.

- - -

table	The table in which to find the associated value.
key	The key to lookup.

Returns:: A pointer to the value associated with the provided key.

Definition at line 108 of file ht.c.

@@ -267,6 +257,7 @@ Functions

Takes a string key value and returns it's hashed value.

This function takes a pointer to a string and returns a hash value based on the contents of the string.

Parameters:

@@ -282,7 +273,7 @@ Here is the caller graph for this function:

- +

@@ -313,7 +304,8 @@ Here is the caller graph for this function:

Creates a new hash table of the given size using the provided hash function or the built-in string hashing function otherwise.

Creates a new hash table.

This fucntion creates a new empty hash table with an internal lookup table of the given size and the desired hash function. The hash function will be used for insertion, deletion, and lookup of elements within the table. If the hash function pointer is null then ht_hash_string is used.

Parameters:

key	Pointer to the string to hash.

@@ -367,16 +359,6 @@ Here is the call graph for this function:

Inserts a key/value pair into the provided table.

Parameters:: -

size	The size of the table to use for storing data.

- - - -

table	The table to be freed.
key	The key for the associated value.
val	The value to be associated with the key.

Definition at line 73 of file ht.c.

@@ -407,6 +389,7 @@ Here is the call graph for this function:

Resizes the underlying table used for storing key/value pairs.

This function allocates a new internal lookup table of the given size to replace the internal table for the provided hash table. After the new talbe is created, all entries from the old table are rehahsed and inserted into the new lookup table. The new lookup table then replaces the old lookup table and the old lookup table is freed.

Parameters:

@@ -425,7 +408,7 @@ Here is the call graph for this function:

ht.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.map b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.map index fca44ed..558618d 100644 --- a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.map +++ b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 index df52005..0ce7356 100644 --- a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 +++ b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 @@ -1 +1 @@ -c6c1dd045d4a706b458e14b275afbca8 \ No newline at end of file +a664916197e72d71cb6ce0dfa272dc10 \ No newline at end of file diff --git a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.png b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.png index 83e5f3b..ea72202 100644 Binary files a/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.png and b/docs/doxygen/html/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.png differ diff --git a/docs/doxygen/html/ht_8c_source.html b/docs/doxygen/html/ht_8c_source.html index d1a0264..1c9f5fe 100644 --- a/docs/doxygen/html/ht_8c_source.html +++ b/docs/doxygen/html/ht_8c_source.html @@ -124,7 +124,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00041 return hash; 00042 } 00043 -00044 ht_table* ht_new(unsigned int size, ht_hash_func fn) +00044 ht_table* ht_new(unsigned int size, ht_hash_func fn) 00045 { 00046 unsigned int table_size = size * sizeof(ht_node*); 00047 ht_table* table = (ht_table*) malloc( sizeof(ht_table) ); @@ -153,7 +153,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00070 } 00071 } 00072 -00073 void ht_put(ht_table* table, void* key, void* val) +00073 void ht_put(ht_table* table, void* key, void* val) 00074 { 00075 unsigned int index = table->hash_func( key ) % table->size; 00076 ht_node* cur = table->table[index]; @@ -188,7 +188,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00105 } 00106 } 00107 -00108 void* ht_get(ht_table* table, void* key) +00108 void* ht_get(ht_table* table, void* key) 00109 { 00110 void* ret = NULL; 00111 unsigned int index= table->hash_func( key ) % table->size; @@ -220,7 +220,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

ht.c
Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/ht_8h.html b/docs/doxygen/html/ht_8h.html index bf00903..16c3323 100644 --- a/docs/doxygen/html/ht_8h.html +++ b/docs/doxygen/html/ht_8h.html @@ -112,13 +112,13 @@ Functions

- + - - - - + + + + @@ -196,6 +196,7 @@ Functions

Deletes a key/value pair from the provided hash table.

Parameters:

table	The table to be resized.
unsigned int	ht_hash_string (void *key)
	Takes a string key value and returns it's hashed value.
ht_table *	ht_new (unsigned int size, ht_hash_func fn)
	Creates a new hash table of the given size using the provided hash function or the built-in string hashing function otherwise.
	Creates a new hash table.
void	ht_free (ht_table *table, int free_key, int free_value)
	Frees all memory used by the provided hash table.
void	ht_put (ht_table table, void key, void *val)
	Inserts a key/value pair into the provided table.
void *	ht_get (ht_table table, void key)
	Retrieves a value from the provided table.
void	ht_insert (ht_table table, void key, void *val)
	Inserts a key/value pair into the provided table.
void *	ht_find (ht_table table, void key)
	Retrieves a value from the provided table.
void	ht_delete (ht_table table, void key, int free_key, int free_value)
	Deletes a key/value pair from the provided hash table.
ht_table *	ht_resize (ht_table *table, unsigned int size)

@@ -210,12 +211,12 @@ Functions - +

table The table from which the key/value pait will be deleted.

- + @@ -223,14 +224,8 @@ Functions - - - - - - - - + + @@ -241,26 +236,25 @@ Functions

Frees all memory used by the provided hash table.

Retrieves a value from the provided table.

This function looks up an entry in the table by hashing the key with the table's hash function. It then returns the pointer to the value of the found entry or a null pointer if no entry was found.

Parameters:

void ht_free	void* ht_find	(	ht_table *	table,
		int	free_key,
		int	free_value	void *	key

- - - + +

table	The table to be freed.
free_key	Determines whether the key pointers will be freed.
free_value	Determines whether the value pointers will be freed.
table	The table in which to find the associated value.
key	The key to lookup.

- -

Definition at line 55 of file ht.c.

Returns:: A pointer to the value associated with the provided key.

- +

- + @@ -268,8 +262,14 @@ Functions - - + + + + + + + + @@ -280,17 +280,18 @@ Functions

Retrieves a value from the provided table.

Frees all memory used by the provided hash table.

This function frees all memory allocated for the given table. If free_key or free_value are non-zero values then the key or value pointers are freed respectively.

Parameters:

void* ht_get	void ht_free	(	ht_table *	table,
		void *	key	int	free_key,
		int	free_value

- - + + +

table	The table in which to find the associated value.
key	The key to lookup.
table	The table to be freed.
free_key	Determines whether the key pointers will be freed.
free_value	Determines whether the value pointers will be freed.

Returns:: A pointer to the value associated with the provided key.

Definition at line 108 of file ht.c.

Definition at line 55 of file ht.c.

@@ -310,6 +311,7 @@ Functions

Takes a string key value and returns it's hashed value.

This function takes a pointer to a string and returns a hash value based on the contents of the string.

Parameters:

@@ -325,27 +327,33 @@ Here is the caller graph for this function:

- +

key	Pointer to the string to hash.

- + - - + + - - + + + + + + + + @@ -356,50 +364,35 @@ Here is the caller graph for this function:

Creates a new hash table of the given size using the provided hash function or the built-in string hashing function otherwise.

Inserts a key/value pair into the provided table.

This function inserts a new entry into the provided table containing the provided key and value pointers. The entry is placed in the table by hashing the key with the provided table's hash function. If an entry with an identical key exists, then the value pointer for that entry is changed to the provided value pointer. If free_value is a non-zero value then the old value pointer is also freed.

Parameters:

ht_table* ht_new	void ht_insert	(	unsigned int	size,	ht_table *	table,
		ht_hash_func	fn	void *	key,
		void *	val

- - + + + +

size	The size of the table to use for storing data.
fn	The function to use for hasing keys.
table	The table to be freed.
key	The key for the associated value.
val	The value to be associated with the key.
free_value	Determines whether or not to free the old value pointer.

Returns:: The newly created table.

- -

Definition at line 44 of file ht.c.

- -

-Here is the call graph for this function:

- - -

- +

- + - - - - - - - - + + - - + + @@ -410,17 +403,27 @@ Here is the call graph for this function:

Inserts a key/value pair into the provided table.

Creates a new hash table.

Parameters:

void ht_put	ht_table* ht_new	(	ht_table *	table,
		void *	key,	unsigned int	size,
		void *	val	ht_hash_func	fn

- - - + +

table	The table to be freed.
key	The key for the associated value.
val	The value to be associated with the key.
size	The size of the table to use for storing data.
fn	The function to use for hasing keys.

Returns:: The newly created table.

Definition at line 73 of file ht.c.

Definition at line 44 of file ht.c.

+ +

+Here is the call graph for this function:

+ + +

@@ -450,6 +453,7 @@ Here is the call graph for this function:

Resizes the underlying table used for storing key/value pairs.

Parameters:

@@ -468,7 +472,7 @@ Here is the call graph for this function:

ht.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.map b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.map index fca44ed..558618d 100644 --- a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.map +++ b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 index df52005..0ce7356 100644 --- a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 +++ b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 @@ -1 +1 @@ -c6c1dd045d4a706b458e14b275afbca8 \ No newline at end of file +a664916197e72d71cb6ce0dfa272dc10 \ No newline at end of file diff --git a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.png b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.png index 83e5f3b..ea72202 100644 Binary files a/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.png and b/docs/doxygen/html/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.png differ diff --git a/docs/doxygen/html/ht_8h_source.html b/docs/doxygen/html/ht_8h_source.html index 1b69fc4..b691fd5 100644 --- a/docs/doxygen/html/ht_8h_source.html +++ b/docs/doxygen/html/ht_8h_source.html @@ -126,27 +126,27 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00052 ht_hash_func hash_func; 00053 } ht_table; 00054 -00062 unsigned int ht_hash_string(void* key); -00063 -00073 ht_table* ht_new(unsigned int size, ht_hash_func fn); -00074 -00082 void ht_free(ht_table* table, int free_key, int free_value); -00083 -00091 void ht_put(ht_table* table, void* key, void* val); -00092 -00101 void* ht_get(ht_table* table, void* key); -00102 -00111 void ht_delete(ht_table* table, void* key, int free_key, int free_value); -00112 -00121 ht_table* ht_resize(ht_table* table, unsigned int size); -00122 -00123 #endif +00065 unsigned int ht_hash_string(void* key); +00066 +00080 ht_table* ht_new(unsigned int size, ht_hash_func fn); +00081 +00093 void ht_free(ht_table* table, int free_key, int free_value); +00094 +00110 void ht_insert(ht_table* table, void* key, void* val); +00111 +00124 void* ht_find(ht_table* table, void* key); +00125 +00139 void ht_delete(ht_table* table, void* key, int free_key, int free_value); +00140 +00155 ht_table* ht_resize(ht_table* table, unsigned int size); +00156 +00157 #endif

ht.h
Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/index.html b/docs/doxygen/html/index.html index 49313f3..9147b53 100644 --- a/docs/doxygen/html/index.html +++ b/docs/doxygen/html/index.html @@ -79,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/rbt_8c.html b/docs/doxygen/html/rbt_8c.html index 206fcce..8a38976 100644 --- a/docs/doxygen/html/rbt_8c.html +++ b/docs/doxygen/html/rbt_8c.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

rbt.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/rbt_8c_source.html b/docs/doxygen/html/rbt_8c_source.html index 52d7310..b6bbd9f 100644 --- a/docs/doxygen/html/rbt_8c_source.html +++ b/docs/doxygen/html/rbt_8c_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

rbt.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/rbt_8h.html b/docs/doxygen/html/rbt_8h.html index bd0157e..9e877fa 100644 --- a/docs/doxygen/html/rbt_8h.html +++ b/docs/doxygen/html/rbt_8h.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

rbt.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/rbt_8h_source.html b/docs/doxygen/html/rbt_8h_source.html index 2520044..7ff5064 100644 --- a/docs/doxygen/html/rbt_8h_source.html +++ b/docs/doxygen/html/rbt_8h_source.html @@ -113,7 +113,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

rbt.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/search/all_68.html b/docs/doxygen/html/search/all_68.html index 6a920af..2c77c28 100644 --- a/docs/doxygen/html/search/all_68.html +++ b/docs/doxygen/html/search/all_68.html @@ -32,78 +32,84 @@

+ ht_find + ht.h +

- ht_free + ht_free

- ht_free(ht_table *table, int free_key, int free_value): ht.c - ht_free(ht_table *table, int free_key, int free_value): ht.c + ht_free(ht_table *table, int free_key, int free_value): ht.c + ht_free(ht_table *table, int free_key, int free_value): ht.c

- ht_get -

- ht_get(ht_table *table, void *key): ht.c - ht_get(ht_table *table, void *key): ht.c -

+ ht_get + ht.c

- ht_hash_func + ht_hash_func ht.h

- ht_hash_string + ht_hash_string

- ht_hash_string(void *key): ht.c - ht_hash_string(void *key): ht.c + ht_hash_string(void *key): ht.c + ht_hash_string(void *key): ht.c

+ ht_insert + ht.h +

- ht_new + ht_new

- ht_new(unsigned int size, ht_hash_func fn): ht.c - ht_new(unsigned int size, ht_hash_func fn): ht.c + ht_new(unsigned int size, ht_hash_func fn): ht.c + ht_new(unsigned int size, ht_hash_func fn): ht.c

- ht_node + ht_node

- ht_node - ht_node(): ht.h + ht_node + ht_node(): ht.h

- ht_put -

- ht_put(ht_table *table, void *key, void *val): ht.c - ht_put(ht_table *table, void *key, void *val): ht.c -

+ ht_put + ht.c

- ht_resize + ht_resize

- ht_resize(ht_table *table, unsigned int size): ht.c - ht_resize(ht_table *table, unsigned int size): ht.c + ht_resize(ht_table *table, unsigned int size): ht.c + ht_resize(ht_table *table, unsigned int size): ht.c

- ht_table + ht_table

Searching...

diff --git a/docs/doxygen/html/search/all_73.html b/docs/doxygen/html/search/all_73.html index d2dc9ce..13b8062 100644 --- a/docs/doxygen/html/search/all_73.html +++ b/docs/doxygen/html/search/all_73.html @@ -109,7 +109,7 @@ sll_pop_back

sll_pop_back(sll_node *list): sll.c - sll_pop_back(sll_node *list): sll.c + sll_pop_back(sll_node *list, int free_contents): sll.h

@@ -118,7 +118,7 @@ sll_pop_front

sll_pop_front(sll_node *list): sll.c - sll_pop_front(sll_node *list): sll.c + sll_pop_front(sll_node *list, int free_contents): sll.h

diff --git a/docs/doxygen/html/search/functions_68.html b/docs/doxygen/html/search/functions_68.html index 819cf90..bd8afc0 100644 --- a/docs/doxygen/html/search/functions_68.html +++ b/docs/doxygen/html/search/functions_68.html @@ -16,57 +16,63 @@ +

+ ht_find + ht.h +

- ht_free + ht_free

- ht_get -

- ht_get(ht_table *table, void *key): ht.c - ht_get(ht_table *table, void *key): ht.c -

+ ht_get + ht.c

- ht_hash_string + ht_hash_string

- ht_hash_string(void *key): ht.c - ht_hash_string(void *key): ht.c + ht_hash_string(void *key): ht.c + ht_hash_string(void *key): ht.c

+ ht_insert + ht.h +

- ht_new + ht_new

- ht_put -

- ht_put(ht_table *table, void *key, void *val): ht.c - ht_put(ht_table *table, void *key, void *val): ht.c -

+ ht_put + ht.c

- ht_resize + ht_resize

diff --git a/docs/doxygen/html/search/functions_73.html b/docs/doxygen/html/search/functions_73.html index be09f29..8f8c464 100644 --- a/docs/doxygen/html/search/functions_73.html +++ b/docs/doxygen/html/search/functions_73.html @@ -84,7 +84,7 @@ sll_pop_back

sll_pop_back(sll_node *list): sll.c - sll_pop_back(sll_node *list): sll.c + sll_pop_back(sll_node *list, int free_contents): sll.h

@@ -93,7 +93,7 @@ sll_pop_front

sll_pop_front(sll_node *list): sll.c - sll_pop_front(sll_node *list): sll.c + sll_pop_front(sll_node *list, int free_contents): sll.h

diff --git a/docs/doxygen/html/sll_8c.html b/docs/doxygen/html/sll_8c.html index 92d332c..40ac78f 100644 --- a/docs/doxygen/html/sll_8c.html +++ b/docs/doxygen/html/sll_8c.html @@ -110,9 +110,7 @@ Functions - - @@ -139,6 +137,7 @@ Functions

Finds and returns the last node in the supplied linked list.

This function returns a pointer to the last node in the given linked list.

Parameters:

table	The table to be resized.
sll_node *	sll_push_front (sll_node list, void contents)
	Adds a new node to the front of an existing linked list.
sll_node *	sll_pop_back (sll_node *list)
	Removes and returns a pointer to the last element of the list.
sll_node *	sll_pop_front (sll_node *list)
	Removes and returns a pointer to the first element of the list.
sll_node *	sll_insert (sll_node list, int index, void contents)
	Inserts a new node in a linked list at the specified index.
sll_node *	sll_delete (sll_node *list, int index, int free_contents)

@@ -192,11 +191,11 @@ Here is the caller graph for this function:

Deletes a node from the supplied list.

Deletes the node found at the supplied index from the supplied list and frees the memory used by the node and its contents.

This function traverses the list to the desired index and frees the memory allocated for that node. If the deleted node has a child then the child is reattached to the deleted node's parent. If free_contents is passed a non-zero value then the node's contents pointer is also freed.

Parameters:

list	The linked list to search.

- - + +

list
index
list	The list to operate on.
index	The index of the node to delete.
free_contents	Whether or not to also free the contents of the node.

Frees all memory used by a linked list.

Loops through the supplied list and frees all nodes. Also frees contents if free_contents is passed TRUE. This is to avoid trying to free memory allocated on the stack.

This function loops through the supplied list and frees all nodes. Also frees contents if free_contents is passed a non-zero value.

Parameters:

@@ -271,6 +270,7 @@ Here is the call graph for this function:

Finds and returns the first node in the supplied linked list.

This function returns a pointer to the first node in the given linked list.

Parameters:

list	The list to be freed.

@@ -309,7 +309,7 @@ Here is the call graph for this function:

Return the node at the specified index in a linked list.

Loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range.

This function loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range.

Parameters:

list	The linked list to search.

@@ -364,11 +364,12 @@ Here is the caller graph for this function:

Inserts a new node in a linked list at the specified index.

This function traverses the list to the desired index and inserts a new node with the given contents at that position. The node previously at the desired index becomes the child of the new node.

Parameters:

list	The list to search for the supplied index.

- - - + + +

list
index
contents
list	The list to operate on.
index	The index where the new node will be inserted.
contents	The contents of the new node.

@@ -403,7 +404,7 @@ Here is the call graph for this function:

Returns the number of elements in the list.

Loops through the supplied list and returns a count of the number of elements contained in the list.

This function loops through the supplied list and returns a count of the number of elements contained in the list.

Parameters:

@@ -432,7 +433,7 @@ Here is the call graph for this function:

Creates a new linked list node with the supplied value.

This function allocates a new node on the heap and populates the node contents with the supplied contents pointer.

This function allocates a new node and populates the node contents with the supplied contents pointer.

Parameters:

list	The list to be counted.

@@ -469,16 +470,6 @@ Here is the caller graph for this function:

Removes and returns a pointer to the last element of the list.

Parameters:: -

contents The contents of the newly created node.

- - -

list
contents

Returns:: Pointer to the newly added node.

Definition at line 80 of file sll.c.

@@ -498,16 +489,6 @@ Here is the caller graph for this function:

Removes and returns a pointer to the first element of the list.

Parameters:

- - - -

list
contents

Returns:: Pointer to the newly added node.

Definition at line 84 of file sll.c.

@@ -538,10 +519,11 @@ Here is the caller graph for this function:

Adds a new node to the end of an existing linked list.

This function creates a new node and pushes it to the end of the given list. The newly created node becomes the new tail of the list.

Parameters:

- - + +

list
contents
list	The list to operate on.
contents	The contents of the new node.

@@ -586,10 +568,11 @@ Here is the call graph for this function:

Adds a new node to the front of an existing linked list.

This function creates a new node and pushes it to the beginning of the given list. The newly created node becomes the new head of the list.

Parameters:

- - + +

list
contents
list	The list to operate on.
contents	The contents of the new node.

@@ -604,7 +587,7 @@ Here is the call graph for this function:

sll.c
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/sll_8c_source.html b/docs/doxygen/html/sll_8c_source.html index 7dcda9c..3154950 100644 --- a/docs/doxygen/html/sll_8c_source.html +++ b/docs/doxygen/html/sll_8c_source.html @@ -160,11 +160,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00077 { 00078 } 00079 -00080 sll_node* sll_pop_back( sll_node* list ) +00080 sll_node* sll_pop_back( sll_node* list ) 00081 { 00082 } 00083 -00084 sll_node* sll_pop_front( sll_node* list ) +00084 sll_node* sll_pop_front( sll_node* list ) 00085 { 00086 } 00087 @@ -230,7 +230,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

sll.c
Generated on Fri Mar 23 2012 11:12:03 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/sll_8h.html b/docs/doxygen/html/sll_8h.html index 03d1e85..86acd3e 100644 --- a/docs/doxygen/html/sll_8h.html +++ b/docs/doxygen/html/sll_8h.html @@ -113,14 +113,14 @@ Functions Finds and returns the last node in the supplied linked list.
sll_node * sll_index (sll_node *list, int index) Return the node at the specified index in a linked list.
-sll_node * sll_push_back (sll_node *list, void *contents) - Adds a new node to the end of an existing linked list.
sll_node * sll_push_front (sll_node *list, void *contents) Adds a new node to the front of an existing linked list.
-sll_node * sll_pop_back (sll_node *list) - Removes and returns a pointer to the last element of the list.
-sll_node * sll_pop_front (sll_node *list) - Removes and returns a pointer to the first element of the list.
+sll_node * sll_push_back (sll_node *list, void *contents) + Adds a new node to the end of an existing linked list.
+void sll_pop_front (sll_node *list, int free_contents) + Removes and returns a pointer to the first element of the list.
+void sll_pop_back (sll_node *list, int free_contents) + Removes and returns a pointer to the last element of the list.
sll_node * sll_insert (sll_node *list, int index, void *contents) Inserts a new node in a linked list at the specified index.
sll_node * sll_delete (sll_node *list, int index, int free_contents) @@ -163,6 +163,7 @@ Functions

Finds and returns the last node in the supplied linked list.

This function returns a pointer to the last node in the given linked list.

Parameters:

@@ -216,11 +217,11 @@ Here is the caller graph for this function:

Deletes a node from the supplied list.

Deletes the node found at the supplied index from the supplied list and frees the memory used by the node and its contents.

Parameters:

list	The linked list to search.

- - + +

list
index
list	The list to operate on.
index	The index of the node to delete.
free_contents	Whether or not to also free the contents of the node.

Frees all memory used by a linked list.

Loops through the supplied list and frees all nodes. Also frees contents if free_contents is passed TRUE. This is to avoid trying to free memory allocated on the stack.

This function loops through the supplied list and frees all nodes. Also frees contents if free_contents is passed a non-zero value.

Parameters:

@@ -295,6 +296,7 @@ Here is the call graph for this function:

Finds and returns the first node in the supplied linked list.

This function returns a pointer to the first node in the given linked list.

Parameters:

list	The list to be freed.

@@ -333,7 +335,7 @@ Here is the call graph for this function:

Return the node at the specified index in a linked list.

Loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range.

This function loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range.

Parameters:

list	The linked list to search.

@@ -388,11 +390,12 @@ Here is the caller graph for this function:

Inserts a new node in a linked list at the specified index.

This function traverses the list to the desired index and inserts a new node with the given contents at that position. The node previously at the desired index becomes the child of the new node.

Parameters:

list	The list to search for the supplied index.

- - - + + +

list
index
contents
list	The list to operate on.
index	The index where the new node will be inserted.
contents	The contents of the new node.

@@ -427,7 +430,7 @@ Here is the call graph for this function:

Returns the number of elements in the list.

Loops through the supplied list and returns a count of the number of elements contained in the list.

This function loops through the supplied list and returns a count of the number of elements contained in the list.

Parameters:

@@ -456,7 +459,7 @@ Here is the call graph for this function:

Creates a new linked list node with the supplied value.

This function allocates a new node on the heap and populates the node contents with the supplied contents pointer.

This function allocates a new node and populates the node contents with the supplied contents pointer.

Parameters:

list	The list to be counted.

@@ -478,62 +481,80 @@ Here is the caller graph for this function: - +

contents The contents of the newly created node.

- + - + + + + + + + + + + +

sll_node* sll_pop_back	void sll_pop_back	(	sll_node *	list	)	list,
		int	free_contents
	)

Removes and returns a pointer to the last element of the list.

This function removes the last node from the list and frees it's associated memory. If free_contents is passed a non-zero value then it's contents pointer is also freed. The second to last node in the list becomes the new tail of the list.

Parameters:

- - + +

list
contents
list	The list to operate on.
free_contents	Determines whether to free the contents pointer.

Returns:: Pointer to the newly added node.

Definition at line 80 of file sll.c.

- +

- + - + + + + + + + + + + +

sll_node* sll_pop_front	void sll_pop_front	(	sll_node *	list	)	list,
		int	free_contents
	)

Removes and returns a pointer to the first element of the list.

This function removes the first node from the list and frees it's associated memory. If free_contents is passed a non-zero value then it's contents pointer is also freed. The second node in the list becomes the new head of the list.

Parameters:

- - + +

list
contents
list	The lsit to operate on.
free_contents	Determines whether to free the contents pointer.

Returns:: Pointer to the newly added node.

Definition at line 84 of file sll.c.

@@ -562,10 +583,11 @@ Here is the caller graph for this function:

Adds a new node to the end of an existing linked list.

This function creates a new node and pushes it to the end of the given list. The newly created node becomes the new tail of the list.

Parameters:

- - + +

list
contents
list	The list to operate on.
contents	The contents of the new node.

@@ -610,10 +632,11 @@ Here is the call graph for this function:

Adds a new node to the front of an existing linked list.

This function creates a new node and pushes it to the beginning of the given list. The newly created node becomes the new head of the list.

Parameters:

- - + +

list
contents
list	The list to operate on.
contents	The contents of the new node.

@@ -628,7 +651,7 @@ Here is the call graph for this function:

sll.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/sll_8h_source.html b/docs/doxygen/html/sll_8h_source.html index 5ca3dbe..a688022 100644 --- a/docs/doxygen/html/sll_8h_source.html +++ b/docs/doxygen/html/sll_8h_source.html @@ -118,35 +118,35 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00038 00049 sll_node* sll_new( void* contents ); 00050 -00058 sll_node* sll_front(sll_node* list); -00059 -00067 sll_node* sll_back(sll_node* list); -00068 -00080 sll_node* sll_index(sll_node* list, int index); -00081 -00090 sll_node* sll_push_back( sll_node* list, void* contents ); -00091 -00100 sll_node* sll_push_front( sll_node* list, void* contents ); -00101 -00110 sll_node* sll_pop_back( sll_node* list ); +00060 sll_node* sll_front(sll_node* list); +00061 +00071 sll_node* sll_back(sll_node* list); +00072 +00084 sll_node* sll_index(sll_node* list, int index); +00085 +00097 sll_node* sll_push_front( sll_node* list, void* contents ); +00098 +00110 sll_node* sll_push_back( sll_node* list, void* contents ); 00111 -00120 sll_node* sll_pop_front( sll_node* list ); -00121 -00131 sll_node* sll_insert( sll_node* list, int index, void* contents); -00132 -00145 sll_node* sll_delete( sll_node* list, int index, int free_contents); -00146 -00157 void sll_free( sll_node* list, int free_contents); -00158 -00169 unsigned int sll_length(sll_node* list); -00170 -00171 #endif +00125 void sll_pop_front( sll_node* list, int free_contents ); +00126 +00140 void sll_pop_back( sll_node* list, int free_contents ); +00141 +00155 sll_node* sll_insert( sll_node* list, int index, void* contents); +00156 +00171 sll_node* sll_delete( sll_node* list, int index, int free_contents); +00172 +00182 void sll_free( sll_node* list, int free_contents); +00183 +00194 unsigned int sll_length(sll_node* list); +00195 +00196 #endif

sll.h
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structbt__node-members.html b/docs/doxygen/html/structbt__node-members.html index f49d8b6..b28b8b3 100644 --- a/docs/doxygen/html/structbt__node-members.html +++ b/docs/doxygen/html/structbt__node-members.html @@ -90,7 +90,7 @@ This is the complete list of members for

Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structbt__node.html b/docs/doxygen/html/structbt__node.html index 3936ba5..4d424b1 100644 --- a/docs/doxygen/html/structbt__node.html +++ b/docs/doxygen/html/structbt__node.html @@ -170,7 +170,7 @@ Public Attributes

bt_node
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structbt__tree-members.html b/docs/doxygen/html/structbt__tree-members.html index bea5d8c..eef4dbe 100644 --- a/docs/doxygen/html/structbt__tree-members.html +++ b/docs/doxygen/html/structbt__tree-members.html @@ -89,7 +89,7 @@ This is the complete list of members for

Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structbt__tree.html b/docs/doxygen/html/structbt__tree.html index 5ccb338..e3fe0a1 100644 --- a/docs/doxygen/html/structbt__tree.html +++ b/docs/doxygen/html/structbt__tree.html @@ -153,7 +153,7 @@ Public Attributes

bt_tree
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structht__node-members.html b/docs/doxygen/html/structht__node-members.html index 97192f6..6474298 100644 --- a/docs/doxygen/html/structht__node-members.html +++ b/docs/doxygen/html/structht__node-members.html @@ -90,7 +90,7 @@ This is the complete list of members for

Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structht__node.html b/docs/doxygen/html/structht__node.html index 13ec7d0..2ff6db4 100644 --- a/docs/doxygen/html/structht__node.html +++ b/docs/doxygen/html/structht__node.html @@ -165,7 +165,7 @@ Public Attributes

ht_node
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structht__table-members.html b/docs/doxygen/html/structht__table-members.html index 747eede..a827589 100644 --- a/docs/doxygen/html/structht__table-members.html +++ b/docs/doxygen/html/structht__table-members.html @@ -90,7 +90,7 @@ This is the complete list of members for

Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structht__table.html b/docs/doxygen/html/structht__table.html index 628ce81..6d549fb 100644 --- a/docs/doxygen/html/structht__table.html +++ b/docs/doxygen/html/structht__table.html @@ -172,7 +172,7 @@ Public Attributes

ht_table
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:04 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structsll__node-members.html b/docs/doxygen/html/structsll__node-members.html index 5153e2e..9e2383f 100644 --- a/docs/doxygen/html/structsll__node-members.html +++ b/docs/doxygen/html/structsll__node-members.html @@ -89,7 +89,7 @@ This is the complete list of members for

Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/html/structsll__node.html b/docs/doxygen/html/structsll__node.html index 08dd356..9b50f51 100644 --- a/docs/doxygen/html/structsll__node.html +++ b/docs/doxygen/html/structsll__node.html @@ -151,7 +151,7 @@ Public Attributes

sll_node
Generated on Fri Mar 23 2012 11:12:04 for Data Structures by +
Generated on Fri Mar 23 2012 12:45:05 for Data Structures by 1.7.3

diff --git a/docs/doxygen/latex/doxygen.sty b/docs/doxygen/latex/doxygen.sty index 81d7ea7..c86ecac 100644 --- a/docs/doxygen/latex/doxygen.sty +++ b/docs/doxygen/latex/doxygen.sty @@ -73,8 +73,8 @@ \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} \fancyfoot[LE]{\fancyplain{}{}} \fancyfoot[CE]{\fancyplain{}{}} -\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 23 2012 11:12:03 for Data Structures by Doxygen }} -\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 23 2012 11:12:03 for Data Structures by Doxygen }} +\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 23 2012 12:45:04 for Data Structures by Doxygen }} +\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 23 2012 12:45:04 for Data Structures by Doxygen }} \fancyfoot[CO]{\fancyplain{}{}} \fancyfoot[RO]{\fancyplain{}{}} %---------- Internal commands used in this style file ---------------- diff --git a/docs/doxygen/latex/ht_8c.tex b/docs/doxygen/latex/ht_8c.tex index 5a49634..88dfc09 100644 --- a/docs/doxygen/latex/ht_8c.tex +++ b/docs/doxygen/latex/ht_8c.tex @@ -19,13 +19,13 @@ Include dependency graph for ht.c:\nopagebreak unsigned int \hyperlink{ht_8c_a278174a0154a10b8b10b23937ca4c721}{ht\_\-hash\_\-string} (void $\ast$key) \begin{DoxyCompactList}\small\item\em Takes a string key value and returns it's hashed value. \item\end{DoxyCompactList}\item \hyperlink{structht__table}{ht\_\-table} $\ast$ \hyperlink{ht_8c_a0a3e03a29413673acd8899d250cd0844}{ht\_\-new} (unsigned int size, \hyperlink{ht_8h_a91a8d03489ef281e6f26d389c44d42cf}{ht\_\-hash\_\-func} fn) -\begin{DoxyCompactList}\small\item\em Creates a new hash table of the given size using the provided hash function or the built-\/in string hashing function otherwise. \item\end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Creates a new hash table. \item\end{DoxyCompactList}\item void \hyperlink{ht_8c_a96de71bf3880ed0a879f60b6e5254803}{ht\_\-free} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, int free\_\-key, int free\_\-value) \begin{DoxyCompactList}\small\item\em Frees all memory used by the provided hash table. \item\end{DoxyCompactList}\item void \hyperlink{ht_8c_a8c17c7288d2f510dd5c091cccc6dd056}{ht\_\-put} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key, void $\ast$val) -\begin{DoxyCompactList}\small\item\em Inserts a key/value pair into the provided table. \item\end{DoxyCompactList}\item +\item void $\ast$ \hyperlink{ht_8c_a5bc0ba0d31b944797e17a96372bce33e}{ht\_\-get} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key) -\begin{DoxyCompactList}\small\item\em Retrieves a value from the provided table. \item\end{DoxyCompactList}\item +\item void \hyperlink{ht_8c_a81a813f472a9b689032704fca76b3ce8}{ht\_\-delete} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key, int free\_\-key, int free\_\-value) \begin{DoxyCompactList}\small\item\em Deletes a key/value pair from the provided hash table. \item\end{DoxyCompactList}\item \hyperlink{structht__table}{ht\_\-table} $\ast$ \hyperlink{ht_8c_ad9cac6da8b459d5960079b0d95489960}{ht\_\-resize} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, unsigned int size) @@ -49,6 +49,8 @@ void \hyperlink{ht_8c_a81a813f472a9b689032704fca76b3ce8}{ht\_\-delete} (\hyperli Deletes a key/value pair from the provided hash table. +This function looks up an entry in the table by hashing the key with the table's hash function. If an entry is found then the memory allocated for the entry is freed. If free\_\-key or free\_\-value are non-\/zero values then the key or value pointers are freed respectively. + \begin{DoxyParams}{Parameters} {\em table} & The table from which the key/value pait will be deleted. \\ @@ -79,6 +81,8 @@ Definition at line 125 of file ht.c. Frees all memory used by the provided hash table. +This function frees all memory allocated for the given table. If free\_\-key or free\_\-value are non-\/zero values then the key or value pointers are freed respectively. + \begin{DoxyParams}{Parameters} {\em table} & The table to be freed. \\ @@ -104,20 +108,6 @@ Definition at line 55 of file ht.c. \label{ht_8c_a5bc0ba0d31b944797e17a96372bce33e} -Retrieves a value from the provided table. - - -\begin{DoxyParams}{Parameters} -{\em table} & The table in which to find the associated value. \\ -\hline -{\em key} & The key to lookup.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the value associated with the provided key. -\end{DoxyReturn} - - Definition at line 108 of file ht.c. \hypertarget{ht_8c_a278174a0154a10b8b10b23937ca4c721}{ @@ -133,6 +123,8 @@ Definition at line 108 of file ht.c. Takes a string key value and returns it's hashed value. +This function takes a pointer to a string and returns a hash value based on the contents of the string. + \begin{DoxyParams}{Parameters} {\em key} & Pointer to the string to hash.\\ @@ -147,7 +139,8 @@ Definition at line 32 of file ht.c. -Here is the caller graph for this function:\nopagebreak +Here is the caller graph for this function: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -168,7 +161,9 @@ Here is the caller graph for this function:\nopagebreak \label{ht_8c_a0a3e03a29413673acd8899d250cd0844} -Creates a new hash table of the given size using the provided hash function or the built-\/in string hashing function otherwise. +Creates a new hash table. + +This fucntion creates a new empty hash table with an internal lookup table of the given size and the desired hash function. The hash function will be used for insertion, deletion, and lookup of elements within the table. If the hash function pointer is null then ht\_\-hash\_\-string is used. \begin{DoxyParams}{Parameters} @@ -208,19 +203,6 @@ Here is the call graph for this function:\nopagebreak \label{ht_8c_a8c17c7288d2f510dd5c091cccc6dd056} -Inserts a key/value pair into the provided table. - - -\begin{DoxyParams}{Parameters} -{\em table} & The table to be freed. \\ -\hline -{\em key} & The key for the associated value. \\ -\hline -{\em val} & The value to be associated with the key. \\ -\hline -\end{DoxyParams} - - Definition at line 73 of file ht.c. \hypertarget{ht_8c_ad9cac6da8b459d5960079b0d95489960}{ @@ -237,6 +219,8 @@ Definition at line 73 of file ht.c. Resizes the underlying table used for storing key/value pairs. +This function allocates a new internal lookup table of the given size to replace the internal table for the provided hash table. After the new talbe is created, all entries from the old table are rehahsed and inserted into the new lookup table. The new lookup table then replaces the old lookup table and the old lookup table is freed. + \begin{DoxyParams}{Parameters} {\em table} & The table to be resized. \\ diff --git a/docs/doxygen/latex/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 b/docs/doxygen/latex/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 index a3f1e63..1e7f7fe 100644 --- a/docs/doxygen/latex/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 +++ b/docs/doxygen/latex/ht_8c_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 @@ -1 +1 @@ -a648bcf8938db9ae20e8ca6124b91987 \ No newline at end of file +5effe68ea7e27dd3011415a7f9133dc6 \ No newline at end of file diff --git a/docs/doxygen/latex/ht_8h.tex b/docs/doxygen/latex/ht_8h.tex index bc2ca0d..d4f4c87 100644 --- a/docs/doxygen/latex/ht_8h.tex +++ b/docs/doxygen/latex/ht_8h.tex @@ -29,12 +29,12 @@ typedef struct \hyperlink{structht__node}{ht\_\-node} \hyperlink{ht_8h_a3b70269a unsigned int \hyperlink{ht_8h_a278174a0154a10b8b10b23937ca4c721}{ht\_\-hash\_\-string} (void $\ast$key) \begin{DoxyCompactList}\small\item\em Takes a string key value and returns it's hashed value. \item\end{DoxyCompactList}\item \hyperlink{structht__table}{ht\_\-table} $\ast$ \hyperlink{ht_8h_a0a3e03a29413673acd8899d250cd0844}{ht\_\-new} (unsigned int size, \hyperlink{ht_8h_a91a8d03489ef281e6f26d389c44d42cf}{ht\_\-hash\_\-func} fn) -\begin{DoxyCompactList}\small\item\em Creates a new hash table of the given size using the provided hash function or the built-\/in string hashing function otherwise. \item\end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Creates a new hash table. \item\end{DoxyCompactList}\item void \hyperlink{ht_8h_a96de71bf3880ed0a879f60b6e5254803}{ht\_\-free} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, int free\_\-key, int free\_\-value) \begin{DoxyCompactList}\small\item\em Frees all memory used by the provided hash table. \item\end{DoxyCompactList}\item -void \hyperlink{ht_8h_a8c17c7288d2f510dd5c091cccc6dd056}{ht\_\-put} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key, void $\ast$val) +void \hyperlink{ht_8h_acb11ccfcef6f11d5e9ec31f14b875140}{ht\_\-insert} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key, void $\ast$val) \begin{DoxyCompactList}\small\item\em Inserts a key/value pair into the provided table. \item\end{DoxyCompactList}\item -void $\ast$ \hyperlink{ht_8h_a5bc0ba0d31b944797e17a96372bce33e}{ht\_\-get} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key) +void $\ast$ \hyperlink{ht_8h_a50855610a2e434aeec5180aa596d44a1}{ht\_\-find} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key) \begin{DoxyCompactList}\small\item\em Retrieves a value from the provided table. \item\end{DoxyCompactList}\item void \hyperlink{ht_8h_a81a813f472a9b689032704fca76b3ce8}{ht\_\-delete} (\hyperlink{structht__table}{ht\_\-table} $\ast$table, void $\ast$key, int free\_\-key, int free\_\-value) \begin{DoxyCompactList}\small\item\em Deletes a key/value pair from the provided hash table. \item\end{DoxyCompactList}\item @@ -84,6 +84,8 @@ A node in a hash table. Deletes a key/value pair from the provided hash table. +This function looks up an entry in the table by hashing the key with the table's hash function. If an entry is found then the memory allocated for the entry is freed. If free\_\-key or free\_\-value are non-\/zero values then the key or value pointers are freed respectively. + \begin{DoxyParams}{Parameters} {\em table} & The table from which the key/value pait will be deleted. \\ @@ -99,6 +101,32 @@ Deletes a key/value pair from the provided hash table. Definition at line 125 of file ht.c. +\hypertarget{ht_8h_a50855610a2e434aeec5180aa596d44a1}{ +\index{ht.h@{ht.h}!ht\_\-find@{ht\_\-find}} +\index{ht\_\-find@{ht\_\-find}!ht.h@{ht.h}} +\subsubsection[{ht\_\-find}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ht\_\-find ( +\begin{DoxyParamCaption} +\item[{{\bf ht\_\-table} $\ast$}]{table, } +\item[{void $\ast$}]{key} +\end{DoxyParamCaption} +)}} +\label{ht_8h_a50855610a2e434aeec5180aa596d44a1} + + +Retrieves a value from the provided table. + +This function looks up an entry in the table by hashing the key with the table's hash function. It then returns the pointer to the value of the found entry or a null pointer if no entry was found. + + +\begin{DoxyParams}{Parameters} +{\em table} & The table in which to find the associated value. \\ +\hline +{\em key} & The key to lookup.\\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +A pointer to the value associated with the provided key. +\end{DoxyReturn} \hypertarget{ht_8h_a96de71bf3880ed0a879f60b6e5254803}{ \index{ht.h@{ht.h}!ht\_\-free@{ht\_\-free}} \index{ht\_\-free@{ht\_\-free}!ht.h@{ht.h}} @@ -114,6 +142,8 @@ Definition at line 125 of file ht.c. Frees all memory used by the provided hash table. +This function frees all memory allocated for the given table. If free\_\-key or free\_\-value are non-\/zero values then the key or value pointers are freed respectively. + \begin{DoxyParams}{Parameters} {\em table} & The table to be freed. \\ @@ -127,34 +157,6 @@ Frees all memory used by the provided hash table. Definition at line 55 of file ht.c. -\hypertarget{ht_8h_a5bc0ba0d31b944797e17a96372bce33e}{ -\index{ht.h@{ht.h}!ht\_\-get@{ht\_\-get}} -\index{ht\_\-get@{ht\_\-get}!ht.h@{ht.h}} -\subsubsection[{ht\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ht\_\-get ( -\begin{DoxyParamCaption} -\item[{{\bf ht\_\-table} $\ast$}]{table, } -\item[{void $\ast$}]{key} -\end{DoxyParamCaption} -)}} -\label{ht_8h_a5bc0ba0d31b944797e17a96372bce33e} - - -Retrieves a value from the provided table. - - -\begin{DoxyParams}{Parameters} -{\em table} & The table in which to find the associated value. \\ -\hline -{\em key} & The key to lookup.\\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -A pointer to the value associated with the provided key. -\end{DoxyReturn} - - -Definition at line 108 of file ht.c. - \hypertarget{ht_8h_a278174a0154a10b8b10b23937ca4c721}{ \index{ht.h@{ht.h}!ht\_\-hash\_\-string@{ht\_\-hash\_\-string}} \index{ht\_\-hash\_\-string@{ht\_\-hash\_\-string}!ht.h@{ht.h}} @@ -168,6 +170,8 @@ Definition at line 108 of file ht.c. Takes a string key value and returns it's hashed value. +This function takes a pointer to a string and returns a hash value based on the contents of the string. + \begin{DoxyParams}{Parameters} {\em key} & Pointer to the string to hash.\\ @@ -182,7 +186,8 @@ Definition at line 32 of file ht.c. -Here is the caller graph for this function:\nopagebreak +Here is the caller graph for this function: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode @@ -191,6 +196,34 @@ Here is the caller graph for this function:\nopagebreak \end{figure} +\hypertarget{ht_8h_acb11ccfcef6f11d5e9ec31f14b875140}{ +\index{ht.h@{ht.h}!ht\_\-insert@{ht\_\-insert}} +\index{ht\_\-insert@{ht\_\-insert}!ht.h@{ht.h}} +\subsubsection[{ht\_\-insert}]{\setlength{\rightskip}{0pt plus 5cm}void ht\_\-insert ( +\begin{DoxyParamCaption} +\item[{{\bf ht\_\-table} $\ast$}]{table, } +\item[{void $\ast$}]{key, } +\item[{void $\ast$}]{val} +\end{DoxyParamCaption} +)}} +\label{ht_8h_acb11ccfcef6f11d5e9ec31f14b875140} + + +Inserts a key/value pair into the provided table. + +This function inserts a new entry into the provided table containing the provided key and value pointers. The entry is placed in the table by hashing the key with the provided table's hash function. If an entry with an identical key exists, then the value pointer for that entry is changed to the provided value pointer. If free\_\-value is a non-\/zero value then the old value pointer is also freed. + + +\begin{DoxyParams}{Parameters} +{\em table} & The table to be freed. \\ +\hline +{\em key} & The key for the associated value. \\ +\hline +{\em val} & The value to be associated with the key. \\ +\hline +{\em free\_\-value} & Determines whether or not to free the old value pointer. \\ +\hline +\end{DoxyParams} \hypertarget{ht_8h_a0a3e03a29413673acd8899d250cd0844}{ \index{ht.h@{ht.h}!ht\_\-new@{ht\_\-new}} \index{ht\_\-new@{ht\_\-new}!ht.h@{ht.h}} @@ -203,7 +236,9 @@ Here is the caller graph for this function:\nopagebreak \label{ht_8h_a0a3e03a29413673acd8899d250cd0844} -Creates a new hash table of the given size using the provided hash function or the built-\/in string hashing function otherwise. +Creates a new hash table. + +This fucntion creates a new empty hash table with an internal lookup table of the given size and the desired hash function. The hash function will be used for insertion, deletion, and lookup of elements within the table. If the hash function pointer is null then ht\_\-hash\_\-string is used. \begin{DoxyParams}{Parameters} @@ -230,34 +265,6 @@ Here is the call graph for this function:\nopagebreak \end{figure} -\hypertarget{ht_8h_a8c17c7288d2f510dd5c091cccc6dd056}{ -\index{ht.h@{ht.h}!ht\_\-put@{ht\_\-put}} -\index{ht\_\-put@{ht\_\-put}!ht.h@{ht.h}} -\subsubsection[{ht\_\-put}]{\setlength{\rightskip}{0pt plus 5cm}void ht\_\-put ( -\begin{DoxyParamCaption} -\item[{{\bf ht\_\-table} $\ast$}]{table, } -\item[{void $\ast$}]{key, } -\item[{void $\ast$}]{val} -\end{DoxyParamCaption} -)}} -\label{ht_8h_a8c17c7288d2f510dd5c091cccc6dd056} - - -Inserts a key/value pair into the provided table. - - -\begin{DoxyParams}{Parameters} -{\em table} & The table to be freed. \\ -\hline -{\em key} & The key for the associated value. \\ -\hline -{\em val} & The value to be associated with the key. \\ -\hline -\end{DoxyParams} - - -Definition at line 73 of file ht.c. - \hypertarget{ht_8h_ad9cac6da8b459d5960079b0d95489960}{ \index{ht.h@{ht.h}!ht\_\-resize@{ht\_\-resize}} \index{ht\_\-resize@{ht\_\-resize}!ht.h@{ht.h}} @@ -272,6 +279,8 @@ Definition at line 73 of file ht.c. Resizes the underlying table used for storing key/value pairs. +This function allocates a new internal lookup table of the given size to replace the internal table for the provided hash table. After the new talbe is created, all entries from the old table are rehahsed and inserted into the new lookup table. The new lookup table then replaces the old lookup table and the old lookup table is freed. + \begin{DoxyParams}{Parameters} {\em table} & The table to be resized. \\ diff --git a/docs/doxygen/latex/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 b/docs/doxygen/latex/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 index a3f1e63..1e7f7fe 100644 --- a/docs/doxygen/latex/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 +++ b/docs/doxygen/latex/ht_8h_a278174a0154a10b8b10b23937ca4c721_icgraph.md5 @@ -1 +1 @@ -a648bcf8938db9ae20e8ca6124b91987 \ No newline at end of file +5effe68ea7e27dd3011415a7f9133dc6 \ No newline at end of file diff --git a/docs/doxygen/latex/refman.tex b/docs/doxygen/latex/refman.tex index 8ffa925..16244b7 100644 --- a/docs/doxygen/latex/refman.tex +++ b/docs/doxygen/latex/refman.tex @@ -44,7 +44,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.7.3}\\ \vspace*{0.5cm} -{\small Fri Mar 23 2012 11:12:03}\\ +{\small Fri Mar 23 2012 12:45:04}\\ \end{center} \end{titlepage} \clearemptydoublepage diff --git a/docs/doxygen/latex/sll_8c.tex b/docs/doxygen/latex/sll_8c.tex index 3593d1a..f54fdf8 100644 --- a/docs/doxygen/latex/sll_8c.tex +++ b/docs/doxygen/latex/sll_8c.tex @@ -27,9 +27,9 @@ Include dependency graph for sll.c:\nopagebreak \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8c_acfe3ebc296fe75f1d0ee21195dd7b9bf}{sll\_\-push\_\-front} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, void $\ast$contents) \begin{DoxyCompactList}\small\item\em Adds a new node to the front of an existing linked list. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8c_af72e93329186ac936d2bf6f544aa1f6b}{sll\_\-pop\_\-back} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list) -\begin{DoxyCompactList}\small\item\em Removes and returns a pointer to the last element of the list. \item\end{DoxyCompactList}\item +\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8c_a1588e5a1f90852ee48403d5313d64269}{sll\_\-pop\_\-front} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list) -\begin{DoxyCompactList}\small\item\em Removes and returns a pointer to the first element of the list. \item\end{DoxyCompactList}\item +\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8c_a66769edc21579f71972ac90de6da4a9f}{sll\_\-insert} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int index, void $\ast$contents) \begin{DoxyCompactList}\small\item\em Inserts a new node in a linked list at the specified index. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8c_afd494f171c24981f0d7a007841f21cfe}{sll\_\-delete} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int index, int free\_\-contents) @@ -54,6 +54,8 @@ unsigned int \hyperlink{sll_8c_af5f6589df6d0ef48ed6f57ac5527ddfe}{sll\_\-length} Finds and returns the last node in the supplied linked list. +This function returns a pointer to the last node in the given linked list. + \begin{DoxyParams}{Parameters} {\em list} & The linked list to search.\\ @@ -92,13 +94,13 @@ Here is the caller graph for this function:\nopagebreak Deletes a node from the supplied list. -Deletes the node found at the supplied index from the supplied list and frees the memory used by the node and its contents. +This function traverses the list to the desired index and frees the memory allocated for that node. If the deleted node has a child then the child is reattached to the deleted node's parent. If free\_\-contents is passed a non-\/zero value then the node's contents pointer is also freed. \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em index} & \\ +{\em index} & The index of the node to delete. \\ \hline {\em free\_\-contents} & Whether or not to also free the contents of the node.\\ \hline @@ -135,7 +137,7 @@ Here is the call graph for this function:\nopagebreak Frees all memory used by a linked list. -Loops through the supplied list and frees all nodes. Also frees contents if free\_\-contents is passed TRUE. This is to avoid trying to free memory allocated on the stack. +This function loops through the supplied list and frees all nodes. Also frees contents if free\_\-contents is passed a non-\/zero value. \begin{DoxyParams}{Parameters} @@ -161,6 +163,8 @@ Definition at line 119 of file sll.c. Finds and returns the first node in the supplied linked list. +This function returns a pointer to the first node in the given linked list. + \begin{DoxyParams}{Parameters} {\em list} & The linked list to search.\\ @@ -187,7 +191,7 @@ Definition at line 38 of file sll.c. Return the node at the specified index in a linked list. -Loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range. +This function loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range. \begin{DoxyParams}{Parameters} @@ -229,13 +233,15 @@ Here is the caller graph for this function:\nopagebreak Inserts a new node in a linked list at the specified index. +This function traverses the list to the desired index and inserts a new node with the given contents at that position. The node previously at the desired index becomes the child of the new node. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em index} & \\ +{\em index} & The index where the new node will be inserted. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} @@ -269,7 +275,7 @@ Here is the call graph for this function:\nopagebreak Returns the number of elements in the list. -Loops through the supplied list and returns a count of the number of elements contained in the list. +This function loops through the supplied list and returns a count of the number of elements contained in the list. \begin{DoxyParams}{Parameters} @@ -296,7 +302,7 @@ Definition at line 134 of file sll.c. Creates a new linked list node with the supplied value. -This function allocates a new node on the heap and populates the node contents with the supplied contents pointer. +This function allocates a new node and populates the node contents with the supplied contents pointer. \begin{DoxyParams}{Parameters} @@ -332,20 +338,6 @@ Here is the caller graph for this function:\nopagebreak \label{sll_8c_af72e93329186ac936d2bf6f544aa1f6b} -Removes and returns a pointer to the last element of the list. - - -\begin{DoxyParams}{Parameters} -{\em list} & \\ -\hline -{\em contents} & \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the newly added node. -\end{DoxyReturn} - - Definition at line 80 of file sll.c. \hypertarget{sll_8c_a1588e5a1f90852ee48403d5313d64269}{ @@ -359,20 +351,6 @@ Definition at line 80 of file sll.c. \label{sll_8c_a1588e5a1f90852ee48403d5313d64269} -Removes and returns a pointer to the first element of the list. - - -\begin{DoxyParams}{Parameters} -{\em list} & \\ -\hline -{\em contents} & \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -Pointer to the newly added node. -\end{DoxyReturn} - - Definition at line 84 of file sll.c. \hypertarget{sll_8c_a19ad0a86a87451a3ab68ad6d18c3e3e0}{ @@ -389,11 +367,13 @@ Definition at line 84 of file sll.c. Adds a new node to the end of an existing linked list. +This function creates a new node and pushes it to the end of the given list. The newly created node becomes the new tail of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} @@ -428,11 +408,13 @@ Here is the call graph for this function:\nopagebreak Adds a new node to the front of an existing linked list. +This function creates a new node and pushes it to the beginning of the given list. The newly created node becomes the new head of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} diff --git a/docs/doxygen/latex/sll_8h.tex b/docs/doxygen/latex/sll_8h.tex index 3adff5f..1cb0e38 100644 --- a/docs/doxygen/latex/sll_8h.tex +++ b/docs/doxygen/latex/sll_8h.tex @@ -30,14 +30,14 @@ typedef struct \hyperlink{structsll__node}{sll\_\-node} \hyperlink{sll_8h_a168d6 \begin{DoxyCompactList}\small\item\em Finds and returns the last node in the supplied linked list. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_a0582f263482ead73d53b018978513540}{sll\_\-index} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int index) \begin{DoxyCompactList}\small\item\em Return the node at the specified index in a linked list. \item\end{DoxyCompactList}\item -\hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_a19ad0a86a87451a3ab68ad6d18c3e3e0}{sll\_\-push\_\-back} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, void $\ast$contents) -\begin{DoxyCompactList}\small\item\em Adds a new node to the end of an existing linked list. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_acfe3ebc296fe75f1d0ee21195dd7b9bf}{sll\_\-push\_\-front} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, void $\ast$contents) \begin{DoxyCompactList}\small\item\em Adds a new node to the front of an existing linked list. \item\end{DoxyCompactList}\item -\hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_af72e93329186ac936d2bf6f544aa1f6b}{sll\_\-pop\_\-back} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list) -\begin{DoxyCompactList}\small\item\em Removes and returns a pointer to the last element of the list. \item\end{DoxyCompactList}\item -\hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_a1588e5a1f90852ee48403d5313d64269}{sll\_\-pop\_\-front} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list) +\hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_a19ad0a86a87451a3ab68ad6d18c3e3e0}{sll\_\-push\_\-back} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, void $\ast$contents) +\begin{DoxyCompactList}\small\item\em Adds a new node to the end of an existing linked list. \item\end{DoxyCompactList}\item +void \hyperlink{sll_8h_a6702f6f18b540bd21165295eb3ca5c25}{sll\_\-pop\_\-front} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int free\_\-contents) \begin{DoxyCompactList}\small\item\em Removes and returns a pointer to the first element of the list. \item\end{DoxyCompactList}\item +void \hyperlink{sll_8h_a58add98a437335c8f927344215a40d11}{sll\_\-pop\_\-back} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int free\_\-contents) +\begin{DoxyCompactList}\small\item\em Removes and returns a pointer to the last element of the list. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_a66769edc21579f71972ac90de6da4a9f}{sll\_\-insert} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int index, void $\ast$contents) \begin{DoxyCompactList}\small\item\em Inserts a new node in a linked list at the specified index. \item\end{DoxyCompactList}\item \hyperlink{structsll__node}{sll\_\-node} $\ast$ \hyperlink{sll_8h_afd494f171c24981f0d7a007841f21cfe}{sll\_\-delete} (\hyperlink{structsll__node}{sll\_\-node} $\ast$list, int index, int free\_\-contents) @@ -74,6 +74,8 @@ A linked list node. Finds and returns the last node in the supplied linked list. +This function returns a pointer to the last node in the given linked list. + \begin{DoxyParams}{Parameters} {\em list} & The linked list to search.\\ @@ -112,13 +114,13 @@ Here is the caller graph for this function:\nopagebreak Deletes a node from the supplied list. -Deletes the node found at the supplied index from the supplied list and frees the memory used by the node and its contents. +This function traverses the list to the desired index and frees the memory allocated for that node. If the deleted node has a child then the child is reattached to the deleted node's parent. If free\_\-contents is passed a non-\/zero value then the node's contents pointer is also freed. \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em index} & \\ +{\em index} & The index of the node to delete. \\ \hline {\em free\_\-contents} & Whether or not to also free the contents of the node.\\ \hline @@ -155,7 +157,7 @@ Here is the call graph for this function:\nopagebreak Frees all memory used by a linked list. -Loops through the supplied list and frees all nodes. Also frees contents if free\_\-contents is passed TRUE. This is to avoid trying to free memory allocated on the stack. +This function loops through the supplied list and frees all nodes. Also frees contents if free\_\-contents is passed a non-\/zero value. \begin{DoxyParams}{Parameters} @@ -181,6 +183,8 @@ Definition at line 119 of file sll.c. Finds and returns the first node in the supplied linked list. +This function returns a pointer to the first node in the given linked list. + \begin{DoxyParams}{Parameters} {\em list} & The linked list to search.\\ @@ -207,7 +211,7 @@ Definition at line 38 of file sll.c. Return the node at the specified index in a linked list. -Loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range. +This function loops through the linked list and returns the node in the list at the specified index. Returns NULL if the index is out of range. \begin{DoxyParams}{Parameters} @@ -249,13 +253,15 @@ Here is the caller graph for this function:\nopagebreak Inserts a new node in a linked list at the specified index. +This function traverses the list to the desired index and inserts a new node with the given contents at that position. The node previously at the desired index becomes the child of the new node. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em index} & \\ +{\em index} & The index where the new node will be inserted. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} @@ -289,7 +295,7 @@ Here is the call graph for this function:\nopagebreak Returns the number of elements in the list. -Loops through the supplied list and returns a count of the number of elements contained in the list. +This function loops through the supplied list and returns a count of the number of elements contained in the list. \begin{DoxyParams}{Parameters} @@ -316,7 +322,7 @@ Definition at line 134 of file sll.c. Creates a new linked list node with the supplied value. -This function allocates a new node on the heap and populates the node contents with the supplied contents pointer. +This function allocates a new node and populates the node contents with the supplied contents pointer. \begin{DoxyParams}{Parameters} @@ -341,60 +347,58 @@ Here is the caller graph for this function:\nopagebreak \end{figure} -\hypertarget{sll_8h_af72e93329186ac936d2bf6f544aa1f6b}{ +\hypertarget{sll_8h_a58add98a437335c8f927344215a40d11}{ \index{sll.h@{sll.h}!sll\_\-pop\_\-back@{sll\_\-pop\_\-back}} \index{sll\_\-pop\_\-back@{sll\_\-pop\_\-back}!sll.h@{sll.h}} -\subsubsection[{sll\_\-pop\_\-back}]{\setlength{\rightskip}{0pt plus 5cm}{\bf sll\_\-node}$\ast$ sll\_\-pop\_\-back ( +\subsubsection[{sll\_\-pop\_\-back}]{\setlength{\rightskip}{0pt plus 5cm}void sll\_\-pop\_\-back ( \begin{DoxyParamCaption} -\item[{{\bf sll\_\-node} $\ast$}]{list} +\item[{{\bf sll\_\-node} $\ast$}]{list, } +\item[{int}]{free\_\-contents} \end{DoxyParamCaption} )}} -\label{sll_8h_af72e93329186ac936d2bf6f544aa1f6b} +\label{sll_8h_a58add98a437335c8f927344215a40d11} Removes and returns a pointer to the last element of the list. +This function removes the last node from the list and frees it's associated memory. If free\_\-contents is passed a non-\/zero value then it's contents pointer is also freed. The second to last node in the list becomes the new tail of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em contents} & \\ +{\em free\_\-contents} & Determines whether to free the contents pointer.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} Pointer to the newly added node. \end{DoxyReturn} - - -Definition at line 80 of file sll.c. - -\hypertarget{sll_8h_a1588e5a1f90852ee48403d5313d64269}{ +\hypertarget{sll_8h_a6702f6f18b540bd21165295eb3ca5c25}{ \index{sll.h@{sll.h}!sll\_\-pop\_\-front@{sll\_\-pop\_\-front}} \index{sll\_\-pop\_\-front@{sll\_\-pop\_\-front}!sll.h@{sll.h}} -\subsubsection[{sll\_\-pop\_\-front}]{\setlength{\rightskip}{0pt plus 5cm}{\bf sll\_\-node}$\ast$ sll\_\-pop\_\-front ( +\subsubsection[{sll\_\-pop\_\-front}]{\setlength{\rightskip}{0pt plus 5cm}void sll\_\-pop\_\-front ( \begin{DoxyParamCaption} -\item[{{\bf sll\_\-node} $\ast$}]{list} +\item[{{\bf sll\_\-node} $\ast$}]{list, } +\item[{int}]{free\_\-contents} \end{DoxyParamCaption} )}} -\label{sll_8h_a1588e5a1f90852ee48403d5313d64269} +\label{sll_8h_a6702f6f18b540bd21165295eb3ca5c25} Removes and returns a pointer to the first element of the list. +This function removes the first node from the list and frees it's associated memory. If free\_\-contents is passed a non-\/zero value then it's contents pointer is also freed. The second node in the list becomes the new head of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The lsit to operate on. \\ \hline -{\em contents} & \\ +{\em free\_\-contents} & Determines whether to free the contents pointer.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} Pointer to the newly added node. \end{DoxyReturn} - - -Definition at line 84 of file sll.c. - \hypertarget{sll_8h_a19ad0a86a87451a3ab68ad6d18c3e3e0}{ \index{sll.h@{sll.h}!sll\_\-push\_\-back@{sll\_\-push\_\-back}} \index{sll\_\-push\_\-back@{sll\_\-push\_\-back}!sll.h@{sll.h}} @@ -409,11 +413,13 @@ Definition at line 84 of file sll.c. Adds a new node to the end of an existing linked list. +This function creates a new node and pushes it to the end of the given list. The newly created node becomes the new tail of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} @@ -448,11 +454,13 @@ Here is the call graph for this function:\nopagebreak Adds a new node to the front of an existing linked list. +This function creates a new node and pushes it to the beginning of the given list. The newly created node becomes the new head of the list. + \begin{DoxyParams}{Parameters} -{\em list} & \\ +{\em list} & The list to operate on. \\ \hline -{\em contents} & \\ +{\em contents} & The contents of the new node.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} diff --git a/docs/doxygen/latex/structht__table.tex b/docs/doxygen/latex/structht__table.tex index 97f4a71..c520180 100644 --- a/docs/doxygen/latex/structht__table.tex +++ b/docs/doxygen/latex/structht__table.tex @@ -13,8 +13,7 @@ A hash table. -Collaboration diagram for ht\_\-table: -\nopagebreak +Collaboration diagram for ht\_\-table:\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/src/ht/ht.c b/src/ht/ht.c index f3b3e02..c71e672 100644 --- a/src/ht/ht.c +++ b/src/ht/ht.c @@ -52,7 +52,7 @@ ht_table* ht_new(unsigned int size, ht_hash_func fn) return table; } -void ht_free(ht_table* table) +void ht_free(ht_table* table, int free_key, int free_value) { int i = 0; for (i = 0; i < table->size; i++) @@ -70,7 +70,7 @@ void ht_free(ht_table* table) } } -int ht_put(ht_table* table, void* key, void* val) +void ht_put(ht_table* table, void* key, void* val) { unsigned int index = table->hash_func( key ) % table->size; ht_node* cur = table->table[index]; @@ -103,10 +103,9 @@ int ht_put(ht_table* table, void* key, void* val) table->table[ index ] = node; } } - return 1; } -void* ht_get(ht_table* table, char* key) +void* ht_get(ht_table* table, void* key) { void* ret = NULL; unsigned int index= table->hash_func( key ) % table->size; @@ -123,12 +122,12 @@ void* ht_get(ht_table* table, char* key) return ret; } -unsigned int ht_delete(ht_table* table, char* key) +void ht_delete(ht_table* table, void* key, int free_key, int free_value) { return 0; } -unsigned int ht_resize(ht_table* table, unsigned int size) +ht_table* ht_resize(ht_table* table, unsigned int size) { return 0; } diff --git a/src/ht/ht.h b/src/ht/ht.h index c7ed669..f0bcf11 100644 --- a/src/ht/ht.h +++ b/src/ht/ht.h @@ -24,14 +24,14 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ -#ifndef HASHTABLE_H -#define HASHTABLE_H +#ifndef HT_H +#define HT_H //! Hash function for hashing keys in a hash table typedef unsigned int (*ht_hash_func) (void*); //! A node in a hash table. -typedef struct node +typedef struct ht_node { //! Pointer to the key void* key; @@ -55,15 +55,22 @@ typedef struct /** * @brief Takes a string key value and returns it's hashed value. * - * @param key Pointer to the string to hash. + * This function takes a pointer to a string and returns a hash value based on + * the contents of the string. + * + * @param key Pointer to the string to hash. * * @return The hashed value of the key. **/ unsigned int ht_hash_string(void* key); /** - * @brief Creates a new hash table of the given size using the provided hash function - * or the built-in string hashing function otherwise. + * @brief Creates a new hash table + * + * This fucntion creates a new empty hash table with an internal lookup table + * of the given size and the desired hash function. The hash function will be + * used for insertion, deletion, and lookup of elements within the table. If + * the hash function pointer is null then ht_hash_string is used. * * @param size The size of the table to use for storing data. * @param fn The function to use for hasing keys. @@ -75,6 +82,10 @@ ht_table* ht_new(unsigned int size, ht_hash_func fn); /** * @brief Frees all memory used by the provided hash table. * + * This function frees all memory allocated for the given table. If free_key or + * free_value are non-zero values then the key or value pointers are freed + * respectively. + * * @param table The table to be freed. * @param free_key Determines whether the key pointers will be freed. * @param free_value Determines whether the value pointers will be freed. @@ -84,25 +95,42 @@ void ht_free(ht_table* table, int free_key, int free_value); /** * @brief Inserts a key/value pair into the provided table. * - * @param table The table to be freed. - * @param key The key for the associated value. - * @param val The value to be associated with the key. + * This function inserts a new entry into the provided table containing the + * provided key and value pointers. The entry is placed in the table by hashing + * the key with the provided table's hash function. If an entry with an + * identical key exists, then the value pointer for that entry is changed to + * the provided value pointer. If free_value is a non-zero value then the old + * value pointer is also freed. + * + * @param table The table to be freed. + * @param key The key for the associated value. + * @param val The value to be associated with the key. + * @param free_value Determines whether or not to free the old value pointer. **/ -void ht_put(ht_table* table, void* key, void* val); +void ht_insert(ht_table* table, void* key, void* val); /** * @brief Retrieves a value from the provided table. * + * This function looks up an entry in the table by hashing the key with the + * table's hash function. It then returns the pointer to the value of the found + * entry or a null pointer if no entry was found. + * * @param table The table in which to find the associated value. * @param key The key to lookup. * * @return A pointer to the value associated with the provided key. **/ -void* ht_get(ht_table* table, void* key); +void* ht_find(ht_table* table, void* key); /** * @brief Deletes a key/value pair from the provided hash table. * + * This function looks up an entry in the table by hashing the key with the + * table's hash function. If an entry is found then the memory allocated for + * the entry is freed. If free_key or free_value are non-zero values then the + * key or value pointers are freed respectively. + * * @param table The table from which the key/value pait will be deleted. * @param key The key for the key/value pair to be deleted. * @param free_key Determines whether the key pointer will be freed. @@ -113,6 +141,12 @@ void ht_delete(ht_table* table, void* key, int free_key, int free_value); /** * @brief Resizes the underlying table used for storing key/value pairs. * + * This function allocates a new internal lookup table of the given size to + * replace the internal table for the provided hash table. After the new talbe + * is created, all entries from the old table are rehahsed and inserted into + * the new lookup table. The new lookup table then replaces the old lookup + * table and the old lookup table is freed. + * * @param table The table to be resized. * @param size The new size for the table. * diff --git a/src/lists/single_link/sll.c b/src/lists/single_link/sll.c index decbf3d..1a9b072 100644 --- a/src/lists/single_link/sll.c +++ b/src/lists/single_link/sll.c @@ -27,9 +27,6 @@ #include "sll.h" #include -/****************************************************************************** - * Public Functions - ******************************************************************************/ sll_node* sll_new( void* contents ) { sll_node* list = (sll_node*)malloc( sizeof(sll_node) ); @@ -38,7 +35,11 @@ sll_node* sll_new( void* contents ) return list; } -sll_node* sll_last( sll_node* list ) +sll_node* sll_front( sll_node* list ) +{ +} + +sll_node* sll_back( sll_node* list ) { sll_node* node = list; while((node != NULL) && (node->next != NULL)) @@ -48,7 +49,7 @@ sll_node* sll_last( sll_node* list ) return node; } -sll_node* sll_get( sll_node* list, int index ) +sll_node* sll_index( sll_node* list, int index ) { int current = 0; sll_node* node = list; @@ -66,16 +67,28 @@ sll_node* sll_get( sll_node* list, int index ) return indexed_node; } -sll_node* sll_add( sll_node* list, void* contents ) +sll_node* sll_push_back( sll_node* list, void* contents ) { - sll_node* node = sll_last( list ); + sll_node* node = sll_back( list ); node->next = sll_new( contents ); } +sll_node* sll_push_front( sll_node* list, void* contents ) +{ +} + +sll_node* sll_pop_back( sll_node* list ) +{ +} + +sll_node* sll_pop_front( sll_node* list ) +{ +} + sll_node* sll_insert( sll_node* list, int index, void* contents ) { int req_index = ((index-1) < 0) ? 0 : index-1; - sll_node* node = sll_get( list, req_index ); + sll_node* node = sll_index( list, req_index ); if(node != NULL) { sll_node* next_next = node->next; @@ -88,7 +101,7 @@ sll_node* sll_insert( sll_node* list, int index, void* contents ) sll_node* sll_delete( sll_node* list, int index, int free_contents) { - sll_node* node = sll_get( list, (index-1)); + sll_node* node = sll_index( list, (index-1)); if((node != NULL) && (node->next != NULL)) { sll_node* node_to_delete = node->next; diff --git a/src/lists/single_link/sll.h b/src/lists/single_link/sll.h index 4b1c880..e29d71b 100644 --- a/src/lists/single_link/sll.h +++ b/src/lists/single_link/sll.h @@ -24,103 +24,170 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ -#ifndef LINKED_LIST_H -#define LINKED_LIST_H +#ifndef SLL_H +#define SLL_H -typedef struct node +//! A linked list node. +typedef struct sll_node { + //! Pointer to the contents the node void* contents; - struct node* next; + //! Pointer to next node in the list. + struct sll_node* next; } sll_node; /** - * @brief Creates a new linked list node with the supplied value. + * @brief Creates a new linked list node with the supplied value. * - * Allocates a new node on the heap and populates the node contents with the + * This function allocates a new node and populates the node contents with the * supplied contents pointer. * - * @param contents The contents of the newly created node. + * @param contents The contents of the newly created node. * - * @return A pointer to the newly created node. - * */ + * @return A pointer to the newly created node. + **/ sll_node* sll_new( void* contents ); /** - * @brief Finds and returns the last node in the supplied linked list. + * @brief Finds and returns the first node in the supplied linked list. + * + * This function returns a pointer to the first node in the given linked list. + * + * @param list The linked list to search. + * + * @return Pointer to the last node in the supplied list. + **/ +sll_node* sll_front(sll_node* list); + +/** + * @brief Finds and returns the last node in the supplied linked list. + * + * This function returns a pointer to the last node in the given linked list. * - * @param list The linked list to search. + * @param list The linked list to search. * - * @return Pointer to the last node in the supplied list. - * */ -sll_node* sll_last(sll_node* list); + * @return Pointer to the last node in the supplied list. + **/ +sll_node* sll_back(sll_node* list); /** * @brief Return the node at the specified index in a linked list. * - * Loops through the linked list and returns the node in the list at the - * specified index. Returns NULL if the index is out of range. + * This function loops through the linked list and returns the node in the list + * at the specified index. Returns NULL if the index is out of range. * - * @param list The list to search for the supplied index. - * @param index The index of the node to return. + * @param list The list to search for the supplied index. + * @param index The index of the node to return. * - * @return A pointer to the node and the supplied index, NULL if out of range. - * */ -sll_node* sll_get(sll_node* list, int index); + * @return A pointer to the node and the supplied index, NULL if out of range. + **/ +sll_node* sll_index(sll_node* list, int index); /** - * @brief Adds a new node to an existing linked list. + * @brief Adds a new node to the front of an existing linked list. * - * @param list - * @param contents + * This function creates a new node and pushes it to the beginning of the given + * list. The newly created node becomes the new head of the list. + * + * @param list The list to operate on. + * @param contents The contents of the new node. * * @return Pointer to the newly added node. - * */ -sll_node* sll_add( sll_node* list, void* contents ); + **/ +sll_node* sll_push_front( sll_node* list, void* contents ); + +/** + * @brief Adds a new node to the end of an existing linked list. + * + * This function creates a new node and pushes it to the end of the given list. + * The newly created node becomes the new tail of the list. + * + * @param list The list to operate on. + * @param contents The contents of the new node. + * + * @return Pointer to the newly added node. + **/ +sll_node* sll_push_back( sll_node* list, void* contents ); /** - * @brief Inserts a new node in a linked list at the specified index. + * @brief Removes and returns a pointer to the first element of the list. * - * @param list - * @param index - * @param contents + * This function removes the first node from the list and frees it's associated + * memory. If free_contents is passed a non-zero value then it's contents + * pointer is also freed. The second node in the list becomes the new head of + * the list. * - * @return Pointer to the newly inserted node, NULL if index is out of range. - * */ + * @param list The lsit to operate on. + * @param free_contents Determines whether to free the contents pointer. + * + * @return Pointer to the newly added node. + **/ +void sll_pop_front( sll_node* list, int free_contents ); + +/** + * @brief Removes and returns a pointer to the last element of the list. + * + * This function removes the last node from the list and frees it's associated + * memory. If free_contents is passed a non-zero value then it's contents + * pointer is also freed. The second to last node in the list becomes the new + * tail of the list. + * + * @param list The list to operate on. + * @param free_contents Determines whether to free the contents pointer. + * + * @return Pointer to the newly added node. + **/ +void sll_pop_back( sll_node* list, int free_contents ); + +/** + * @brief Inserts a new node in a linked list at the specified index. + * + * This function traverses the list to the desired index and inserts a new node + * with the given contents at that position. The node previously at the desired + * index becomes the child of the new node. + * + * @param list The list to operate on. + * @param index The index where the new node will be inserted. + * @param contents The contents of the new node. + * + * @return Pointer to the newly inserted node, NULL if index is out of range. + **/ sll_node* sll_insert( sll_node* list, int index, void* contents); /** - * @brief Deletes a node from the supplied list. + * @brief Deletes a node from the supplied list. * - * Deletes the node found at the supplied index from the supplied list and frees - * the memory used by the node and its contents. + * This function traverses the list to the desired index and frees the memory + * allocated for that node. If the deleted node has a child then the child is + * reattached to the deleted node's parent. If free_contents is passed a + * non-zero value then the node's contents pointer is also freed. * - * @param list - * @param index - * @param free_contents Whether or not to also free the contents of the node. + * @param list The list to operate on. + * @param index The index of the node to delete. + * @param free_contents Whether or not to also free the contents of the node. * * @return Pointer to the node that is now at the supplied index. - * */ + **/ sll_node* sll_delete( sll_node* list, int index, int free_contents); /** - * @brief Frees all memory used by a linked list. + * @brief Frees all memory used by a linked list. * - * Loops through the supplied list and frees all nodes. Also frees contents if - * free_contents is passed TRUE. This is to avoid trying to free memory - * allocated on the stack. + * This function loops through the supplied list and frees all nodes. + * Also frees contents if free_contents is passed a non-zero value. * - * @param list The list to be freed. - * @param free_contents Whether or not to also free the contents of each node. - * */ + * @param list The list to be freed. + * @param free_contents Whether or not to also free the contents of each node. + **/ void sll_free( sll_node* list, int free_contents); /** * @brief Returns the number of elements in the list. * - * Loops through the supplied list and returns a count of the number of elements - * contained in the list. + * This function loops through the supplied list and returns a count of the + * number of elements contained in the list. * - * @param list The list to be counted. + * @param list The list to be counted. * * @return The number of elements in the list. **/ diff --git a/src/trees/binary/bt.c b/src/trees/binary/bt.c index 7f6edcb..ab43b2d 100644 --- a/src/trees/binary/bt.c +++ b/src/trees/binary/bt.c @@ -24,4 +24,35 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ +#include "bt.h" + +bt_tree* bt_new(bt_compare_func compare) +{ + +} + +void bt_free(bt_tree* tree, int free_contents) +{ + +} + +int bt_compare_ptr(void* obj1, void* obj2) +{ + +} + +void bt_insert(bt_tree* tree, void* data) +{ + +} + +void bt_delete(bt_tree* tree, void* data) +{ + +} + +void* bt_find(bt_tree* tree, void* data) +{ + +} diff --git a/src/trees/binary/bt.h b/src/trees/binary/bt.h index 7f6edcb..3789c7f 100644 --- a/src/trees/binary/bt.h +++ b/src/trees/binary/bt.h @@ -24,4 +24,113 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ +#ifndef BT_H +#define BT_H +//! A function pointer for a comparison function. +typedef int (* bt_compare_func) (void*,void*); + +//! A binary tree node. +typedef struct bt_node +{ + //! The contents of the tree node. + void* contents; + //! The left child of the tree node. + struct bt_node* left; + //! the right child of the tree node. + struct bt_node* right; +} bt_node; + +//! A binary tree +typedef struct bt_tree +{ + //! The root of the binary tree + bt_node* root; + //! The function used to compare data + bt_compare_func compare; +} bt_tree; + +/** + * @brief Creates a new empty binary tree. + * + * This function creates a new empty binary search tree with the given + * comparison function. The comparison function will be used during searching, + * insertions, and deletions, to find and traverse the tree. + * + * @param compare The function to use for comparing items in the tree. + * + * @return Pointer to the newly created tree. + **/ +bt_tree* bt_new(bt_compare_func compare); + +/** + * @brief Frees the memory allocated for all nodes of a tree. + * + * This function frees all memory associated with the given tree. If + * free_contents has a non-zero value then the contents pointer of each node + * will aslo be freed. + * + * @param tree The tree to be freed. + * @param free_contents Determines whether the contents pointers will be freed. + **/ +void bt_free(bt_tree* tree, int free_contents); + +/** + * @brief Compares the value of two pointers. + * + * This function takes two pointers and compares their values returning an + * integral value representing the result of the comparison. A return value of + * zero indicates the pointers are equal. A positive value indicates that obj2 + * is greater than obj1 and a negative value indicates the opposite. + * + * @param obj1 The first object to be compared. + * @param obj2 The second object to be compared. + * + * @return The result of the comparison. + **/ +int bt_compare_ptr(void* obj1, void* obj2); + +/** + * @brief Inserts a new node into the tree. + * + * This function uses the tree's compare function to traverse the tree until an + * existing node with the given data is found or until a leaf node is reached. + * If a node exists containing the given data then no insertion is performed. + * If a leaf node is reached then the a new leaf node is created and set as the + * left or right child of that leaf node. + * + * @param tree The tree in which the node will be inserted. + * @param data The data that the new node will contain. + **/ +void bt_insert(bt_tree* tree, void* data); + +/** + * @brief Deletes a node for the tree. + * + * This function uses the tree's compare function to search the tree for a node + * containing the given data. If a node containing the data is found then the + * node is freed otherwise no deletion is performed. If free_contents is passed + * a non-zero value then the contents pointer of the node is also freed. + * + * @param tree The tree from which the node will be deleted. + * @param data The data to search for in the tree. + * @param free_contents Determines whether the contents pointer will be freed. + **/ +void bt_delete(bt_tree* tree, void* data, int free_contents); + +/** + * @brief Finds and returns the data from a node containing the given data. + * + * This function uses the tree's compare function to search the tree for a node + * containing the given data. If a node containing the given data is found then + * the pointer to the contents of the node is returned. Otherwise a null + * pointer is returned. + * + * @param tree The tree to be searched. + * @param data The data to be searched for. + * + * @return Pointer to the found data. + **/ +void* bt_find(bt_tree* tree, void* data); + +#endif diff --git a/tests/trees/binary/test_bt.c b/tests/trees/binary/test_bt.c new file mode 100644 index 0000000..9938588 --- /dev/null +++ b/tests/trees/binary/test_bt.c @@ -0,0 +1,16 @@ +#include "unity.h" + +// File Under Test +#include "bt.h" + +void setUp() +{ +} + +void tearDown() +{ +} + +//----------------------------------------------------------------------------- + +