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

Timestamp:

Jun 9, 2004, 2:29:09 PM (22 years ago)

Author:

harman

Message:

Added more error checks

File:

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

trunk/psLib/src/collections/psBitSet.h

@@ -4 +4 @@
  *
  *  Bit masks are useful tools for toggling various flags and options. This set of functions module provides
- *  a mechanism to create an array of bits of arbitrary length and manipulate them with basic binary 
+ *  a mechanism to create an array of bits of arbitrary length and manipulate them with basic binary
  *  operations. A print function is also provided to display the entire set of bits in binary format as a
  *  string.
  *
  *  @author Ross Harman, MHPCC
- *   
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-05-08 00:08:27 $
+ *
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-10 00:28:58 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -25 +25 @@
 /** Struct containing array of bytes to hold bit data and corresponding array length.
  *
- *  The bits in the struct are assembled in as an array of bytes with eight bits per byte. The bits are 
+ *  The bits in the struct are assembled in as an array of bytes with eight bits per byte. The bits are
  *  arranged with the LSB in first (right most) position of the first array element.
  */
@@ -41 +41 @@
 /** Allocate a psBitSet.
  *
- *  Create a psBitSet with the number of bytes specified by the user. All bits are set to zero upon 
+ *  Create a psBitSet with the number of bytes specified by the user. All bits are set to zero upon
  *  allocation.
  *
@@ -48 +48 @@
 /*@null@*/
 psBitSet* psBitSetAlloc(
-    int n   /**< Number of bytes in psBitSet array */
+    int n   /**< Number of bits in psBitSet array */
 );
 
@@ -61 +61 @@
 /** 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, either one or zero. 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 +74 @@
 /** Test the value of a bit.
  *
- *  Prints the value of a bit at a given bit location, either one or zero. The resulting bit is based on a 
- *  zero index format with the first bit set in the zero bit slot of the zero element of the byte array 
+ *  Prints the value of a bit at a given bit location, either one or zero. The resulting bit is based on a
+ *  zero index format with the first bit set in the zero bit slot of the zero element of the byte array
  *  As an example, testing bit 3 in a psBitSet with two bytes that looks like 00000000 00001000 would return a
  *  value of one, since that is the value that was set.