Changeset 153 for trunk/archive/pslib/include/psStats.h

Timestamp:

Mar 9, 2004, 12:28:16 PM (22 years ago)

Author:

Paul Price

Message:

Doxygen-ated the source files.

File:

• trunk/archive/pslib/include/psStats.h (modified) (1 diff)

trunk/archive/pslib/include/psStats.h

@@ -5 +5 @@
 #include "psStdArrays.h"
 
-/* Do Statistics on an array.  Returns a status value. */
+/** Do Statistics on an array.  Returns a status value. */
 int
-psArrayStats(const psFloatArray *restrict myArray, // Array to be analysed
-             const psIntArray *restrict maskArray, // Ignore elements where (maskArray & maskVal) != 0
-                                                   // May be NULL
-             unsigned int maskVal,      // Only mask elements with one of these bits set in maskArray
-             int numIter,               // Number of clipping iterations (0 not to clip)
-             float numSD,               // Number of s.d. to clip at
-             float *restrict mean,      // Mean of array (or NULL)
-             float *restrict sd,        // Standard deviation (or NULL)
-             float *restrict med        // Median (or NULL)
+psArrayStats(const psFloatArray *restrict myArray, //!< Array to be analysed
+             const psIntArray *restrict maskArray, //!< Ignore elements where (maskArray & maskVal) != 0
+                                                   //!< May be NULL
+             unsigned int maskVal,      //!< Only mask elements with one of these bits set in maskArray
+             int numIter,               //!< Number of clipping iterations (0 not to clip)
+             float numSD,               //!< Number of s.d. to clip at
+             float *restrict mean,      //!< Mean of array (or NULL)
+             float *restrict sd,        //!< Standard deviation (or NULL)
+             float *restrict med        //!< Median (or NULL)
              );
 
 /***********************************************************************************************************/
 
-/* Histograms */
+/** Histograms */
 typedef struct {
-    const psFloatArray *restrict lower, *restrict upper; // Lower and upper bounds for the bins
-    psIntArray *nums;                   // Number in each of the bins
-    const float minVal, maxVal;         // Minimum and maximum values
-    int minNum, maxNum;                 // Number below the minimum and above the maximum
+    const psFloatArray *restrict lower, *restrict upper; //!< Lower and upper bounds for the bins
+    psIntArray *nums;                   //!< Number in each of the bins
+    const float minVal, maxVal;         //!< Minimum and maximum values
+    int minNum, maxNum;                 //!< Number below the minimum and above the maximum
 } psHistogram;
 
 
-/* Constructor */
+/** Constructor */
 psHistogram *
-psHistogramNew(float lower,             // Lower limit for the bins
-               float upper,             // Upper limit for the bins
-               float size               // Size of the bins
+psHistogramNew(float lower,             //!< Lower limit for the bins
+               float upper,             //!< Upper limit for the bins
+               float size               //!< Size of the bins
     );
 
-/* Generic constructor */
+/** Generic constructor */
 psHistogram *
-psHistogramNewGeneric(const psFloatArray *restrict lower, // Lower bounds for the bins
-                      const psFloatArray *restrict upper, // Upper bounds for the bins
-                      float minVal,     // Minimum value
-                      float maxVal      // Maximum value
+psHistogramNewGeneric(const psFloatArray *restrict lower, //!< Lower bounds for the bins
+                      const psFloatArray *restrict upper, //!< Upper bounds for the bins
+                      float minVal,     //!< Minimum value
+                      float maxVal      //!< Maximum value
     );
 
-/* Destructor */
+/** Destructor */
 void
-psHistogramDel(psHistogram *restrict myHist // Histogram to destroy
+psHistogramDel(psHistogram *restrict myHist //!< Histogram to destroy
     );
 
 
-/* Calculate a histogram */
+/** Calculate a histogram */
 psHistogram *
-psGetArrayHistogram(psHistogram *restrict myHist, // Histogram data
-                    const psFloatArray *restrict myArray // Array to analyse
+psGetArrayHistogram(psHistogram *restrict myHist, //!< Histogram data
+                    const psFloatArray *restrict myArray //!< Array to analyse
     );