Index: trunk/psLib/src/math/psCompare.h =================================================================== --- trunk/psLib/src/math/psCompare.h (revision 3264) +++ trunk/psLib/src/math/psCompare.h (revision 4162) @@ -6,11 +6,11 @@ * @ingroup Compare * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-02-17 19:26:23 $ + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2005-06-08 23:40:45 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ -#if !defined(PS_COMPARE_H) +#ifndef PS_COMPARE_H #define PS_COMPARE_H @@ -24,7 +24,7 @@ * e.g., for psList of pointers to numeric values. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ typedef int (*psComparePtrFcn) ( @@ -35,7 +35,7 @@ /** A comparison function for sorting. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ typedef int (*psCompareFcn) ( @@ -46,7 +46,7 @@ /** Compare function of psS8 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS8Ptr( @@ -57,7 +57,7 @@ /** Compare function of psS16 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS16Ptr( @@ -68,7 +68,7 @@ /** Compare function of psS32 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS32Ptr( @@ -79,7 +79,7 @@ /** Compare function of psS64 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS64Ptr( @@ -90,7 +90,7 @@ /** Compare function of psU8 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU8Ptr( @@ -101,7 +101,7 @@ /** Compare function of psU16 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU16Ptr( @@ -112,7 +112,7 @@ /** Compare function of psU32 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU32Ptr( @@ -123,7 +123,7 @@ /** Compare function of psU64 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU64Ptr( @@ -134,7 +134,7 @@ /** Compare function of psF32 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareF32Ptr( @@ -145,7 +145,7 @@ /** Compare function of psF64 data. For use with psListSort. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareF64Ptr( @@ -156,7 +156,7 @@ /** Compare function of psS8 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS8Ptr( @@ -167,7 +167,7 @@ /** Compare function of psS16 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS16Ptr( @@ -178,7 +178,7 @@ /** Compare function of psS32 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS32Ptr( @@ -189,7 +189,7 @@ /** Compare function of psS64 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS64Ptr( @@ -200,7 +200,7 @@ /** Compare function of psU8 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU8Ptr( @@ -211,7 +211,7 @@ /** Compare function of psU16 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU16Ptr( @@ -222,7 +222,7 @@ /** Compare function of psU32 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or lessg than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or lessg than the second. */ int psCompareDescendingU32Ptr( @@ -233,7 +233,7 @@ /** Compare function of psU64 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or lessg than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or lessg than the second. */ int psCompareDescendingU64Ptr( @@ -244,7 +244,7 @@ /** Compare function of psF32 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or lessg than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or lessg than the second. */ int psCompareDescendingF32Ptr( @@ -255,7 +255,7 @@ /** Compare function of psF64 data. For use with psListSort for descending ordering. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or lessg than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or lessg than the second. */ int psCompareDescendingF64Ptr( @@ -266,7 +266,7 @@ /** Compare function of psS8 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS8( @@ -278,7 +278,7 @@ /** Compare function of psS16 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS16( @@ -290,7 +290,7 @@ /** Compare function of psS32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS32( @@ -302,7 +302,7 @@ /** Compare function of psS64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareS64( @@ -314,7 +314,7 @@ /** Compare function of psU8 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU8( @@ -326,7 +326,7 @@ /** Compare function of psU16 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU16( @@ -338,7 +338,7 @@ /** Compare function of psU32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU32( @@ -350,7 +350,7 @@ /** Compare function of psU64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareU64( @@ -362,7 +362,7 @@ /** Compare function of psF32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareF32( @@ -374,7 +374,7 @@ /** Compare function of psF64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively less - * than, equal to, or greater than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively less + * than, equal to, or greater than the second. */ int psCompareF64( @@ -386,7 +386,7 @@ /** Compare function of psS8 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS8( @@ -398,7 +398,7 @@ /** Compare function of psS16 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS16( @@ -410,7 +410,7 @@ /** Compare function of psS32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS32( @@ -422,7 +422,7 @@ /** Compare function of psS64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingS64( @@ -434,7 +434,7 @@ /** Compare function of psU8 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU8( @@ -446,7 +446,7 @@ /** Compare function of psU16 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU16( @@ -458,7 +458,7 @@ /** Compare function of psU32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU32( @@ -470,7 +470,7 @@ /** Compare function of psU64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingU64( @@ -482,7 +482,7 @@ /** Compare function of psF32 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingF32( @@ -494,7 +494,7 @@ /** Compare function of psF64 data. * - * @return int an integer less than, equal to, or greater than zero if - * the first argument is considered to be respectively greater - * than, equal to, or less than the second. + * @return int an integer less than, equal to, or greater than zero if + * the first argument is considered to be respectively greater + * than, equal to, or less than the second. */ int psCompareDescendingF64( @@ -506,3 +506,3 @@ /// @} -#endif +#endif // #ifndef PS_COMPARE_H