IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 1478


Ignore:
Timestamp:
Aug 11, 2004, 10:17:35 AM (22 years ago)
Author:
desonia
Message:

doxygen additions.

Location:
trunk/psLib/src
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/collections/psVector.h

    r1441 r1478  
    1212 *  @author Ross Harman, MHPCC
    1313 *
    14  *  @version $Revision: 1.19 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-08-09 23:40:55 $
     14 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-08-11 20:17:35 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    6363/** Allocate a vector.
    6464 *
    65  * Uses psLib memory allocation functions to create a vector collection of data as defined by the psType type.
     65 *  Uses psLib memory allocation functions to create a vector collection of
     66 *  data as defined by the psType type.
    6667 *
    67  * @return psVector* : Pointer to psVector.
    68  *
     68 * @return psVector*    Pointer to psVector.
    6969 */
    70 psVector* psVectorAlloc(unsigned int nalloc,    ///< Total number of elements to make available.
    71                         psElemType dataType     ///< Type of data to be held by vector.
    72                        );
     70psVector* psVectorAlloc(
     71    unsigned int nalloc,               ///< Total number of elements to make available.
     72    psElemType dataType                ///< Type of data to be held by vector.
     73);
    7374
    7475/** Reallocate a vector.
    7576 *
    76  * Uses psLib memory allocation functions to reallocate a vector collection of data. The vector is reallocated
    77  * according to the psType type member contained within the vector.
     77 *  Uses psLib memory allocation functions to reallocate a vector collection
     78 *  of data. The vector is reallocated according to the psType type member
     79 *  contained within the vector.
    7880 *
    79  * @return psVector* : Pointer to psVector.
     81 *  @return psVector*      Pointer to psVector.
    8082 *
    8183 */
    82 psVector* psVectorRealloc(unsigned int nalloc,  ///< Total number of elements to make available.
    83                           psVector* restrict psVec     ///< Vector to reallocate.
    84                          );
     84psVector* psVectorRealloc(
     85    unsigned int nalloc,               ///< Total number of elements to make available.
     86    psVector* restrict psVec           ///< Vector to reallocate.
     87);
    8588
    8689/** Recycle a vector.
    8790 *
    88  * Uses psLib memory allocation functions to reallocate a vector collection of data. The vector is reallocated
    89  * according to the psElemType type parameter.
     91 *  Uses psLib memory allocation functions to reallocate a vector collection
     92 *  of data. The vector is reallocated according to the psElemType type
     93 *  parameter.
    9094 *
    91  * @return psVector* : Pointer to psVector.
     95 * @return psVector*       Pointer to psVector.
    9296 *
    9397 */
    94 psVector* psVectorRecycle(psVector* restrict psVec,
    95                           ///< Vector to recycle.  If NULL, a new vector is created.  No effort taken to
    96                           // preserve the values.
    97                           unsigned int nalloc,  ///< Total number of elements to make available.
    98                           psElemType type       ///< the datatype of the returned vector
    99                          );
     98psVector* psVectorRecycle(
     99    psVector* restrict psVec,
     100    ///< Vector to recycle.  If NULL, a new vector is created.  No effort
     101    ///< taken to preserve the values.
     102
     103    unsigned int nalloc,               ///< Total number of elements to make available.
     104    psElemType type                    ///< the datatype of the returned vector
     105);
    100106
    101107/** Sort an array of floats.
    … …  
    104110 *  all non-complex data types.
    105111 *
    106  *  @return  psFloatArray* : Pointer to sorted psFloatArray.
     112 *  @return  psVector*     Pointer to sorted psVector.
    107113 */
     114psVector* psVectorSort(
     115    psVector* restrict outVector,      ///< the output vector to recycle, or NULL if new vector desired.
     116    const psVector* restrict inVector  ///< the vector to sort.
     117);
    108118
    109 psVector* psVectorSort(psVector* restrict outVector,   ///< the output vector to recycle, or NULL if new
    110                        // vector desired.
    111                        const psVector* restrict inVector       ///< the vector to sort.
    112                       );
    113 
    114 /** Creates an array of indices based on sort odred of float array.
     119/** Creates an array of indices based on sort ordered of array.
    115120 *
    116  *  Sorts an array of floats and creates an integer array holding indices of
     121 *  Sorts a vector and creates an integer array holding indices of
    117122 *  sorted float values based on pre-sort index positions. 
    118123 *
    119  *  @return  psIntArray* : Pointer to psIntArray of sorted indices.
     124 *  @return  psVector*     vector of the indices of sort.
    120125 */
    121 
    122 psVector* psVectorSortIndex(psVector* restrict outVector, const psVector* restrict inVector);
     126psVector* psVectorSortIndex(
     127    psVector* restrict outVector,      ///< vector to recycle
     128    const psVector* restrict inVector  ///< vector to sort
     129);
    123130
    124131/// @}

  • trunk/psLib/src/mathtypes/psVector.h

    r1441 r1478  
    1212 *  @author Ross Harman, MHPCC
    1313 *
    14  *  @version $Revision: 1.19 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-08-09 23:40:55 $
     14 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-08-11 20:17:35 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    6363/** Allocate a vector.
    6464 *
    65  * Uses psLib memory allocation functions to create a vector collection of data as defined by the psType type.
     65 *  Uses psLib memory allocation functions to create a vector collection of
     66 *  data as defined by the psType type.
    6667 *
    67  * @return psVector* : Pointer to psVector.
    68  *
     68 * @return psVector*    Pointer to psVector.
    6969 */
    70 psVector* psVectorAlloc(unsigned int nalloc,    ///< Total number of elements to make available.
    71                         psElemType dataType     ///< Type of data to be held by vector.
    72                        );
     70psVector* psVectorAlloc(
     71    unsigned int nalloc,               ///< Total number of elements to make available.
     72    psElemType dataType                ///< Type of data to be held by vector.
     73);
    7374
    7475/** Reallocate a vector.
    7576 *
    76  * Uses psLib memory allocation functions to reallocate a vector collection of data. The vector is reallocated
    77  * according to the psType type member contained within the vector.
     77 *  Uses psLib memory allocation functions to reallocate a vector collection
     78 *  of data. The vector is reallocated according to the psType type member
     79 *  contained within the vector.
    7880 *
    79  * @return psVector* : Pointer to psVector.
     81 *  @return psVector*      Pointer to psVector.
    8082 *
    8183 */
    82 psVector* psVectorRealloc(unsigned int nalloc,  ///< Total number of elements to make available.
    83                           psVector* restrict psVec     ///< Vector to reallocate.
    84                          );
     84psVector* psVectorRealloc(
     85    unsigned int nalloc,               ///< Total number of elements to make available.
     86    psVector* restrict psVec           ///< Vector to reallocate.
     87);
    8588
    8689/** Recycle a vector.
    8790 *
    88  * Uses psLib memory allocation functions to reallocate a vector collection of data. The vector is reallocated
    89  * according to the psElemType type parameter.
     91 *  Uses psLib memory allocation functions to reallocate a vector collection
     92 *  of data. The vector is reallocated according to the psElemType type
     93 *  parameter.
    9094 *
    91  * @return psVector* : Pointer to psVector.
     95 * @return psVector*       Pointer to psVector.
    9296 *
    9397 */
    94 psVector* psVectorRecycle(psVector* restrict psVec,
    95                           ///< Vector to recycle.  If NULL, a new vector is created.  No effort taken to
    96                           // preserve the values.
    97                           unsigned int nalloc,  ///< Total number of elements to make available.
    98                           psElemType type       ///< the datatype of the returned vector
    99                          );
     98psVector* psVectorRecycle(
     99    psVector* restrict psVec,
     100    ///< Vector to recycle.  If NULL, a new vector is created.  No effort
     101    ///< taken to preserve the values.
     102
     103    unsigned int nalloc,               ///< Total number of elements to make available.
     104    psElemType type                    ///< the datatype of the returned vector
     105);
    100106
    101107/** Sort an array of floats.
    … …  
    104110 *  all non-complex data types.
    105111 *
    106  *  @return  psFloatArray* : Pointer to sorted psFloatArray.
     112 *  @return  psVector*     Pointer to sorted psVector.
    107113 */
     114psVector* psVectorSort(
     115    psVector* restrict outVector,      ///< the output vector to recycle, or NULL if new vector desired.
     116    const psVector* restrict inVector  ///< the vector to sort.
     117);
    108118
    109 psVector* psVectorSort(psVector* restrict outVector,   ///< the output vector to recycle, or NULL if new
    110                        // vector desired.
    111                        const psVector* restrict inVector       ///< the vector to sort.
    112                       );
    113 
    114 /** Creates an array of indices based on sort odred of float array.
     119/** Creates an array of indices based on sort ordered of array.
    115120 *
    116  *  Sorts an array of floats and creates an integer array holding indices of
     121 *  Sorts a vector and creates an integer array holding indices of
    117122 *  sorted float values based on pre-sort index positions. 
    118123 *
    119  *  @return  psIntArray* : Pointer to psIntArray of sorted indices.
     124 *  @return  psVector*     vector of the indices of sort.
    120125 */
    121 
    122 psVector* psVectorSortIndex(psVector* restrict outVector, const psVector* restrict inVector);
     126psVector* psVectorSortIndex(
     127    psVector* restrict outVector,      ///< vector to recycle
     128    const psVector* restrict inVector  ///< vector to sort
     129);
    123130
    124131/// @}
Note: See TracChangeset for help on using the changeset viewer.