Index: /trunk/psLib/src/astro/psTime.h =================================================================== --- /trunk/psLib/src/astro/psTime.h (revision 4292) +++ /trunk/psLib/src/astro/psTime.h (revision 4293) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.30 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.31 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:10:59 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -76,5 +76,7 @@ * @return bool: True for success, false for failure. */ -psBool p_psTimeInit(const char *fileName); +psBool p_psTimeInit( + const char *fileName ///< File name containing config/data info +); /** Free memory persistant time data. Index: /trunk/psLib/src/astronomy/psTime.h =================================================================== --- /trunk/psLib/src/astronomy/psTime.h (revision 4292) +++ /trunk/psLib/src/astronomy/psTime.h (revision 4293) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.30 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.31 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:10:59 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -76,5 +76,7 @@ * @return bool: True for success, false for failure. */ -psBool p_psTimeInit(const char *fileName); +psBool p_psTimeInit( + const char *fileName ///< File name containing config/data info +); /** Free memory persistant time data. Index: /trunk/psLib/src/collections/psPixels.h =================================================================== --- /trunk/psLib/src/collections/psPixels.h (revision 4292) +++ /trunk/psLib/src/collections/psPixels.h (revision 4293) @@ -7,6 +7,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-11 02:19:05 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:11:02 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -21,8 +21,9 @@ /// @{ +/** Data structure for storing psPixel coordinates */ typedef struct { - psS32 x; - psS32 y; + psS32 x; ///< x coordinate + psS32 y; ///< y coordinate } psPixelCoord; @@ -32,15 +33,15 @@ * Usually an image mask is the best way to carry information about what * pixels mean what. However, in the case where the number of pixels in which - * we are interested is limited, it is more efficient to simply carry a list + * we are interested is limited, it is more efficient to simply carry a list * of pixels. An example of this is in the image combination code, where we * want to perform an operation on a relatively small fraction of pixels, and - * it is inefficient to go through an entire mask image checking each pixel. + * it is inefficient to go through an entire mask image checking each pixel. * */ typedef struct { - int n; - int nalloc; - psPixelCoord* data; + int n; ///< Number in usa + int nalloc; ///< Number allocated + psPixelCoord* data; ///< The pixel coordinates } psPixels; @@ -136,9 +137,12 @@ ); -/** Prints a psPixels to specified destination. */ +/** Prints a psPixels to specified destination. + * + * @return bool: True if successful. +*/ bool p_psPixelsPrint( - FILE *fd, - psPixels* pixels, - const char *name + FILE *fd, ///< destination file descriptor + psPixels* pixels, ///< psPixels to print + const char *name ///< printf-style format of header line ); Index: /trunk/psLib/src/dataManip/psRandom.h =================================================================== --- /trunk/psLib/src/dataManip/psRandom.h (revision 4292) +++ /trunk/psLib/src/dataManip/psRandom.h (revision 4293) @@ -10,6 +10,6 @@ * @author GLG, MHPCC * -* @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-17 00:11:05 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -33,24 +33,64 @@ */ +/** Enumeration containing a flag for psRandom types. */ typedef enum { - PS_RANDOM_TAUS ///< A maximally equidistributed combined Tausworthe generator. + PS_RANDOM_TAUS ///< A maximally equidistributed combined Tausworthe generator. } psRandomType; +/** Data structure for psRandom. + * Contains information on the psRandom type and GNU Scientific Library random number generator. + */ typedef struct { - psRandomType type; ///< The type of RNG - gsl_rng *gsl; ///< The RNG itself + psRandomType type; ///< The type of RNG + gsl_rng *gsl; ///< The RNG itself } psRandom; -psRandom *psRandomAlloc(psRandomType type, - psU64 seed); +/** Allocates a psRandom struct. + * + * @return psRandom*: A new psRandom structure. + */ +psRandom *psRandomAlloc( + psRandomType type, ///< The type of RNG + psU64 seed ///< Known value with which to seed the RNG +); -void psRandomReset(psRandom *rand, - psU64 seed); +/** Resets an existing psRandom struct. + * + * @return void + */ +void psRandomReset( + psRandom *rand, ///< Existing psRandom struct to reset + psU64 seed ///< Known value with which to seed the RNG +); -psF64 psRandomUniform(const psRandom *r); -psF64 psRandomGaussian(const psRandom *r); -psF64 psRandomPoisson(const psRandom *r, psF64 mean); +/** Random number generator based on a uniform distribution on [0,1). + * Uses gsl_rng_uniform. + * + * @return psF64: Random number. + */ +psF64 psRandomUniform( + const psRandom *r ///< psRandom struct for RNG +); + +/** Random number generator based on a Gaussian deviate, N(0,1). + * Uses gsl_ran_gaussian. + * + * @return psF64: Random number. + */ +psF64 psRandomGaussian( + const psRandom *r ///< psRandom struct for RNG +); + +/** Random number generator based on a Poisson distribution with the given mean. + * Uses gsl_ran_poisson. + * + * @return psF64: Random number. + */ +psF64 psRandomPoisson( + const psRandom *r, ///< psRandom struct for RNG + psF64 mean ///< Mean value +); /* \} */// End of MathGroup Functions Index: /trunk/psLib/src/dataManip/psStats.h =================================================================== --- /trunk/psLib/src/dataManip/psStats.h (revision 4292) +++ /trunk/psLib/src/dataManip/psStats.h (revision 4293) @@ -14,6 +14,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.42 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.43 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:11:05 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -37,20 +37,20 @@ // XXX: Is PS_STAT_ROBUST_FOR_SAMPLE obsolete? typedef enum { - PS_STAT_SAMPLE_MEAN = 0x000001, - PS_STAT_SAMPLE_MEDIAN = 0x000002, - PS_STAT_SAMPLE_STDEV = 0x000004, - PS_STAT_SAMPLE_QUARTILE = 0x000008, - PS_STAT_ROBUST_MEAN = 0x000010, - PS_STAT_ROBUST_MEDIAN = 0x000020, - PS_STAT_ROBUST_MODE = 0x000040, - PS_STAT_ROBUST_STDEV = 0x000080, - PS_STAT_ROBUST_QUARTILE = 0x000100, - PS_STAT_CLIPPED_MEAN = 0x000200, - PS_STAT_CLIPPED_STDEV = 0x000400, - PS_STAT_MAX = 0x000800, - PS_STAT_MIN = 0x001000, - PS_STAT_USE_RANGE = 0x002000, - PS_STAT_USE_BINSIZE = 0x004000, - PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 + PS_STAT_SAMPLE_MEAN = 0x000001, ///< Sample Mean + PS_STAT_SAMPLE_MEDIAN = 0x000002, ///< Sample Median + PS_STAT_SAMPLE_STDEV = 0x000004, ///< Sample Standard Deviation + PS_STAT_SAMPLE_QUARTILE = 0x000008, ///< Sample Quartile + PS_STAT_ROBUST_MEAN = 0x000010, ///< Robust Mean + PS_STAT_ROBUST_MEDIAN = 0x000020, ///< Robust Median + PS_STAT_ROBUST_MODE = 0x000040, ///< Robust Mode + PS_STAT_ROBUST_STDEV = 0x000080, ///< Robust Standarad Deviation + PS_STAT_ROBUST_QUARTILE = 0x000100, ///< Robust Quartile + PS_STAT_CLIPPED_MEAN = 0x000200, ///< Clipped Mean + PS_STAT_CLIPPED_STDEV = 0x000400, ///< Clipped Standard Deviation + PS_STAT_MAX = 0x000800, ///< Maximum + PS_STAT_MIN = 0x001000, ///< Minumum + PS_STAT_USE_RANGE = 0x002000, ///< Range + PS_STAT_USE_BINSIZE = 0x004000, ///< Binsize + PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 ///< Robust for sample } psStatsOptions; @@ -180,14 +180,74 @@ // XXX: Create a single, generic, version of the vector normalize function. // XXX: Ask IfA for a public psLib function. -void p_psNormalizeVectorRangeU8(psVector* myData, psU8 low, psU8 high); -void p_psNormalizeVectorRangeU16(psVector* myData, psU16 low, psU16 high); -void p_psNormalizeVectorRangeU32(psVector* myData, psU32 low, psU32 high); -void p_psNormalizeVectorRangeU64(psVector* myData, psU64 low, psU64 high); -void p_psNormalizeVectorRangeS8(psVector* myData, psS8 low, psS8 high); -void p_psNormalizeVectorRangeS16(psVector* myData, psS16 low, psS16 high); -void p_psNormalizeVectorRangeS32(psVector* myData, psS32 low, psS32 high); -void p_psNormalizeVectorRangeS64(psVector* myData, psS64 low, psS64 high); -void p_psNormalizeVectorRangeF32(psVector* myData, psF32 low, psF32 high); -void p_psNormalizeVectorRangeF64(psVector* myData, psF64 low, psF64 high); + +/** Normalize the range of a vector containing U8 values */ +void p_psNormalizeVectorRangeU8( + psVector* myData, ///< Vector containing the U8 values + psU8 low, ///< Minimum value + psU8 high ///< Maximum value +); + +/** Normalize the range of a vector containing U16 values */ +void p_psNormalizeVectorRangeU16( + psVector* myData, ///< Vector containing the U16 values + psU16 low, ///< Minimum value + psU16 high ///< Maximum value +); + +/** Normalize the range of a vector containing U32 values */ +void p_psNormalizeVectorRangeU32( + psVector* myData, ///< Vector containing the U32 values + psU32 low, ///< Minimum value + psU32 high ///< Maximum value +); + +/** Normalize the range of a vector containing U64 values */ +void p_psNormalizeVectorRangeU64( + psVector* myData, ///< Vector containing the U64 values + psU64 low, ///< Minimum value + psU64 high ///< Maximum value +); + +/** Normalize the range of a vector containing S8 values */ +void p_psNormalizeVectorRangeS8( + psVector* myData, ///< Vector containing the S8 values + psS8 low, ///< Minimum value + psS8 high ///< Maximum value +); + +/** Normalize the range of a vector containing S16 values */ +void p_psNormalizeVectorRangeS16( + psVector* myData, ///< Vector containing the S16 values + psS16 low, ///< Minimum value + psS16 high ///< Maximum value +); + +/** Normalize the range of a vector containing S32 values */ +void p_psNormalizeVectorRangeS32( + psVector* myData, ///< Vector containing the S32 values + psS32 low, ///< Minimum value + psS32 high ///< Maximum value +); + +/** Normalize the range of a vector containing S64 values */ +void p_psNormalizeVectorRangeS64( + psVector* myData, ///< Vector containing the S64 values + psS64 low, ///< Minimum value + psS64 high ///< Maximum value +); + +/** Normalize the range of a vector containing F32 values */ +void p_psNormalizeVectorRangeF32( + psVector* myData, ///< Vector containing the F32 values + psF32 low, ///< Minimum value + psF32 high ///< Maximum value +); + +/** Normalize the range of a vector containing F64 values */ +void p_psNormalizeVectorRangeF64( + psVector* myData, ///< Vector containing the F64 values + psF64 low, ///< Minimum value + psF64 high ///< Maximum value +); /// @} Index: /trunk/psLib/src/math/psRandom.h =================================================================== --- /trunk/psLib/src/math/psRandom.h (revision 4292) +++ /trunk/psLib/src/math/psRandom.h (revision 4293) @@ -10,6 +10,6 @@ * @author GLG, MHPCC * -* @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-17 00:11:05 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -33,24 +33,64 @@ */ +/** Enumeration containing a flag for psRandom types. */ typedef enum { - PS_RANDOM_TAUS ///< A maximally equidistributed combined Tausworthe generator. + PS_RANDOM_TAUS ///< A maximally equidistributed combined Tausworthe generator. } psRandomType; +/** Data structure for psRandom. + * Contains information on the psRandom type and GNU Scientific Library random number generator. + */ typedef struct { - psRandomType type; ///< The type of RNG - gsl_rng *gsl; ///< The RNG itself + psRandomType type; ///< The type of RNG + gsl_rng *gsl; ///< The RNG itself } psRandom; -psRandom *psRandomAlloc(psRandomType type, - psU64 seed); +/** Allocates a psRandom struct. + * + * @return psRandom*: A new psRandom structure. + */ +psRandom *psRandomAlloc( + psRandomType type, ///< The type of RNG + psU64 seed ///< Known value with which to seed the RNG +); -void psRandomReset(psRandom *rand, - psU64 seed); +/** Resets an existing psRandom struct. + * + * @return void + */ +void psRandomReset( + psRandom *rand, ///< Existing psRandom struct to reset + psU64 seed ///< Known value with which to seed the RNG +); -psF64 psRandomUniform(const psRandom *r); -psF64 psRandomGaussian(const psRandom *r); -psF64 psRandomPoisson(const psRandom *r, psF64 mean); +/** Random number generator based on a uniform distribution on [0,1). + * Uses gsl_rng_uniform. + * + * @return psF64: Random number. + */ +psF64 psRandomUniform( + const psRandom *r ///< psRandom struct for RNG +); + +/** Random number generator based on a Gaussian deviate, N(0,1). + * Uses gsl_ran_gaussian. + * + * @return psF64: Random number. + */ +psF64 psRandomGaussian( + const psRandom *r ///< psRandom struct for RNG +); + +/** Random number generator based on a Poisson distribution with the given mean. + * Uses gsl_ran_poisson. + * + * @return psF64: Random number. + */ +psF64 psRandomPoisson( + const psRandom *r, ///< psRandom struct for RNG + psF64 mean ///< Mean value +); /* \} */// End of MathGroup Functions Index: /trunk/psLib/src/math/psStats.h =================================================================== --- /trunk/psLib/src/math/psStats.h (revision 4292) +++ /trunk/psLib/src/math/psStats.h (revision 4293) @@ -14,6 +14,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.42 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.43 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:11:05 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -37,20 +37,20 @@ // XXX: Is PS_STAT_ROBUST_FOR_SAMPLE obsolete? typedef enum { - PS_STAT_SAMPLE_MEAN = 0x000001, - PS_STAT_SAMPLE_MEDIAN = 0x000002, - PS_STAT_SAMPLE_STDEV = 0x000004, - PS_STAT_SAMPLE_QUARTILE = 0x000008, - PS_STAT_ROBUST_MEAN = 0x000010, - PS_STAT_ROBUST_MEDIAN = 0x000020, - PS_STAT_ROBUST_MODE = 0x000040, - PS_STAT_ROBUST_STDEV = 0x000080, - PS_STAT_ROBUST_QUARTILE = 0x000100, - PS_STAT_CLIPPED_MEAN = 0x000200, - PS_STAT_CLIPPED_STDEV = 0x000400, - PS_STAT_MAX = 0x000800, - PS_STAT_MIN = 0x001000, - PS_STAT_USE_RANGE = 0x002000, - PS_STAT_USE_BINSIZE = 0x004000, - PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 + PS_STAT_SAMPLE_MEAN = 0x000001, ///< Sample Mean + PS_STAT_SAMPLE_MEDIAN = 0x000002, ///< Sample Median + PS_STAT_SAMPLE_STDEV = 0x000004, ///< Sample Standard Deviation + PS_STAT_SAMPLE_QUARTILE = 0x000008, ///< Sample Quartile + PS_STAT_ROBUST_MEAN = 0x000010, ///< Robust Mean + PS_STAT_ROBUST_MEDIAN = 0x000020, ///< Robust Median + PS_STAT_ROBUST_MODE = 0x000040, ///< Robust Mode + PS_STAT_ROBUST_STDEV = 0x000080, ///< Robust Standarad Deviation + PS_STAT_ROBUST_QUARTILE = 0x000100, ///< Robust Quartile + PS_STAT_CLIPPED_MEAN = 0x000200, ///< Clipped Mean + PS_STAT_CLIPPED_STDEV = 0x000400, ///< Clipped Standard Deviation + PS_STAT_MAX = 0x000800, ///< Maximum + PS_STAT_MIN = 0x001000, ///< Minumum + PS_STAT_USE_RANGE = 0x002000, ///< Range + PS_STAT_USE_BINSIZE = 0x004000, ///< Binsize + PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 ///< Robust for sample } psStatsOptions; @@ -180,14 +180,74 @@ // XXX: Create a single, generic, version of the vector normalize function. // XXX: Ask IfA for a public psLib function. -void p_psNormalizeVectorRangeU8(psVector* myData, psU8 low, psU8 high); -void p_psNormalizeVectorRangeU16(psVector* myData, psU16 low, psU16 high); -void p_psNormalizeVectorRangeU32(psVector* myData, psU32 low, psU32 high); -void p_psNormalizeVectorRangeU64(psVector* myData, psU64 low, psU64 high); -void p_psNormalizeVectorRangeS8(psVector* myData, psS8 low, psS8 high); -void p_psNormalizeVectorRangeS16(psVector* myData, psS16 low, psS16 high); -void p_psNormalizeVectorRangeS32(psVector* myData, psS32 low, psS32 high); -void p_psNormalizeVectorRangeS64(psVector* myData, psS64 low, psS64 high); -void p_psNormalizeVectorRangeF32(psVector* myData, psF32 low, psF32 high); -void p_psNormalizeVectorRangeF64(psVector* myData, psF64 low, psF64 high); + +/** Normalize the range of a vector containing U8 values */ +void p_psNormalizeVectorRangeU8( + psVector* myData, ///< Vector containing the U8 values + psU8 low, ///< Minimum value + psU8 high ///< Maximum value +); + +/** Normalize the range of a vector containing U16 values */ +void p_psNormalizeVectorRangeU16( + psVector* myData, ///< Vector containing the U16 values + psU16 low, ///< Minimum value + psU16 high ///< Maximum value +); + +/** Normalize the range of a vector containing U32 values */ +void p_psNormalizeVectorRangeU32( + psVector* myData, ///< Vector containing the U32 values + psU32 low, ///< Minimum value + psU32 high ///< Maximum value +); + +/** Normalize the range of a vector containing U64 values */ +void p_psNormalizeVectorRangeU64( + psVector* myData, ///< Vector containing the U64 values + psU64 low, ///< Minimum value + psU64 high ///< Maximum value +); + +/** Normalize the range of a vector containing S8 values */ +void p_psNormalizeVectorRangeS8( + psVector* myData, ///< Vector containing the S8 values + psS8 low, ///< Minimum value + psS8 high ///< Maximum value +); + +/** Normalize the range of a vector containing S16 values */ +void p_psNormalizeVectorRangeS16( + psVector* myData, ///< Vector containing the S16 values + psS16 low, ///< Minimum value + psS16 high ///< Maximum value +); + +/** Normalize the range of a vector containing S32 values */ +void p_psNormalizeVectorRangeS32( + psVector* myData, ///< Vector containing the S32 values + psS32 low, ///< Minimum value + psS32 high ///< Maximum value +); + +/** Normalize the range of a vector containing S64 values */ +void p_psNormalizeVectorRangeS64( + psVector* myData, ///< Vector containing the S64 values + psS64 low, ///< Minimum value + psS64 high ///< Maximum value +); + +/** Normalize the range of a vector containing F32 values */ +void p_psNormalizeVectorRangeF32( + psVector* myData, ///< Vector containing the F32 values + psF32 low, ///< Minimum value + psF32 high ///< Maximum value +); + +/** Normalize the range of a vector containing F64 values */ +void p_psNormalizeVectorRangeF64( + psVector* myData, ///< Vector containing the F64 values + psF64 low, ///< Minimum value + psF64 high ///< Maximum value +); /// @} Index: /trunk/psLib/src/psTest.h =================================================================== --- /trunk/psLib/src/psTest.h (revision 4292) +++ /trunk/psLib/src/psTest.h (revision 4293) @@ -5,6 +5,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:10:55 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -29,13 +29,15 @@ p_printFooter(filePtr, __FILE__, packageName, testPointName, success) +/** Specifies the format of a user-defined function for use with psTest functions. */ typedef psS32 (*testFcn)(void); +/** Defines a data structure containing test description information. */ typedef struct { - testFcn fcn; - psS32 testPointNumber; - const char* testPointName; - psS32 expectedReturn; - psBool isDuplicateEntry; + testFcn fcn; ///< Specified test function + psS32 testPointNumber; ///< Test Point Number + const char* testPointName; ///< Test Point Name + psS32 expectedReturn; ///< Expected return value + psBool isDuplicateEntry; ///< Is the entry a duplicate? } testDescription; @@ -50,45 +52,58 @@ /////////////////////////// PRIVATE FUNCTIONS ////////////////////////////// +///XXX: Comments correct? + +/** Procedure used to run a test. + * + * @return psBool: True if successful. + */ psBool p_runTest( - FILE *fp, - const char* testPointFile, - const char* packageName, - const char* testPointName, - testFcn fcn, - psS32 expectedReturn, - psBool useFork + FILE *fp, ///< File to test + const char* testPointFile, ///< Test point in file + const char* packageName, ///< Package name + const char* testPointName, ///< Test point name + testFcn fcn, ///< Function tested + psS32 expectedReturn, ///< Expected return + psBool useFork ///< Fork to use ); +/** Procedure used to run the test suite. + * + * @return psBool: True if successful. + */ psBool p_runTestSuite( - FILE *fp, - const char* testPointFile, - const char* packageName, - testDescription tests[], - psS32 argc, - char * const argv[] + FILE *fp, ///< File to test + const char* testPointFile, ///< Test point in file + const char* packageName, ///< Package name + testDescription tests[], ///< Description of tests + psS32 argc, ///< Number of test arguments + char * const argv[] ///< Test arguments ); +/** Prints a positive test header to file */ void p_printPositiveTestHeader( - FILE *fp, - const char* testPointFile, - const char* packageName, - const char* testPointName + FILE *fp, ///< File to which to print + const char* testPointFile, ///< Test point in file + const char* packageName, ///< Package name + const char* testPointName ///< Test point name ); +/** Prints a negative test header to file */ void p_printNegativeTestHeader( - FILE *fp, - const char* testPointFile, - const char* packageName, - const char* testPointName, - const char* expectedError, - psS32 exitValue + FILE *fp, ///< File to which to print + const char* testPointFile, ///< Test point in file + const char* packageName, ///< Package name + const char* testPointName, ///< Test point name + const char* expectedError, ///< Expected error + psS32 exitValue ///< Exit value ); +/** Prints a footer to file */ void p_printFooter( - FILE *fp, - const char* testPointFile, - const char* packageName, - const char* testPointName, - psBool success + FILE *fp, ///< File to which to print + const char* testPointFile, ///< Test point in file + const char* packageName, ///< Package name + const char* testPointName, ///< Test point name + psBool success ///< True if successful ); Index: /trunk/psLib/src/sys/psType.h =================================================================== --- /trunk/psLib/src/sys/psType.h (revision 4292) +++ /trunk/psLib/src/sys/psType.h (revision 4293) @@ -10,6 +10,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.33 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-17 00:11:08 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -52,4 +52,5 @@ #ifdef SWIG +/** 32-bit complex value */ typedef struct { @@ -57,4 +58,6 @@ } psC32; + +/** 64-bit complex value */ typedef struct { @@ -62,4 +65,5 @@ } psC64; + #else // SWIG typedef float _Complex psC32; ///< complex with 32-bit floating point Real and Imagary numbers @@ -70,4 +74,7 @@ typedef bool psBool; ///< boolean value +/** Enumeration of data types for function elements. + * Contains replacements for native types. + */ typedef enum { PS_TYPE_S8 = 0x0101, ///< Character. Index: /trunk/psLib/src/sysUtils/psType.h =================================================================== --- /trunk/psLib/src/sysUtils/psType.h (revision 4292) +++ /trunk/psLib/src/sysUtils/psType.h (revision 4293) @@ -10,6 +10,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.33 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ +* @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ +* @date $Date: 2005-06-17 00:11:08 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -52,4 +52,5 @@ #ifdef SWIG +/** 32-bit complex value */ typedef struct { @@ -57,4 +58,6 @@ } psC32; + +/** 64-bit complex value */ typedef struct { @@ -62,4 +65,5 @@ } psC64; + #else // SWIG typedef float _Complex psC32; ///< complex with 32-bit floating point Real and Imagary numbers @@ -70,4 +74,7 @@ typedef bool psBool; ///< boolean value +/** Enumeration of data types for function elements. + * Contains replacements for native types. + */ typedef enum { PS_TYPE_S8 = 0x0101, ///< Character. Index: /trunk/psLib/src/types/psPixels.h =================================================================== --- /trunk/psLib/src/types/psPixels.h (revision 4292) +++ /trunk/psLib/src/types/psPixels.h (revision 4293) @@ -7,6 +7,6 @@ * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-11 02:19:05 $ + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-17 00:11:02 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -21,8 +21,9 @@ /// @{ +/** Data structure for storing psPixel coordinates */ typedef struct { - psS32 x; - psS32 y; + psS32 x; ///< x coordinate + psS32 y; ///< y coordinate } psPixelCoord; @@ -32,15 +33,15 @@ * Usually an image mask is the best way to carry information about what * pixels mean what. However, in the case where the number of pixels in which - * we are interested is limited, it is more efficient to simply carry a list + * we are interested is limited, it is more efficient to simply carry a list * of pixels. An example of this is in the image combination code, where we * want to perform an operation on a relatively small fraction of pixels, and - * it is inefficient to go through an entire mask image checking each pixel. + * it is inefficient to go through an entire mask image checking each pixel. * */ typedef struct { - int n; - int nalloc; - psPixelCoord* data; + int n; ///< Number in usa + int nalloc; ///< Number allocated + psPixelCoord* data; ///< The pixel coordinates } psPixels; @@ -136,9 +137,12 @@ ); -/** Prints a psPixels to specified destination. */ +/** Prints a psPixels to specified destination. + * + * @return bool: True if successful. +*/ bool p_psPixelsPrint( - FILE *fd, - psPixels* pixels, - const char *name + FILE *fd, ///< destination file descriptor + psPixels* pixels, ///< psPixels to print + const char *name ///< printf-style format of header line );