IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 11, 2004, 9:58:11 AM (22 years ago)
Author:
desonia
Message:

doxygen-based changes.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/collections/psCompare.h

    r1441 r1473  
    99 *  @ingroup Compare
    1010 *
    11  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-08-09 23:40:55 $
     11 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2004-08-11 19:58:11 $
    1313 *
    1414 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    2626 *                   than, equal to, or greater than the second.
    2727 */
    28 typedef int (*psComparePtrFcn) (const void **a, const void **b);
     28typedef int (*psComparePtrFcn) (
     29    const void **a,                    ///< first comparison target
     30    const void **b                     ///< second comparison target
     31);
    2932
    3033/** A comparison function for sorting.
     
    3437 *                   than, equal to, or greater than the second.
    3538 */
    36 typedef int (*psCompareFcn) (const void *a, const void *b);
     39typedef int (*psCompareFcn) (
     40    const void *a,                     ///< first comparison target
     41    const void *b                      ///< second comparison target
     42);
    3743
    3844/** Compare function of psS8 data.  For use with psListSort.
     
    4248 *                   than, equal to, or greater than the second.
    4349 */
    44 int psCompareS8Ptr(const void **a, const void **b);
     50int psCompareS8Ptr(
     51    const void **a,                    ///< first comparison target
     52    const void **b                     ///< second comparison target
     53);
    4554
    4655/** Compare function of psS16 data.  For use with psListSort.
     
    5059 *                   than, equal to, or greater than the second.
    5160 */
    52 int psCompareS16Ptr(const void **a, const void **b);
     61int psCompareS16Ptr(
     62    const void **a,                    ///< first comparison target
     63    const void **b                     ///< second comparison target
     64);
    5365
    5466/** Compare function of psS32 data.  For use with psListSort.
     
    5870 *                   than, equal to, or greater than the second.
    5971 */
    60 int psCompareS32Ptr(const void **a, const void **b);
     72int psCompareS32Ptr(
     73    const void **a,                    ///< first comparison target
     74    const void **b                     ///< second comparison target
     75);
    6176
    6277/** Compare function of psS64 data.  For use with psListSort.
     
    6681 *                   than, equal to, or greater than the second.
    6782 */
    68 int psCompareS64Ptr(const void **a, const void **b);
     83int psCompareS64Ptr(
     84    const void **a,                    ///< first comparison target
     85    const void **b                     ///< second comparison target
     86);
    6987
    7088/** Compare function of psU8 data.  For use with psListSort.
     
    7492 *                   than, equal to, or greater than the second.
    7593 */
    76 int psCompareU8Ptr(const void **a, const void **b);
     94int psCompareU8Ptr(
     95    const void **a,                    ///< first comparison target
     96    const void **b                     ///< second comparison target
     97);
    7798
    7899/** Compare function of psU16 data.  For use with psListSort.
     
    82103 *                   than, equal to, or greater than the second.
    83104 */
    84 int psCompareU16Ptr(const void **a, const void **b);
     105int psCompareU16Ptr(
     106    const void **a,                    ///< first comparison target
     107    const void **b                     ///< second comparison target
     108);
    85109
    86110/** Compare function of psU32 data.  For use with psListSort.
     
    90114 *                   than, equal to, or greater than the second.
    91115 */
    92 int psCompareU32Ptr(const void **a, const void **b);
     116int psCompareU32Ptr(
     117    const void **a,                    ///< first comparison target
     118    const void **b                     ///< second comparison target
     119);
    93120
    94121/** Compare function of psU64 data.  For use with psListSort.
     
    98125 *                   than, equal to, or greater than the second.
    99126 */
    100 int psCompareU64Ptr(const void **a, const void **b);
     127int psCompareU64Ptr(
     128    const void **a,                    ///< first comparison target
     129    const void **b                     ///< second comparison target
     130);
    101131
    102132/** Compare function of psF32 data.  For use with psListSort.
     
    106136 *                   than, equal to, or greater than the second.
    107137 */
    108 int psCompareF32Ptr(const void **a, const void **b);
     138int psCompareF32Ptr(
     139    const void **a,                    ///< first comparison target
     140    const void **b                     ///< second comparison target
     141);
    109142
    110143/** Compare function of psF64 data.  For use with psListSort.
     
    114147 *                   than, equal to, or greater than the second.
    115148 */
    116 int psCompareF64Ptr(const void **a, const void **b);
     149int psCompareF64Ptr(
     150    const void **a,                    ///< first comparison target
     151    const void **b                     ///< second comparison target
     152);
    117153
    118154/** Compare function of psS8 data.  For use with psListSort for descending ordering.
     
    122158 *                   than, equal to, or less than the second.
    123159 */
    124 int psCompareDescendingS8Ptr(const void **a, const void **b);
     160int psCompareDescendingS8Ptr(
     161    const void **a,                    ///< first comparison target
     162    const void **b                     ///< second comparison target
     163);
    125164
    126165/** Compare function of psS16 data.  For use with psListSort for descending ordering.
     
    130169 *                   than, equal to, or less than the second.
    131170 */
    132 int psCompareDescendingS16Ptr(const void **a, const void **b);
     171int psCompareDescendingS16Ptr(
     172    const void **a,                    ///< first comparison target
     173    const void **b                     ///< second comparison target
     174);
    133175
    134176/** Compare function of psS32 data.  For use with psListSort for descending ordering.
     
    138180 *                   than, equal to, or less than the second.
    139181 */
    140 int psCompareDescendingS32Ptr(const void **a, const void **b);
     182int psCompareDescendingS32Ptr(
     183    const void **a,                    ///< first comparison target
     184    const void **b                     ///< second comparison target
     185);
    141186
    142187/** Compare function of psS64 data.  For use with psListSort for descending ordering.
     
    146191 *                   than, equal to, or less than the second.
    147192 */
    148 int psCompareDescendingS64Ptr(const void **a, const void **b);
     193int psCompareDescendingS64Ptr(
     194    const void **a,                    ///< first comparison target
     195    const void **b                     ///< second comparison target
     196);
    149197
    150198/** Compare function of psU8 data.  For use with psListSort for descending ordering.
     
    154202 *                   than, equal to, or less than the second.
    155203 */
    156 int psCompareDescendingU8Ptr(const void **a, const void **b);
     204int psCompareDescendingU8Ptr(
     205    const void **a,                    ///< first comparison target
     206    const void **b                     ///< second comparison target
     207);
    157208
    158209/** Compare function of psU16 data.  For use with psListSort for descending ordering.
     
    162213 *                   than, equal to, or less than the second.
    163214 */
    164 int psCompareDescendingU16Ptr(const void **a, const void **b);
     215int psCompareDescendingU16Ptr(
     216    const void **a,                    ///< first comparison target
     217    const void **b                     ///< second comparison target
     218);
    165219
    166220/** Compare function of psU32 data.  For use with psListSort for descending ordering.
     
    170224 *                   than, equal to, or lessg than the second.
    171225 */
    172 int psCompareDescendingU32Ptr(const void **a, const void **b);
     226int psCompareDescendingU32Ptr(
     227    const void **a,                    ///< first comparison target
     228    const void **b                     ///< second comparison target
     229);
    173230
    174231/** Compare function of psU64 data.  For use with psListSort for descending ordering.
     
    178235 *                   than, equal to, or lessg than the second.
    179236 */
    180 int psCompareDescendingU64Ptr(const void **a, const void **b);
     237int psCompareDescendingU64Ptr(
     238    const void **a,                    ///< first comparison target
     239    const void **b                     ///< second comparison target
     240);
    181241
    182242/** Compare function of psF32 data.  For use with psListSort for descending ordering.
     
    186246 *                   than, equal to, or lessg than the second.
    187247 */
    188 int psCompareDescendingF32Ptr(const void **a, const void **b);
     248int psCompareDescendingF32Ptr(
     249    const void **a,                    ///< first comparison target
     250    const void **b                     ///< second comparison target
     251);
    189252
    190253/** Compare function of psF64 data.  For use with psListSort for descending ordering.
     
    194257 *                   than, equal to, or lessg than the second.
    195258 */
    196 int psCompareDescendingF64Ptr(const void **a, const void **b);
     259int psCompareDescendingF64Ptr(
     260    const void **a,                    ///< first comparison target
     261    const void **b                     ///< second comparison target
     262);
    197263
    198264/** Compare function of psS8 data.
     
    202268 *                   than, equal to, or greater than the second.
    203269 */
    204 int psCompareS8(const void *a, const void *b);
     270int psCompareS8(
     271    const void *a,                     ///< first comparison target
     272    const void *b                      ///< second comparison target
     273);
     274
    205275
    206276/** Compare function of psS16 data.
     
    210280 *                   than, equal to, or greater than the second.
    211281 */
    212 int psCompareS16(const void *a, const void *b);
     282int psCompareS16(
     283    const void *a,                     ///< first comparison target
     284    const void *b                      ///< second comparison target
     285);
     286
    213287
    214288/** Compare function of psS32 data.
     
    218292 *                   than, equal to, or greater than the second.
    219293 */
    220 int psCompareS32(const void *a, const void *b);
     294int psCompareS32(
     295    const void *a,                     ///< first comparison target
     296    const void *b                      ///< second comparison target
     297);
     298
    221299
    222300/** Compare function of psS64 data.
     
    226304 *                   than, equal to, or greater than the second.
    227305 */
    228 int psCompareS64(const void *a, const void *b);
     306int psCompareS64(
     307    const void *a,                     ///< first comparison target
     308    const void *b                      ///< second comparison target
     309);
     310
    229311
    230312/** Compare function of psU8 data.
     
    234316 *                   than, equal to, or greater than the second.
    235317 */
    236 int psCompareU8(const void *a, const void *b);
     318int psCompareU8(
     319    const void *a,                     ///< first comparison target
     320    const void *b                      ///< second comparison target
     321);
     322
    237323
    238324/** Compare function of psU16 data.
     
    242328 *                   than, equal to, or greater than the second.
    243329 */
    244 int psCompareU16(const void *a, const void *b);
     330int psCompareU16(
     331    const void *a,                     ///< first comparison target
     332    const void *b                      ///< second comparison target
     333);
     334
    245335
    246336/** Compare function of psU32 data.
     
    250340 *                   than, equal to, or greater than the second.
    251341 */
    252 int psCompareU32(const void *a, const void *b);
     342int psCompareU32(
     343    const void *a,                     ///< first comparison target
     344    const void *b                      ///< second comparison target
     345);
     346
    253347
    254348/** Compare function of psU64 data.
     
    258352 *                   than, equal to, or greater than the second.
    259353 */
    260 int psCompareU64(const void *a, const void *b);
     354int psCompareU64(
     355    const void *a,                     ///< first comparison target
     356    const void *b                      ///< second comparison target
     357);
     358
    261359
    262360/** Compare function of psF32 data.
     
    266364 *                   than, equal to, or greater than the second.
    267365 */
    268 int psCompareF32(const void *a, const void *b);
     366int psCompareF32(
     367    const void *a,                     ///< first comparison target
     368    const void *b                      ///< second comparison target
     369);
     370
    269371
    270372/** Compare function of psF64 data.
     
    274376 *                   than, equal to, or greater than the second.
    275377 */
    276 int psCompareF64(const void *a, const void *b);
     378int psCompareF64(
     379    const void *a,                     ///< first comparison target
     380    const void *b                      ///< second comparison target
     381);
     382
    277383
    278384/** Compare function of psS8 data.
     
    282388 *                   than, equal to, or less than the second.
    283389 */
    284 int psCompareDescendingS8(const void *a, const void *b);
     390int psCompareDescendingS8(
     391    const void *a,                     ///< first comparison target
     392    const void *b                      ///< second comparison target
     393);
     394
    285395
    286396/** Compare function of psS16 data.
     
    290400 *                   than, equal to, or less than the second.
    291401 */
    292 int psCompareDescendingS16(const void *a, const void *b);
     402int psCompareDescendingS16(
     403    const void *a,                     ///< first comparison target
     404    const void *b                      ///< second comparison target
     405);
     406
    293407
    294408/** Compare function of psS32 data.
     
    298412 *                   than, equal to, or less than the second.
    299413 */
    300 int psCompareDescendingS32(const void *a, const void *b);
     414int psCompareDescendingS32(
     415    const void *a,                     ///< first comparison target
     416    const void *b                      ///< second comparison target
     417);
     418
    301419
    302420/** Compare function of psS64 data.
     
    306424 *                   than, equal to, or less than the second.
    307425 */
    308 int psCompareDescendingS64(const void *a, const void *b);
     426int psCompareDescendingS64(
     427    const void *a,                     ///< first comparison target
     428    const void *b                      ///< second comparison target
     429);
     430
    309431
    310432/** Compare function of psU8 data.
     
    314436 *                   than, equal to, or less than the second.
    315437 */
    316 int psCompareDescendingU8(const void *a, const void *b);
     438int psCompareDescendingU8(
     439    const void *a,                     ///< first comparison target
     440    const void *b                      ///< second comparison target
     441);
     442
    317443
    318444/** Compare function of psU16 data.
     
    322448 *                   than, equal to, or less than the second.
    323449 */
    324 int psCompareDescendingU16(const void *a, const void *b);
     450int psCompareDescendingU16(
     451    const void *a,                     ///< first comparison target
     452    const void *b                      ///< second comparison target
     453);
     454
    325455
    326456/** Compare function of psU32 data.
     
    328458 *  @return int      an integer less than, equal to, or greater than zero if
    329459 *                   the first argument is considered to be respectively greater
    330  *                   than, equal to, or lessg than the second.
    331  */
    332 int psCompareDescendingU32(const void *a, const void *b);
     460 *                   than, equal to, or less than the second.
     461 */
     462int psCompareDescendingU32(
     463    const void *a,                     ///< first comparison target
     464    const void *b                      ///< second comparison target
     465);
     466
    333467
    334468/** Compare function of psU64 data.
     
    336470 *  @return int      an integer less than, equal to, or greater than zero if
    337471 *                   the first argument is considered to be respectively greater
    338  *                   than, equal to, or lessg than the second.
    339  */
    340 int psCompareDescendingU64(const void *a, const void *b);
     472 *                   than, equal to, or less than the second.
     473 */
     474int psCompareDescendingU64(
     475    const void *a,                     ///< first comparison target
     476    const void *b                      ///< second comparison target
     477);
     478
    341479
    342480/** Compare function of psF32 data.
     
    344482 *  @return int      an integer less than, equal to, or greater than zero if
    345483 *                   the first argument is considered to be respectively greater
    346  *                   than, equal to, or lessg than the second.
    347  */
    348 int psCompareDescendingF32(const void *a, const void *b);
     484 *                   than, equal to, or less than the second.
     485 */
     486int psCompareDescendingF32(
     487    const void *a,                     ///< first comparison target
     488    const void *b                      ///< second comparison target
     489);
     490
    349491
    350492/** Compare function of psF64 data.
     
    352494 *  @return int      an integer less than, equal to, or greater than zero if
    353495 *                   the first argument is considered to be respectively greater
    354  *                   than, equal to, or lessg than the second.
    355  */
    356 int psCompareDescendingF64(const void *a, const void *b);
     496 *                   than, equal to, or less than the second.
     497 */
     498int psCompareDescendingF64(
     499    const void *a,                     ///< first comparison target
     500    const void *b                      ///< second comparison target
     501);
     502
    357503
    358504/// @}
Note: See TracChangeset for help on using the changeset viewer.