Changeset 1020 for trunk/psLib/src/dataManip/psFunctions.h

Timestamp:

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

Author:

gusciora

Message:

...

File:

• trunk/psLib/src/dataManip/psFunctions.h (modified) (2 diffs)

trunk/psLib/src/dataManip/psFunctions.h

@@ +1 @@
+/** @file psFunctions.h
+ *  \brief Standard Mathematical Functions.
+ *  \ingroup Stats
+ *
+ *  This file will hold the prototypes for procedures which allocate, free,
+ *  and evaluate various polynomials.  Those polynomial structures are also
+ *  defined here.
+ *
+ *  @ingroup Stats
+ *
+ *  @author Someone at IfA
+ *  @author George Gusciora, MHPCC
+ *
+ *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-14 19:32:42 $
+ *
+ *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
+ */
+
 #if !defined(PS_FUNCTIONS_H)
 #define PS_FUNCTIONS_H
 
-/** \file psFunctions.h
- *  \brief Standard Mathematical Functions.
- *  \ingroup Stats
- */
 
 /** \addtogroup Stats
@@ -23 +38 @@
 
 
-psVector *psGaussianDev(float mean,
-                        float sigma,
-                        int Npts);
-
-/*****************************************************************************/
+/** Produce a vector of random numbers from a Gaussian distribution with
+    the specified mean and sigma */
+psVector *psGaussianDev(float mean,    ///< The mean of the Gaussian
+                        float sigma,   ///< The sigma of the Gaussian
+                        int Npts);     ///< The size of the vector
+
+
+
+
 
 /** One-dimensional polynomial */
 typedef struct
 {
-    int n;    ///< Number of terms
-    float *coeff;   ///< Coefficients
-    float *coeffErr;   ///< Error in coefficients
-    char *mask;    ///< Coefficient mask
+    int n;           ///< Number of terms
+    float *coeff;    ///< Coefficients
+    float *coeffErr; ///< Error in coefficients
+    char *mask;      ///< Coefficient mask
 }
 psPolynomial1D;