Changeset 1807 for trunk/psLib/src/collections/psBitSet.h

Timestamp:

Sep 14, 2004, 10:01:52 AM (22 years ago)

Author:

desonia

Message:

Updated files in src/collections to use new psError functionality. Also
cleaned up the code where needed, removing unnecessary error conditions,
etc.

File:

• trunk/psLib/src/collections/psBitSet.h (modified) (6 diffs)

trunk/psLib/src/collections/psBitSet.h

@@ -1 @@
-
 /** @file  psBitSet.h
  *
@@ -13 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-11 19:53:33 $
+ *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-09-14 20:01:52 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -26 +25 @@
 
 /******************************************************************************/
-
 /*  TYPE DEFINITIONS                                                          */
-
 /******************************************************************************/
 
@@ -44 +41 @@
 
 /*****************************************************************************/
-
 /* FUNCTION PROTOTYPES                                                       */
-
 /*****************************************************************************/
 
@@ -64 +59 @@
 /** Set a bit.
  *
- *  Sets a bit at a given bit location, either one or zero. The bit is set based on a zero index with the
+ *  Sets a bit at a given bit location. The bit is set based on a zero index with the
  *  first bit set in the zero bit slot of the zero element of the byte array. As an example, setting bit 3 in
  *  an array with two elements would result in an psBitSet that looks like 00000000 00001000.
@@ -74 +69 @@
     psBitSet* restrict inMask,         ///< Pointer to psBitSet to be set.
     int bit                            ///< Bit to be set.
+);
+
+/** Clear a bit.
+ *
+ *  Clear a bit at a given bit location. The bit is cleared based on a zero 
+ *  index with the first bit set in the zero bit slot of the zero element of 
+ *  the byte array. 
+ *
+ *  @return  psBitSet* : Pointer to struct containing psBitSet.
+ */
+psBitSet* psBitSetClear(
+    /* @returned@ */
+    psBitSet* restrict inMask,         ///< Pointer to psBitSet to be cleared.
+    int bit                            ///< Bit to be cleared.
 );