Changeset 1747 for trunk/psLib/src/collections/psList.h

Timestamp:

Sep 8, 2004, 4:23:27 PM (22 years ago)

Author:

desonia

Message:

changed order of psListAdd/psListRemove to match current SDRS.

File:

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

trunk/psLib/src/collections/psList.h

@@ -10 +10 @@
  *  @ingroup LinkedList
  *
- *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-11 20:04:51 $
+ *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-09-09 02:23:27 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -83 +83 @@
 bool psListAdd(
     psList* restrict list,             ///< list to add to (if NULL, nothing is done)
-    void *data,                        ///< data item to add.  If NULL, list is not modified.
-    int where                          ///< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location.
+    int location,                      ///< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location.
+    void *data                         ///< data item to add.  If NULL, list is not modified.
 );
 
-/** Remove an item from a list.  If which parameter is PS_LIST_UNKNOWN,
+/** Remove an item from a list.  If location parameter is PS_LIST_UNKNOWN,
  *
  *  @return bool        TRUE if element is successfully removed, otherwise FALSE.
@@ -94 +94 @@
     psList* restrict list,
     ///< list to remove element from
-    void *data,
-    ///< if which is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored.
-    int which
+    int location,
     ///< index of item, or PS_LIST_UNKNOWN, PS_LIST_NEXT, PS_LIST_PREV, or numbered location.
+    void *data
+    ///< if location is PS_LIST_UNKNOWN, data item to find and remove, otherwise this is ignored.
 );
 
 /** Retrieve an item from a list.
  *
- *  @return void*       the item corresponding to the which parameter.  If
- *                      which is invalid (e.g., a numbered index greater
+ *  @return void*       the item corresponding to the location parameter.  If
+ *                      location is invalid (e.g., a numbered index greater
  *                      than the list size or if the list is empty), a
  *                      NULL is returned.
@@ -109 +109 @@
 void *psListGet(
     psList* restrict list,             ///< list to retrieve element from
-    int which                          ///< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN
+    int location                       ///< index number, or PS_LIST_NEXT, PS_LIST_PREV, PS_LIST_UNKNOWN
 );
 
-/** Set the iterator of the list to a given position.  If where is invalid the
+/** Set the iterator of the list to a given position.  If location is invalid the
  *  iterator position is not changed.
  *
@@ -118 +118 @@
 void psListSetIterator(
     psList* restrict list,             ///< list to retrieve element from
-    int where                          ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL
+    int location                       ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL
 );