Changeset 4293 for trunk/psLib/src/dataManip/psStats.h

Timestamp:

Jun 16, 2005, 2:11:08 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/dataManip/psStats.h (modified) (3 diffs)

trunk/psLib/src/dataManip/psStats.h

@@ -14 +14 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.42 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-08 23:40:45 $
+ *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-17 00:11:05 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -37 +37 @@
 // XXX: Is PS_STAT_ROBUST_FOR_SAMPLE obsolete?
 typedef enum {
-    PS_STAT_SAMPLE_MEAN = 0x000001,
-    PS_STAT_SAMPLE_MEDIAN = 0x000002,
-    PS_STAT_SAMPLE_STDEV = 0x000004,
-    PS_STAT_SAMPLE_QUARTILE = 0x000008,
-    PS_STAT_ROBUST_MEAN = 0x000010,
-    PS_STAT_ROBUST_MEDIAN = 0x000020,
-    PS_STAT_ROBUST_MODE = 0x000040,
-    PS_STAT_ROBUST_STDEV = 0x000080,
-    PS_STAT_ROBUST_QUARTILE = 0x000100,
-    PS_STAT_CLIPPED_MEAN = 0x000200,
-    PS_STAT_CLIPPED_STDEV = 0x000400,
-    PS_STAT_MAX =  0x000800,
-    PS_STAT_MIN =  0x001000,
-    PS_STAT_USE_RANGE =  0x002000,
-    PS_STAT_USE_BINSIZE = 0x004000,
-    PS_STAT_ROBUST_FOR_SAMPLE = 0x008000
+    PS_STAT_SAMPLE_MEAN = 0x000001,         ///< Sample Mean
+    PS_STAT_SAMPLE_MEDIAN = 0x000002,       ///< Sample Median
+    PS_STAT_SAMPLE_STDEV = 0x000004,        ///< Sample Standard Deviation
+    PS_STAT_SAMPLE_QUARTILE = 0x000008,     ///< Sample Quartile
+    PS_STAT_ROBUST_MEAN = 0x000010,         ///< Robust Mean
+    PS_STAT_ROBUST_MEDIAN = 0x000020,       ///< Robust Median
+    PS_STAT_ROBUST_MODE = 0x000040,         ///< Robust Mode
+    PS_STAT_ROBUST_STDEV = 0x000080,        ///< Robust Standarad Deviation
+    PS_STAT_ROBUST_QUARTILE = 0x000100,     ///< Robust Quartile
+    PS_STAT_CLIPPED_MEAN = 0x000200,        ///< Clipped Mean
+    PS_STAT_CLIPPED_STDEV = 0x000400,       ///< Clipped Standard Deviation
+    PS_STAT_MAX =  0x000800,                ///< Maximum
+    PS_STAT_MIN =  0x001000,                ///< Minumum
+    PS_STAT_USE_RANGE =  0x002000,          ///< Range
+    PS_STAT_USE_BINSIZE = 0x004000,         ///< Binsize
+    PS_STAT_ROBUST_FOR_SAMPLE = 0x008000    ///< Robust for sample
 } psStatsOptions;
 
@@ -180 +180 @@
 // XXX: Create a single, generic, version of the vector normalize function.
 // XXX: Ask IfA for a public psLib function.
-void p_psNormalizeVectorRangeU8(psVector* myData, psU8 low, psU8 high);
-void p_psNormalizeVectorRangeU16(psVector* myData, psU16 low, psU16 high);
-void p_psNormalizeVectorRangeU32(psVector* myData, psU32 low, psU32 high);
-void p_psNormalizeVectorRangeU64(psVector* myData, psU64 low, psU64 high);
-void p_psNormalizeVectorRangeS8(psVector* myData, psS8 low, psS8 high);
-void p_psNormalizeVectorRangeS16(psVector* myData, psS16 low, psS16 high);
-void p_psNormalizeVectorRangeS32(psVector* myData, psS32 low, psS32 high);
-void p_psNormalizeVectorRangeS64(psVector* myData, psS64 low, psS64 high);
-void p_psNormalizeVectorRangeF32(psVector* myData, psF32 low, psF32 high);
-void p_psNormalizeVectorRangeF64(psVector* myData, psF64 low, psF64 high);
+
+/** Normalize the range of a vector containing U8 values  */
+void p_psNormalizeVectorRangeU8(
+    psVector* myData,                  ///< Vector containing the U8 values
+    psU8 low,                          ///< Minimum value
+    psU8 high                          ///< Maximum value
+);
+
+/** Normalize the range of a vector containing U16 values  */
+void p_psNormalizeVectorRangeU16(
+    psVector* myData,                  ///< Vector containing the U16 values
+    psU16 low,                         ///< Minimum value
+    psU16 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing U32 values  */
+void p_psNormalizeVectorRangeU32(
+    psVector* myData,                  ///< Vector containing the U32 values
+    psU32 low,                         ///< Minimum value
+    psU32 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing U64 values  */
+void p_psNormalizeVectorRangeU64(
+    psVector* myData,                  ///< Vector containing the U64 values
+    psU64 low,                         ///< Minimum value
+    psU64 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing S8 values  */
+void p_psNormalizeVectorRangeS8(
+    psVector* myData,                  ///< Vector containing the S8 values
+    psS8 low,                          ///< Minimum value
+    psS8 high                          ///< Maximum value
+);
+
+/** Normalize the range of a vector containing S16 values  */
+void p_psNormalizeVectorRangeS16(
+    psVector* myData,                  ///< Vector containing the S16 values
+    psS16 low,                         ///< Minimum value
+    psS16 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing S32 values  */
+void p_psNormalizeVectorRangeS32(
+    psVector* myData,                  ///< Vector containing the S32 values
+    psS32 low,                         ///< Minimum value
+    psS32 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing S64 values  */
+void p_psNormalizeVectorRangeS64(
+    psVector* myData,                  ///< Vector containing the S64 values
+    psS64 low,                         ///< Minimum value
+    psS64 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing F32 values  */
+void p_psNormalizeVectorRangeF32(
+    psVector* myData,                  ///< Vector containing the F32 values
+    psF32 low,                         ///< Minimum value
+    psF32 high                         ///< Maximum value
+);
+
+/** Normalize the range of a vector containing F64 values  */
+void p_psNormalizeVectorRangeF64(
+    psVector* myData,                  ///< Vector containing the F64 values
+    psF64 low,                         ///< Minimum value
+    psF64 high                         ///< Maximum value
+);
 
 /// @}