Index: trunk/psLib/src/dataManip/psFunctions.h =================================================================== --- trunk/psLib/src/dataManip/psFunctions.h (revision 1406) +++ trunk/psLib/src/dataManip/psFunctions.h (revision 1407) @@ -1,2 +1,3 @@ + /** @file psFunctions.h * \brief Standard Mathematical Functions. @@ -12,6 +13,6 @@ * @author George Gusciora, MHPCC * -* @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-06 22:34:05 $ +* @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-07 00:06:06 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -19,9 +20,9 @@ #if !defined(PS_FUNCTIONS_H) -#define PS_FUNCTIONS_H - -#include - -#include "psVector.h" +# define PS_FUNCTIONS_H + +# include + +# include "psVector.h" /** \addtogroup Stats @@ -33,29 +34,23 @@ evaluated Gaussian is: \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] */ -float -psGaussian( float x, ///< Value at which to evaluate - float mean, ///< Mean for the Gaussian - float stddev, ///< Standard deviation for the Gaussian - bool normal ///< Indicates whether result should be normalized - ); - +float psGaussian(float x, // /< Value at which to evaluate + float mean, // /< Mean for the Gaussian + float stddev, // /< Standard deviation for the Gaussian + bool normal // /< Indicates whether result should be normalized + ); /** 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 - - - - +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; @@ -64,8 +59,9 @@ typedef struct { - int nX, nY; ///< Number of terms in x and y - float **coeff; ///< Coefficients - float **coeffErr; ///< Error in coefficients - char **mask; ///< Coefficients mask + int nX, + nY; // /< Number of terms in x and y + float **coeff; // /< Coefficients + float **coeffErr; // /< Error in coefficients + char **mask; // /< Coefficients mask } psPolynomial2D; @@ -74,8 +70,10 @@ typedef struct { - int nX, nY, nZ; ///< Number of terms in x, y and z - float ***coeff; ///< Coefficients - float ***coeffErr; ///< Error in coefficients - char ***mask; ///< Coefficients mask + int nX, + nY, + nZ; // /< Number of terms in x, y and z + float ***coeff; // /< Coefficients + float ***coeffErr; // /< Error in coefficients + char ***mask; // /< Coefficients mask } psPolynomial3D; @@ -84,56 +82,58 @@ typedef struct { - int nW, nX, nY, nZ; ///< Number of terms in w, x, y and z - float ****coeff; ///< Coefficients - float ****coeffErr; ///< Error in coefficients - char ****mask; ///< Coefficients mask + int nW, + nX, + nY, + nZ; // /< Number of terms in w, x, y and z + float ****coeff; // /< Coefficients + float ****coeffErr; // /< Error in coefficients + char ****mask; // /< Coefficients mask } psPolynomial4D; - /** Functions **************************************************************/ /** Constructor */ -psPolynomial1D *psPolynomial1DAlloc( int n ///< Number of terms - ); -/** Constructor */ -psPolynomial2D *psPolynomial2DAlloc( int nX, int nY ///< Number of terms in x and y - ); -/** Constructor */ -psPolynomial3D *psPolynomial3DAlloc( int nX, int nY, int nZ ///< Number of terms in x, y and z - ); -/** Constructor */ -psPolynomial4D *psPolynomial4DAlloc( int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and z +psPolynomial1D *psPolynomial1DAlloc(int n // /< Number of terms + ); + +/** Constructor */ +psPolynomial2D *psPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y + ); + +/** Constructor */ +psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z + ); + +/** Constructor */ +psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and + // z ); /** Evaluate 1D polynomial */ -float -psPolynomial1DEval( float x, ///< Value at which to evaluate - const psPolynomial1D *myPoly ///< Coefficients for the polynomial - ); +float psPolynomial1DEval(float x, // /< Value at which to evaluate + const psPolynomial1D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 2D polynomial */ -float -psPolynomial2DEval( float x, ///< Value x at which to evaluate - float y, ///< Value y at which to evaluate - const psPolynomial2D *myPoly ///< Coefficients for the polynomial - ); +float psPolynomial2DEval(float x, // /< Value x at which to evaluate + float y, // /< Value y at which to evaluate + const psPolynomial2D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 3D polynomial */ -float -psPolynomial3DEval( float x, ///< Value x at which to evaluate - float y, ///< Value y at which to evaluate - float z, ///< Value z at which to evaluate - const psPolynomial3D *myPoly ///< Coefficients for the polynomial - ); +float psPolynomial3DEval(float x, // /< Value x at which to evaluate + float y, // /< Value y at which to evaluate + float z, // /< Value z at which to evaluate + const psPolynomial3D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 4D polynomial */ -float -psPolynomial4DEval( float w, ///< Value w at which to evaluate - float x, ///< Value x at which to evaluate - float y, ///< Value y at which to evaluate - float z, ///< Value z at which to evaluate - const psPolynomial4D *myPoly ///< Coefficients for the polynomial - ); +float psPolynomial4DEval(float w, // /< Value w at which to evaluate + float x, // /< Value x at which to evaluate + float y, // /< Value y at which to evaluate + float z, // /< Value z at which to evaluate + const psPolynomial4D * myPoly // /< Coefficients for the polynomial + ); /*****************************************************************************/ @@ -144,8 +144,8 @@ typedef struct { - int n; ///< Number of terms - double *coeff; ///< Coefficients - double *coeffErr; ///< Error in coefficients - char *mask; ///< Coefficient mask + int n; // /< Number of terms + double *coeff; // /< Coefficients + double *coeffErr; // /< Error in coefficients + char *mask; // /< Coefficient mask } psDPolynomial1D; @@ -154,8 +154,9 @@ typedef struct { - int nX, nY; ///< Number of terms in x and y - double **coeff; ///< Coefficients - double **coeffErr; ///< Error in coefficients - char **mask; ///< Coefficients mask + int nX, + nY; // /< Number of terms in x and y + double **coeff; // /< Coefficients + double **coeffErr; // /< Error in coefficients + char **mask; // /< Coefficients mask } psDPolynomial2D; @@ -164,8 +165,10 @@ typedef struct { - int nX, nY, nZ; ///< Number of terms in x, y and z - double ***coeff; ///< Coefficients - double ***coeffErr; ///< Error in coefficients - char ***mask; ///< Coefficient mask + int nX, + nY, + nZ; // /< Number of terms in x, y and z + double ***coeff; // /< Coefficients + double ***coeffErr; // /< Error in coefficients + char ***mask; // /< Coefficient mask } psDPolynomial3D; @@ -174,55 +177,58 @@ typedef struct { - int nW, nX, nY, nZ; ///< Number of terms in w, x, y and z - double ****coeff; ///< Coefficients - double ****coeffErr; ///< Error in coefficients - char ****mask; ///< Coefficients mask + int nW, + nX, + nY, + nZ; // /< Number of terms in w, x, y and z + double ****coeff; // /< Coefficients + double ****coeffErr; // /< Error in coefficients + char ****mask; // /< Coefficients mask } psDPolynomial4D; /** Constructor */ -psDPolynomial1D *psDPolynomial1DAlloc( int n ///< Number of terms - ); -/** Constructor */ -psDPolynomial2D *psDPolynomial2DAlloc( int nX, int nY ///< Number of terms in x and y - ); -/** Constructor */ -psDPolynomial3D *psDPolynomial3DAlloc( int nX, int nY, int nZ ///< Number of terms in x, y and z - ); -/** Constructor */ -psDPolynomial4D *psDPolynomial4DAlloc( int nW, int nX, int nY, int nZ ///< Number of terms in w, x, y and z +psDPolynomial1D *psDPolynomial1DAlloc(int n // /< Number of terms + ); + +/** Constructor */ +psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY // /< Number of terms in x and y + ); + +/** Constructor */ +psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ // /< Number of terms in x, y and z + ); + +/** Constructor */ +psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ // /< Number of terms in w, x, y and + // z ); /** Evaluate 1D polynomial (double precision) */ -double -psDPolynomial1DEval( double x, ///< Value at which to evaluate - const psDPolynomial1D *myPoly ///< Coefficients for the polynomial - ); +double psDPolynomial1DEval(double x, // /< Value at which to evaluate + const psDPolynomial1D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 2D polynomial (double precision) */ -double -psDPolynomial2DEval( double x, ///< Value x at which to evaluate - double y, ///< Value y at which to evaluate - const psDPolynomial2D *myPoly ///< Coefficients for the polynomial - ); +double psDPolynomial2DEval(double x, // /< Value x at which to evaluate + double y, // /< Value y at which to evaluate + const psDPolynomial2D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 3D polynomial (double precision) */ -double -psDPolynomial3DEval( double x, ///< Value x at which to evaluate - double y, ///< Value y at which to evaluate - double z, ///< Value z at which to evaluate - const psDPolynomial3D *myPoly ///< Coefficients for the polynomial - ); +double psDPolynomial3DEval(double x, // /< Value x at which to evaluate + double y, // /< Value y at which to evaluate + double z, // /< Value z at which to evaluate + const psDPolynomial3D * myPoly // /< Coefficients for the polynomial + ); /** Evaluate 4D polynomial (double precision) */ -double -psDPolynomial4DEval( double w, ///< Value w at which to evaluate - double x, ///< Value x at which to evaluate - double y, ///< Value y at which to evaluate - double z, ///< Value z at which to evaluate - const psDPolynomial4D *myPoly ///< Coefficients for the polynomial - ); - -/* \} */ // End of MathGroup Functions +double psDPolynomial4DEval(double w, // /< Value w at which to evaluate + double x, // /< Value x at which to evaluate + double y, // /< Value y at which to evaluate + double z, // /< Value z at which to evaluate + const psDPolynomial4D * myPoly // /< Coefficients for the polynomial + ); + +/* \} */// End of MathGroup Functions #endif