Changeset 450 for trunk/psLib/src/collections/psSort.h

Timestamp:

Apr 19, 2004, 10:10:46 AM (22 years ago)

Author:

harman

Message:

Changed print statements to logging statements

File:

• trunk/psLib/src/collections/psSort.h (modified) (1 diff)

trunk/psLib/src/collections/psSort.h

@@ +1 @@
+/** @file  psSort.h
+ *
+ *  @brief Sorts arrays
+ *
+ *  The psSort functions use the qsort() stdlib function with a user-defined callback to sort an array of 
+ *  floats. The qsort function requires the starting point of the array, number of elements in the array, size 
+ *  of each element, and a pointer to a callback comparison function. Once called, qsort() will sort the array
+ *  contents in ascending order according to the comparison function. The comparison function is called with
+ *  two arguments that point to the objects being compared - in this case two floats. The comparison function 
+ *  must return 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. If two members compare as equal, their order
+ *  in the sorted array is undefined.
+ *
+ *  @author Ross Harman, MHPCC
+ *   
+ *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-04-19 20:10:46 $
+ *
+ *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
+ */
+ 
+#ifndef PSSORT_H
+#define PSSORT_H
+
+/******************************************************************************/
+/*  DEFINE STATEMENTS                                                         */
+/******************************************************************************/
+
+// None
+
+/******************************************************************************/
+/*  TYPE DEFINITIONS                                                          */
+/******************************************************************************/
+
+// None
+
+/*****************************************************************************/
+/* FUNCTION PROTOTYPES                                                       */
+/*****************************************************************************/
+ 
+/** Sort an array of floats.
+ *
+ *  Sorts an array of floats in ascendin order with the qsort() stdlib function.
+ *
+ *  @return  psFloatArray*: Pointer to sorted psFloatArray.
+ */
+
 psFloatArray *psSort(psFloatArray *restrict out, const psFloatArray *restrict inArray);
+
+/** Creates an array of indices based on sort odred of float array.
+ *
+ *  Sorts an array of floats and creates an integer array holding indices of sorted float values based on 
+ *  pre-sort index positions.
+ *
+ *  @return  psIntArray*: Pointer to psIntArray of sorted indices.
+ */
+
 psIntArray *psSortIndex(psIntArray *restrict out, const psFloatArray *restrict inArray);
+
+#endif