Index: /trunk/psLib/src/types/psBitSet.c =================================================================== --- /trunk/psLib/src/types/psBitSet.c (revision 11707) +++ /trunk/psLib/src/types/psBitSet.c (revision 11708) @@ -11,6 +11,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.39 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-09 22:38:53 $ + * @version $Revision: 1.40 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-02-08 21:33:57 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -75,5 +75,8 @@ -psBitSet* psBitSetAlloc(long nalloc) +psBitSet* p_psBitSetAlloc(const char *file, + unsigned int lineno, + const char *func, + long nalloc) { if (nalloc < 0) { @@ -88,5 +91,5 @@ numBytes = ceil(nalloc / 8.0); - newObj = psAlloc(sizeof(psBitSet)); + newObj = p_psAlloc(file, lineno, func, sizeof(psBitSet)); psMemSetDeallocator(newObj, (psFreeFunc) bitSetFree); newObj->n = numBytes; @@ -100,4 +103,5 @@ return newObj; } + psBitSet* psBitSetSet(psBitSet* bitSet, Index: /trunk/psLib/src/types/psBitSet.h =================================================================== --- /trunk/psLib/src/types/psBitSet.h (revision 11707) +++ /trunk/psLib/src/types/psBitSet.h (revision 11708) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-23 22:47:23 $ + * @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-02-08 21:33:57 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -49,5 +49,6 @@ /** Checks the type of a particular pointer. * - * Uses the appropriate deallocation function in psMemBlock to check the ptr datatype. + * Uses the appropriate deallocation function in psMemBlock to check the ptr + * datatype. * * @return bool: True if the pointer matches a psBitSet structure, false otherwise. @@ -55,24 +56,38 @@ bool psMemCheckBitSet( psPtr ptr ///< the pointer whose type to check -) -; +); + /** Allocate a psBitSet. * - * Create a psBitSet with the number of bits specified by the user. All bits are set - * to zero upon allocation. + * Create a psBitSet with the number of bits specified by the user. All bits + * are set to zero upon allocation. * * @return psBitSet* : Pointer to struct containing array of bits and size of array. */ +#ifdef DOXYGEN psBitSet* psBitSetAlloc( long nalloc ///< Number of bits in psBitSet array ); +#else // ifdef DOXYGEN +psBitSet* p_psBitSetAlloc( + const char *file, ///< File of caller + unsigned int lineno, ///< Line number of caller + const char *func, ///< Function name of caller + long nalloc ///< Number of bits in psBitSet array +); +#define psBitSetAlloc(nalloc) \ + p_psBitSetAlloc(__FILE__, __LINE__, __func__, nalloc) +#endif // ifdef DOXYGEN + + + /** Set a bit. * - * 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. + * 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. * * @return psBitSet* : Pointer to struct containing psBitSet. @@ -82,4 +97,5 @@ long bit ///< Bit to be set. ); + /** Clear a bit. @@ -96,11 +112,12 @@ ); + /** 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. 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. + * 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. * * @return bool: True if successful, otherwise false @@ -111,8 +128,10 @@ ); + /** Perform a binary operation on two psBitSets * - * Perform an AND, OR, or XOR on two psBitSets. If the BitMasks are not the same size, - * the operation will not be performed and an error message will be logged. + * Perform an AND, OR, or XOR on two psBitSets. If the BitMasks are not the + * same size, the operation will not be performed and an error message will be + * logged. * * @return psBitSet* : Pointer to struct containing result of binary operation. @@ -125,8 +144,9 @@ ); + /** Perform a not operation on a psBitSet * - * Toggles bits in a psBitset. All zero bits are set to one and all one bits are set - * to zero. + * Toggles bits in a psBitset. All zero bits are set to one and all one bits + * are set to zero. * * @return psBitSet* : Pointer to struct containing result of operation. @@ -137,9 +157,10 @@ ); + /** Convert the psBitSet to a string of ones and zeros. * - * Converts the contents of a psBitSet to a string representation of its binary form of - * ones and zeros. The LSB is the right-most chracter. Each set of eight characters - * represents one byte. + * Converts the contents of a psBitSet to a string representation of its + * binary form of ones and zeros. The LSB is the right-most chracter. Each set + * of eight characters represents one byte. * * @return psString: Pointer to character array containing string data. @@ -149,4 +170,5 @@ ); + /// @} #endif // #ifndef PSBITSET_H