IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jun 8, 2005, 1:40:46 PM (21 years ago)
Author:
desonia
Message:

added comments on the end of #endif and #else

File:
1 edited

Legend:

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

    r3264 r4162  
    66 *  @ingroup Compare
    77 *
    8  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    9  *  @date $Date: 2005-02-17 19:26:23 $
     8 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2005-06-08 23:40:45 $
    1010 *
    1111 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1212 */
    1313
    14 #if !defined(PS_COMPARE_H)
     14#ifndef PS_COMPARE_H
    1515#define PS_COMPARE_H
    1616
     
    2424 *  e.g., for psList of pointers to numeric values.
    2525 *
    26  *  @return int      an integer less than, equal to, or greater than zero if 
    27  *                   the first argument is considered to be respectively less 
    28  *                   than, equal to, or greater than the second. 
     26 *  @return int      an integer less than, equal to, or greater than zero if
     27 *                   the first argument is considered to be respectively less
     28 *                   than, equal to, or greater than the second.
    2929 */
    3030typedef int (*psComparePtrFcn) (
     
    3535/** A comparison function for sorting.
    3636 *
    37  *  @return int      an integer less than, equal to, or greater than zero if 
    38  *                   the first argument is considered to be respectively less 
    39  *                   than, equal to, or greater than the second. 
     37 *  @return int      an integer less than, equal to, or greater than zero if
     38 *                   the first argument is considered to be respectively less
     39 *                   than, equal to, or greater than the second.
    4040 */
    4141typedef int (*psCompareFcn) (
     
    4646/** Compare function of psS8 data.  For use with psListSort.
    4747 *
    48  *  @return int      an integer less than, equal to, or greater than zero if 
    49  *                   the first argument is considered to be respectively less 
    50  *                   than, equal to, or greater than the second. 
     48 *  @return int      an integer less than, equal to, or greater than zero if
     49 *                   the first argument is considered to be respectively less
     50 *                   than, equal to, or greater than the second.
    5151 */
    5252int psCompareS8Ptr(
     
    5757/** Compare function of psS16 data.  For use with psListSort.
    5858 *
    59  *  @return int      an integer less than, equal to, or greater than zero if 
    60  *                   the first argument is considered to be respectively less 
    61  *                   than, equal to, or greater than the second. 
     59 *  @return int      an integer less than, equal to, or greater than zero if
     60 *                   the first argument is considered to be respectively less
     61 *                   than, equal to, or greater than the second.
    6262 */
    6363int psCompareS16Ptr(
     
    6868/** Compare function of psS32 data.  For use with psListSort.
    6969 *
    70  *  @return int      an integer less than, equal to, or greater than zero if 
    71  *                   the first argument is considered to be respectively less 
    72  *                   than, equal to, or greater than the second. 
     70 *  @return int      an integer less than, equal to, or greater than zero if
     71 *                   the first argument is considered to be respectively less
     72 *                   than, equal to, or greater than the second.
    7373 */
    7474int psCompareS32Ptr(
     
    7979/** Compare function of psS64 data.  For use with psListSort.
    8080 *
    81  *  @return int      an integer less than, equal to, or greater than zero if 
    82  *                   the first argument is considered to be respectively less 
    83  *                   than, equal to, or greater than the second. 
     81 *  @return int      an integer less than, equal to, or greater than zero if
     82 *                   the first argument is considered to be respectively less
     83 *                   than, equal to, or greater than the second.
    8484 */
    8585int psCompareS64Ptr(
     
    9090/** Compare function of psU8 data.  For use with psListSort.
    9191 *
    92  *  @return int      an integer less than, equal to, or greater than zero if 
    93  *                   the first argument is considered to be respectively less 
    94  *                   than, equal to, or greater than the second. 
     92 *  @return int      an integer less than, equal to, or greater than zero if
     93 *                   the first argument is considered to be respectively less
     94 *                   than, equal to, or greater than the second.
    9595 */
    9696int psCompareU8Ptr(
     
    101101/** Compare function of psU16 data.  For use with psListSort.
    102102 *
    103  *  @return int      an integer less than, equal to, or greater than zero if 
    104  *                   the first argument is considered to be respectively less 
    105  *                   than, equal to, or greater than the second. 
     103 *  @return int      an integer less than, equal to, or greater than zero if
     104 *                   the first argument is considered to be respectively less
     105 *                   than, equal to, or greater than the second.
    106106 */
    107107int psCompareU16Ptr(
     
    112112/** Compare function of psU32 data.  For use with psListSort.
    113113 *
    114  *  @return int      an integer less than, equal to, or greater than zero if 
    115  *                   the first argument is considered to be respectively less 
    116  *                   than, equal to, or greater than the second. 
     114 *  @return int      an integer less than, equal to, or greater than zero if
     115 *                   the first argument is considered to be respectively less
     116 *                   than, equal to, or greater than the second.
    117117 */
    118118int psCompareU32Ptr(
     
    123123/** Compare function of psU64 data.  For use with psListSort.
    124124 *
    125  *  @return int      an integer less than, equal to, or greater than zero if 
    126  *                   the first argument is considered to be respectively less 
    127  *                   than, equal to, or greater than the second. 
     125 *  @return int      an integer less than, equal to, or greater than zero if
     126 *                   the first argument is considered to be respectively less
     127 *                   than, equal to, or greater than the second.
    128128 */
    129129int psCompareU64Ptr(
     
    134134/** Compare function of psF32 data.  For use with psListSort.
    135135 *
    136  *  @return int      an integer less than, equal to, or greater than zero if 
    137  *                   the first argument is considered to be respectively less 
    138  *                   than, equal to, or greater than the second. 
     136 *  @return int      an integer less than, equal to, or greater than zero if
     137 *                   the first argument is considered to be respectively less
     138 *                   than, equal to, or greater than the second.
    139139 */
    140140int psCompareF32Ptr(
     
    145145/** Compare function of psF64 data.  For use with psListSort.
    146146 *
    147  *  @return int      an integer less than, equal to, or greater than zero if 
    148  *                   the first argument is considered to be respectively less 
    149  *                   than, equal to, or greater than the second. 
     147 *  @return int      an integer less than, equal to, or greater than zero if
     148 *                   the first argument is considered to be respectively less
     149 *                   than, equal to, or greater than the second.
    150150 */
    151151int psCompareF64Ptr(
     
    156156/** Compare function of psS8 data.  For use with psListSort for descending ordering.
    157157 *
    158  *  @return int      an integer less than, equal to, or greater than zero if 
    159  *                   the first argument is considered to be respectively greater 
    160  *                   than, equal to, or less than the second. 
     158 *  @return int      an integer less than, equal to, or greater than zero if
     159 *                   the first argument is considered to be respectively greater
     160 *                   than, equal to, or less than the second.
    161161 */
    162162int psCompareDescendingS8Ptr(
     
    167167/** Compare function of psS16 data.  For use with psListSort for descending ordering.
    168168 *
    169  *  @return int      an integer less than, equal to, or greater than zero if 
    170  *                   the first argument is considered to be respectively greater 
    171  *                   than, equal to, or less than the second. 
     169 *  @return int      an integer less than, equal to, or greater than zero if
     170 *                   the first argument is considered to be respectively greater
     171 *                   than, equal to, or less than the second.
    172172 */
    173173int psCompareDescendingS16Ptr(
     
    178178/** Compare function of psS32 data.  For use with psListSort for descending ordering.
    179179 *
    180  *  @return int      an integer less than, equal to, or greater than zero if 
    181  *                   the first argument is considered to be respectively greater 
    182  *                   than, equal to, or less than the second. 
     180 *  @return int      an integer less than, equal to, or greater than zero if
     181 *                   the first argument is considered to be respectively greater
     182 *                   than, equal to, or less than the second.
    183183 */
    184184int psCompareDescendingS32Ptr(
     
    189189/** Compare function of psS64 data.  For use with psListSort for descending ordering.
    190190 *
    191  *  @return int      an integer less than, equal to, or greater than zero if 
    192  *                   the first argument is considered to be respectively greater 
    193  *                   than, equal to, or less than the second. 
     191 *  @return int      an integer less than, equal to, or greater than zero if
     192 *                   the first argument is considered to be respectively greater
     193 *                   than, equal to, or less than the second.
    194194 */
    195195int psCompareDescendingS64Ptr(
     
    200200/** Compare function of psU8 data.  For use with psListSort for descending ordering.
    201201 *
    202  *  @return int      an integer less than, equal to, or greater than zero if 
    203  *                   the first argument is considered to be respectively greater 
    204  *                   than, equal to, or less than the second. 
     202 *  @return int      an integer less than, equal to, or greater than zero if
     203 *                   the first argument is considered to be respectively greater
     204 *                   than, equal to, or less than the second.
    205205 */
    206206int psCompareDescendingU8Ptr(
     
    211211/** Compare function of psU16 data.  For use with psListSort for descending ordering.
    212212 *
    213  *  @return int      an integer less than, equal to, or greater than zero if 
    214  *                   the first argument is considered to be respectively greater 
    215  *                   than, equal to, or less than the second. 
     213 *  @return int      an integer less than, equal to, or greater than zero if
     214 *                   the first argument is considered to be respectively greater
     215 *                   than, equal to, or less than the second.
    216216 */
    217217int psCompareDescendingU16Ptr(
     
    222222/** Compare function of psU32 data.  For use with psListSort for descending ordering.
    223223 *
    224  *  @return int      an integer less than, equal to, or greater than zero if 
    225  *                   the first argument is considered to be respectively greater 
    226  *                   than, equal to, or lessg than the second. 
     224 *  @return int      an integer less than, equal to, or greater than zero if
     225 *                   the first argument is considered to be respectively greater
     226 *                   than, equal to, or lessg than the second.
    227227 */
    228228int psCompareDescendingU32Ptr(
     
    233233/** Compare function of psU64 data.  For use with psListSort for descending ordering.
    234234 *
    235  *  @return int      an integer less than, equal to, or greater than zero if 
    236  *                   the first argument is considered to be respectively greater 
    237  *                   than, equal to, or lessg than the second. 
     235 *  @return int      an integer less than, equal to, or greater than zero if
     236 *                   the first argument is considered to be respectively greater
     237 *                   than, equal to, or lessg than the second.
    238238 */
    239239int psCompareDescendingU64Ptr(
     
    244244/** Compare function of psF32 data.  For use with psListSort for descending ordering.
    245245 *
    246  *  @return int      an integer less than, equal to, or greater than zero if 
    247  *                   the first argument is considered to be respectively greater 
    248  *                   than, equal to, or lessg than the second. 
     246 *  @return int      an integer less than, equal to, or greater than zero if
     247 *                   the first argument is considered to be respectively greater
     248 *                   than, equal to, or lessg than the second.
    249249 */
    250250int psCompareDescendingF32Ptr(
     
    255255/** Compare function of psF64 data.  For use with psListSort for descending ordering.
    256256 *
    257  *  @return int      an integer less than, equal to, or greater than zero if 
    258  *                   the first argument is considered to be respectively greater 
    259  *                   than, equal to, or lessg than the second. 
     257 *  @return int      an integer less than, equal to, or greater than zero if
     258 *                   the first argument is considered to be respectively greater
     259 *                   than, equal to, or lessg than the second.
    260260 */
    261261int psCompareDescendingF64Ptr(
     
    266266/** Compare function of psS8 data.
    267267 *
    268  *  @return int      an integer less than, equal to, or greater than zero if 
    269  *                   the first argument is considered to be respectively less 
    270  *                   than, equal to, or greater than the second. 
     268 *  @return int      an integer less than, equal to, or greater than zero if
     269 *                   the first argument is considered to be respectively less
     270 *                   than, equal to, or greater than the second.
    271271 */
    272272int psCompareS8(
     
    278278/** Compare function of psS16 data.
    279279 *
    280  *  @return int      an integer less than, equal to, or greater than zero if 
    281  *                   the first argument is considered to be respectively less 
    282  *                   than, equal to, or greater than the second. 
     280 *  @return int      an integer less than, equal to, or greater than zero if
     281 *                   the first argument is considered to be respectively less
     282 *                   than, equal to, or greater than the second.
    283283 */
    284284int psCompareS16(
     
    290290/** Compare function of psS32 data.
    291291 *
    292  *  @return int      an integer less than, equal to, or greater than zero if 
    293  *                   the first argument is considered to be respectively less 
    294  *                   than, equal to, or greater than the second. 
     292 *  @return int      an integer less than, equal to, or greater than zero if
     293 *                   the first argument is considered to be respectively less
     294 *                   than, equal to, or greater than the second.
    295295 */
    296296int psCompareS32(
     
    302302/** Compare function of psS64 data.
    303303 *
    304  *  @return int      an integer less than, equal to, or greater than zero if 
    305  *                   the first argument is considered to be respectively less 
    306  *                   than, equal to, or greater than the second. 
     304 *  @return int      an integer less than, equal to, or greater than zero if
     305 *                   the first argument is considered to be respectively less
     306 *                   than, equal to, or greater than the second.
    307307 */
    308308int psCompareS64(
     
    314314/** Compare function of psU8 data.
    315315 *
    316  *  @return int      an integer less than, equal to, or greater than zero if 
    317  *                   the first argument is considered to be respectively less 
    318  *                   than, equal to, or greater than the second. 
     316 *  @return int      an integer less than, equal to, or greater than zero if
     317 *                   the first argument is considered to be respectively less
     318 *                   than, equal to, or greater than the second.
    319319 */
    320320int psCompareU8(
     
    326326/** Compare function of psU16 data.
    327327 *
    328  *  @return int      an integer less than, equal to, or greater than zero if 
    329  *                   the first argument is considered to be respectively less 
    330  *                   than, equal to, or greater than the second. 
     328 *  @return int      an integer less than, equal to, or greater than zero if
     329 *                   the first argument is considered to be respectively less
     330 *                   than, equal to, or greater than the second.
    331331 */
    332332int psCompareU16(
     
    338338/** Compare function of psU32 data.
    339339 *
    340  *  @return int      an integer less than, equal to, or greater than zero if 
    341  *                   the first argument is considered to be respectively less 
    342  *                   than, equal to, or greater than the second. 
     340 *  @return int      an integer less than, equal to, or greater than zero if
     341 *                   the first argument is considered to be respectively less
     342 *                   than, equal to, or greater than the second.
    343343 */
    344344int psCompareU32(
     
    350350/** Compare function of psU64 data.
    351351 *
    352  *  @return int      an integer less than, equal to, or greater than zero if 
    353  *                   the first argument is considered to be respectively less 
    354  *                   than, equal to, or greater than the second. 
     352 *  @return int      an integer less than, equal to, or greater than zero if
     353 *                   the first argument is considered to be respectively less
     354 *                   than, equal to, or greater than the second.
    355355 */
    356356int psCompareU64(
     
    362362/** Compare function of psF32 data.
    363363 *
    364  *  @return int      an integer less than, equal to, or greater than zero if 
    365  *                   the first argument is considered to be respectively less 
    366  *                   than, equal to, or greater than the second. 
     364 *  @return int      an integer less than, equal to, or greater than zero if
     365 *                   the first argument is considered to be respectively less
     366 *                   than, equal to, or greater than the second.
    367367 */
    368368int psCompareF32(
     
    374374/** Compare function of psF64 data.
    375375 *
    376  *  @return int      an integer less than, equal to, or greater than zero if 
    377  *                   the first argument is considered to be respectively less 
    378  *                   than, equal to, or greater than the second. 
     376 *  @return int      an integer less than, equal to, or greater than zero if
     377 *                   the first argument is considered to be respectively less
     378 *                   than, equal to, or greater than the second.
    379379 */
    380380int psCompareF64(
     
    386386/** Compare function of psS8 data.
    387387 *
    388  *  @return int      an integer less than, equal to, or greater than zero if 
    389  *                   the first argument is considered to be respectively greater 
    390  *                   than, equal to, or less than the second. 
     388 *  @return int      an integer less than, equal to, or greater than zero if
     389 *                   the first argument is considered to be respectively greater
     390 *                   than, equal to, or less than the second.
    391391 */
    392392int psCompareDescendingS8(
     
    398398/** Compare function of psS16 data.
    399399 *
    400  *  @return int      an integer less than, equal to, or greater than zero if 
    401  *                   the first argument is considered to be respectively greater 
    402  *                   than, equal to, or less than the second. 
     400 *  @return int      an integer less than, equal to, or greater than zero if
     401 *                   the first argument is considered to be respectively greater
     402 *                   than, equal to, or less than the second.
    403403 */
    404404int psCompareDescendingS16(
     
    410410/** Compare function of psS32 data.
    411411 *
    412  *  @return int      an integer less than, equal to, or greater than zero if 
    413  *                   the first argument is considered to be respectively greater 
    414  *                   than, equal to, or less than the second. 
     412 *  @return int      an integer less than, equal to, or greater than zero if
     413 *                   the first argument is considered to be respectively greater
     414 *                   than, equal to, or less than the second.
    415415 */
    416416int psCompareDescendingS32(
     
    422422/** Compare function of psS64 data.
    423423 *
    424  *  @return int      an integer less than, equal to, or greater than zero if 
    425  *                   the first argument is considered to be respectively greater 
    426  *                   than, equal to, or less than the second. 
     424 *  @return int      an integer less than, equal to, or greater than zero if
     425 *                   the first argument is considered to be respectively greater
     426 *                   than, equal to, or less than the second.
    427427 */
    428428int psCompareDescendingS64(
     
    434434/** Compare function of psU8 data.
    435435 *
    436  *  @return int      an integer less than, equal to, or greater than zero if 
    437  *                   the first argument is considered to be respectively greater 
    438  *                   than, equal to, or less than the second. 
     436 *  @return int      an integer less than, equal to, or greater than zero if
     437 *                   the first argument is considered to be respectively greater
     438 *                   than, equal to, or less than the second.
    439439 */
    440440int psCompareDescendingU8(
     
    446446/** Compare function of psU16 data.
    447447 *
    448  *  @return int      an integer less than, equal to, or greater than zero if 
    449  *                   the first argument is considered to be respectively greater 
    450  *                   than, equal to, or less than the second. 
     448 *  @return int      an integer less than, equal to, or greater than zero if
     449 *                   the first argument is considered to be respectively greater
     450 *                   than, equal to, or less than the second.
    451451 */
    452452int psCompareDescendingU16(
     
    458458/** Compare function of psU32 data.
    459459 *
    460  *  @return int      an integer less than, equal to, or greater than zero if 
    461  *                   the first argument is considered to be respectively greater 
    462  *                   than, equal to, or less than the second. 
     460 *  @return int      an integer less than, equal to, or greater than zero if
     461 *                   the first argument is considered to be respectively greater
     462 *                   than, equal to, or less than the second.
    463463 */
    464464int psCompareDescendingU32(
     
    470470/** Compare function of psU64 data.
    471471 *
    472  *  @return int      an integer less than, equal to, or greater than zero if 
    473  *                   the first argument is considered to be respectively greater 
    474  *                   than, equal to, or less than the second. 
     472 *  @return int      an integer less than, equal to, or greater than zero if
     473 *                   the first argument is considered to be respectively greater
     474 *                   than, equal to, or less than the second.
    475475 */
    476476int psCompareDescendingU64(
     
    482482/** Compare function of psF32 data.
    483483 *
    484  *  @return int      an integer less than, equal to, or greater than zero if 
    485  *                   the first argument is considered to be respectively greater 
    486  *                   than, equal to, or less than the second. 
     484 *  @return int      an integer less than, equal to, or greater than zero if
     485 *                   the first argument is considered to be respectively greater
     486 *                   than, equal to, or less than the second.
    487487 */
    488488int psCompareDescendingF32(
     
    494494/** Compare function of psF64 data.
    495495 *
    496  *  @return int      an integer less than, equal to, or greater than zero if 
    497  *                   the first argument is considered to be respectively greater 
    498  *                   than, equal to, or less than the second. 
     496 *  @return int      an integer less than, equal to, or greater than zero if
     497 *                   the first argument is considered to be respectively greater
     498 *                   than, equal to, or less than the second.
    499499 */
    500500int psCompareDescendingF64(
     
    506506/// @}
    507507
    508 #endif
     508#endif  // #ifndef PS_COMPARE_H
Note: See TracChangeset for help on using the changeset viewer.