Index: trunk/archive/pslib/include/psFunctions.h =================================================================== --- trunk/archive/pslib/include/psFunctions.h (revision 298) +++ trunk/archive/pslib/include/psFunctions.h (revision 344) @@ -10,7 +10,7 @@ is not a Gaussian deviate. The 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 +psGaussian(float x, ///< Value at which to evaluate + float mean, ///< Mean for the Gaussian + float stddev ///< Standard deviation for the Gaussian ); @@ -19,32 +19,32 @@ /** One-dimensional polynomial */ typedef struct { - int n; //!< Number of terms - float *restrict coeff; //!< Coefficients - float *restrict coeffErr; //!< Error in coefficients - char *restrict mask; //!< Coefficient mask + int n; ///< Number of terms + float *restrict coeff; ///< Coefficients + float *restrict coeffErr; ///< Error in coefficients + char *restrict mask; ///< Coefficient mask } psPolynomial1D; /** Two-dimensional polynomial */ typedef struct { - int nX, nY; //!< Number of terms in x and y - float *restrict *restrict coeff; //!< Coefficients - float *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict mask; //!< Coefficients mask + int nX, nY; ///< Number of terms in x and y + float *restrict *restrict coeff; ///< Coefficients + float *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict mask; ///< Coefficients mask } psPolynomial2D; /** Three-dimensional polynomial */ typedef struct { - int nX, nY, nZ; //!< Number of terms in x, y and z - float *restrict *restrict *restrict coeff; //!< Coefficients - float *restrict *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict *restrict mask; //!< Coefficients mask + int nX, nY, nZ; ///< Number of terms in x, y and z + float *restrict *restrict *restrict coeff; ///< Coefficients + float *restrict *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict *restrict mask; ///< Coefficients mask } psPolynomial3D; /** Four-dimensional polynomial */ typedef struct { - int nW, nX, nY, nZ; //!< Number of terms in w, x, y and z - float *restrict *restrict *restrict *restrict coeff; //!< Coefficients - float *restrict *restrict *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict *restrict *restrict mask; //!< Coefficients mask + int nW, nX, nY, nZ; ///< Number of terms in w, x, y and z + float *restrict *restrict *restrict *restrict coeff; ///< Coefficients + float *restrict *restrict *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict *restrict *restrict mask; ///< Coefficients mask } psPolynomial4D; @@ -56,58 +56,58 @@ /** 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 - ); - -/** Destructor */ -void psPolynomial1DFree(psPolynomial1D *restrict myPoly //!< Polynomial to destroy +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 + ); + +/** Destructor */ +void psPolynomial1DFree(psPolynomial1D *restrict myPoly ///< Polynomial to destroy ); /** Destructor */ -void psPolynomial2DFree(psPolynomial2D *restrict myPoly //!< Polynomial to destroy - ); -/** Destructor */ -void psPolynomial3DFree(psPolynomial3D *restrict myPoly //!< Polynomial to destroy - ); -/** Destructor */ -void psPolynomial4DFree(psPolynomial4D *restrict myPoly //!< Polynomial to destroy +void psPolynomial2DFree(psPolynomial2D *restrict myPoly ///< Polynomial to destroy + ); +/** Destructor */ +void psPolynomial3DFree(psPolynomial3D *restrict myPoly ///< Polynomial to destroy + ); +/** Destructor */ +void psPolynomial4DFree(psPolynomial4D *restrict myPoly ///< Polynomial to destroy ); /** Evaluate 1D polynomial */ float -psEvalPolynomial1D(float x, //!< Value at which to evaluate - const psPolynomial1D *restrict myPoly //!< Coefficients for the polynomial +psEvalPolynomial1D(float x, ///< Value at which to evaluate + const psPolynomial1D *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial */ float -psEvalPolynomial2D(float x, //!< Value x at which to evaluate - float y, //!< Value y at which to evaluate - const psPolynomial2D *restrict myPoly //!< Coefficients for the polynomial +psEvalPolynomial2D(float x, ///< Value x at which to evaluate + float y, ///< Value y at which to evaluate + const psPolynomial2D *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial */ float -psEvalPolynomial3D(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 *restrict myPoly //!< Coefficients for the polynomial +psEvalPolynomial3D(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 *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial */ float -psEvalPolynomial4D(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 *restrict myPoly //!< Coefficients for the polynomial +psEvalPolynomial4D(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 *restrict myPoly ///< Coefficients for the polynomial ); @@ -120,32 +120,32 @@ /** Double-precision one-dimensional polynomial */ typedef struct { - int n; //!< Number of terms - double *restrict coeff; //!< Coefficients - double *restrict coeffErr; //!< Error in coefficients - char *restrict mask; //!< Coefficient mask + int n; ///< Number of terms + double *restrict coeff; ///< Coefficients + double *restrict coeffErr; ///< Error in coefficients + char *restrict mask; ///< Coefficient mask } psDPolynomial1D; /** Double-precision two-dimensional polynomial */ typedef struct { - int nX, nY; //!< Number of terms in x and y - double *restrict *restrict coeff; //!< Coefficients - double *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict mask; //!< Coefficients mask + int nX, nY; ///< Number of terms in x and y + double *restrict *restrict coeff; ///< Coefficients + double *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict mask; ///< Coefficients mask } psDPolynomial2D; /** Double-precision three-dimensional polynomial */ typedef struct { - int nX, nY, nZ; //!< Number of terms in x, y and z - double *restrict *restrict *restrict coeff; //!< Coefficients - double *restrict *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict *restrict mask; //!< Coefficient mask + int nX, nY, nZ; ///< Number of terms in x, y and z + double *restrict *restrict *restrict coeff; ///< Coefficients + double *restrict *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict *restrict mask; ///< Coefficient mask } psDPolynomial3D; /** Double-precision four-dimensional polynomial */ typedef struct { - int nW, nX, nY, nZ; //!< Number of terms in w, x, y and z - double *restrict *restrict *restrict *restrict coeff; //!< Coefficients - double *restrict *restrict *restrict *restrict coeffErr; //!< Error in coefficients - char *restrict *restrict *restrict *restrict mask; //!< Coefficients mask + int nW, nX, nY, nZ; ///< Number of terms in w, x, y and z + double *restrict *restrict *restrict *restrict coeff; ///< Coefficients + double *restrict *restrict *restrict *restrict coeffErr; ///< Error in coefficients + char *restrict *restrict *restrict *restrict mask; ///< Coefficients mask } psDPolynomial4D; @@ -156,28 +156,28 @@ /** 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 - ); - - -/** Destructor */ -void psDPolynomial1DFree(psDPolynomial1D *restrict myPoly //!< Polynomial to destroy - ); -/** Destructor */ -void psDPolynomial2DFree(psDPolynomial2D *restrict myPoly //!< Polynomial to destroy - ); -/** Destructor */ -void psDPolynomial3DFree(psDPolynomial3D *restrict myPoly //!< Polynomial to destroy - ); -/** Destructor */ -void psDPolynomial4DFree(psDPolynomial4D *restrict myPoly //!< Polynomial to destroy +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 + ); + + +/** Destructor */ +void psDPolynomial1DFree(psDPolynomial1D *restrict myPoly ///< Polynomial to destroy + ); +/** Destructor */ +void psDPolynomial2DFree(psDPolynomial2D *restrict myPoly ///< Polynomial to destroy + ); +/** Destructor */ +void psDPolynomial3DFree(psDPolynomial3D *restrict myPoly ///< Polynomial to destroy + ); +/** Destructor */ +void psDPolynomial4DFree(psDPolynomial4D *restrict myPoly ///< Polynomial to destroy ); @@ -185,30 +185,30 @@ /** Evaluate 1D polynomial (double precision) */ double -psEvalDPolynomial1D(double x, //!< Value at which to evaluate - const psDPolynomial1D *restrict myPoly //!< Coefficients for the polynomial +psEvalDPolynomial1D(double x, ///< Value at which to evaluate + const psDPolynomial1D *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 2D polynomial (double precision) */ double -psEvalDPolynomial2D(double x, //!< Value x at which to evaluate - double y, //!< Value y at which to evaluate - const psDPolynomial2D *restrict myPoly //!< Coefficients for the polynomial +psEvalDPolynomial2D(double x, ///< Value x at which to evaluate + double y, ///< Value y at which to evaluate + const psDPolynomial2D *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 3D polynomial (double precision) */ double -psEvalDPolynomial3D(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 *restrict myPoly //!< Coefficients for the polynomial +psEvalDPolynomial3D(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 *restrict myPoly ///< Coefficients for the polynomial ); /** Evaluate 4D polynomial (double precision) */ double -psEvalDPolynomial4D(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 *restrict myPoly //!< Coefficients for the polynomial +psEvalDPolynomial4D(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 *restrict myPoly ///< Coefficients for the polynomial );