Changeset 4135 for trunk/psLib/src/collections/psHash.h

Timestamp:

Jun 7, 2005, 12:36:48 PM (21 years ago)

Author:

gusciora

Message:

Standarized the PS_ASSERTs for checking pointers.

File:

• trunk/psLib/src/collections/psHash.h (modified) (5 diffs)

trunk/psLib/src/collections/psHash.h

@@ -1 @@
-
 /** @file  psHash.h
  *  @brief Contains support for basic hashing functions.
@@ -9 +8 @@
  *
  *  @author Robert Lupton, Princeton University
- *  @author George Gusciora, MHPCC
  *  @author Robert DeSonia, MHPCC
+ *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-02-17 19:26:23 $
+ *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-07 22:36:48 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -29 +28 @@
 typedef struct psHashBucket
 {
-    char *key;                         ///< key for this item of data
-    psPtr data;                        ///< the data itself
-    struct psHashBucket* next;         ///< list of other possible keys
+    char *key;                         ///< The key for this item of data.
+    psPtr data;                        ///< The data itself.
+    struct psHashBucket* next;         ///< The list of other possible keys.
 }
 psHashBucket;
@@ -52 +51 @@
 /// Insert entry into table.
 psBool psHashAdd(
-    psHash* table,                 ///< table to insert in
-    const char *key,               ///< key to use
-    psPtr data                     ///< data to insert
+    psHash* table,                 ///< The table to insert in.
+    const char *key,               ///< The key to use.
+    psPtr data                     ///< The data to insert.
 );
 
 /// Lookup key in table.
 psPtr psHashLookup(
-    psHash* table,                 ///< table to lookup key in
-    const char *key                ///< key to lookup
+    psHash* table,                 ///< The table to lookup key in.
+    const char *key                ///< The key to lookup.
 );
 
 /// Remove key from table.
 psBool psHashRemove(
-    psHash* table,                 ///< table to lookup key in
-    const char *key                ///< key to lookup
+    psHash* table,                 ///< The table to lookup key in.
+    const char *key                ///< The key to lookup.
 );
 
 /// List all keys in table.
 psList* psHashKeyList(
-    psHash* table                  ///< table to list keys from.
+    psHash* table                  ///< The table to list keys from..
 );
 
@@ -79 +78 @@
  */
 psArray* psHashToArray(
-    psHash* table                  ///< table to convert to psArray
+    psHash* table                  ///< The table to convert to psArray.
 );