Changeset 1020 for trunk/psLib/src/math/psStats.h

Timestamp:

Jun 14, 2004, 9:33:09 AM (22 years ago)

Author:

gusciora

Message:

...

File:

• trunk/psLib/src/math/psStats.h (modified) (5 diffs)

trunk/psLib/src/math/psStats.h

@@ +1 @@
+/** @file  psStats.h
+ *  \brief basic statistical operations
+ *  @ingroup Stats
+ *
+ *  This file will hold the definition of the histogram and stats data
+ *  structures.  It also contains prototypes for procedures which operate
+ *  on those data structures.
+ *
+ *  @author George Gusciora, MHPCC
+ *
+ *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-14 19:33:09 $
+ *
+ *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
+ */
 #if !defined(PS_STATS_H)
 #define PS_STATS_H
-/******************************************************************************
-    This file will histogram/statistical functions and data structures.
- *****************************************************************************/
-/** \file psStats.h
- *  \brief basic statistical operations
- *  \ingroup Stats
- */
+
 #include "psVector.h"
 
@@ -36 +45 @@
 
 
-/** This is the generic statistics structure */
+/** This is the generic statistics structure.  It contails the data members
+    for the various statistic values.  It contains the options member to
+    specifiy which statistics must be calculated. */
 typedef struct
 {
@@ -74 +85 @@
              );
 
-/** Constructor */
+/** A constructor for the stats structure.*/
 psStats *psStatsAlloc(psStatsOptions options); ///< Statistics to measure
 
-/** Destructor */
+/** A destructor for the stats structure.*/
 void psStatsFree(psStats *restrict stats); ///< Stats structure to destroy
 
@@ -83 +94 @@
     Histogram functions and data structures.
  *****************************************************************************/
+/** The basic histogram structure which contains bounds and bins. */
 typedef struct
 {
@@ -111 +123 @@
 /** Calculate a histogram \ingroup MathGroup **/
 psHistogram *psHistogramVector (psHistogram *out,   ///< Histogram data
-                                psVector *in,       ///< Vector to analyse
-                                psVector *mask,     ///< Mask dat for input vector
+                                const psVector *restrict in,       ///< Vector to analyse
+                                const psVector *restrict mask,     ///< Mask dat for input vector
                                 int maskVal);       ///< Mask value