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

Timestamp:

Jan 3, 2005, 10:28:07 AM (22 years ago)

Author:

desonia

Message:

added psHashToArray function and cooresponding test.

File:

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

trunk/psLib/src/collections/psHash.h

@@ -10 +10 @@
  *  @author Robert Lupton, Princeton University
  *  @author George Gusciora, MHPCC
- *   
- *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-10-27 00:57:31 $
+ *  @author Robert DeSonia, MHPCC
+ *
+ *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-01-03 20:28:07 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -28 +29 @@
 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;                         ///< key for this item of data
+    psPtr data;                        ///< the data itself
+    struct psHashBucket* next;         ///< list of other possible keys
 }
 psHashBucket;
@@ -39 +40 @@
 typedef struct psHash
 {
-    psS32 nbucket;                ///< Number of buckets in hash table.
-    psHashBucket* *buckets;     ///< The bucket data.
+    psS32 nbucket;                     ///< Number of buckets in hash table.
+    psHashBucket* *buckets;            ///< The bucket data.
 }
 psHash;
 
 /// Allocate hash buckets in table.
-psHash* psHashAlloc(psS32 nbucket ///< The number of buckets to allocate.
-                   );
+psHash* psHashAlloc(
+    psS32 nbucket                  ///< The number of buckets to allocate.
+);
 
 /// Insert entry into table.
-psBool psHashAdd(psHash* table,  ///< table to insert in
-                 const char *key, ///< key to use
-                 psPtr data       ///< data to insert
-                );
+psBool psHashAdd(
+    psHash* table,                 ///< table to insert in
+    const char *key,               ///< key to use
+    psPtr data                     ///< data to insert
+);
 
 /// Lookup key in table.
-psPtr psHashLookup(psHash* table,      ///< table to lookup key in
-                   const char *key      ///< key to lookup
-                  );
+psPtr psHashLookup(
+    psHash* table,                 ///< table to lookup key in
+    const char *key                ///< key to lookup
+);
 
 /// Remove key from table.
-psBool psHashRemove(psHash* table,       ///< table to lookup key in
-                    const char *key       ///< key to lookup
-                   );
+psBool psHashRemove(
+    psHash* table,                 ///< table to lookup key in
+    const char *key                ///< key to lookup
+);
 
 /// List all keys in table.
-psList* psHashKeyList(psHash* table    ///< table to list keys from.
-                     );
+psList* psHashKeyList(
+    psHash* table                  ///< table to list keys from.
+);
+
+/** Create a psArray from a psHash contents.
+ *
+ *  @return psArray*       A new psArray with duplicate contents of the input psHash
+ */
+psArray* psHashToArray(
+    psHash* table                  ///< table to convert to psArray
+);
 
 /* \} */// End of DataGroup Functions