Changeset 1426 for trunk/psLib/src/dataManip/psMinimize.h

Timestamp:

Aug 9, 2004, 12:44:25 PM (22 years ago)

Author:

desonia

Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:

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

trunk/psLib/src/dataManip/psMinimize.h

@@ -22 +22 @@
 
 /** Minimize chi^2 for input data */
-psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict),     // /<
+psVector *psMinimizeChi2(float (*evalModel) (const psVector * restrict, const psVector * restrict),     ///<
                          // Model
                          // to
@@ -29 +29 @@
                          // and
                          // params)
-                         float (*DevalModel) (const psVector * restrict, const psVector * restrict, int),       // /<
+                         float (*DevalModel) (const psVector * restrict, const psVector * restrict, int),       ///<
                          // Derivative
                          // of
@@ -38 +38 @@
                          // and
                          // params)
-                         const psImage * restrict domain,       // /< The domain values for the corresponding
+                         const psImage * restrict domain,       ///< The domain values for the corresponding
                          // measurements
-                         const psVector * restrict data,        // /< Data to fit
-                         const psVector * restrict errors,      // /< Errors in the data
-                         psVector * restrict initialGuess,      // /< Initial guess
-                         const psVector * restrict paramMask,   // /< 1 = fit for parameter, 0 = hold
+                         const psVector * restrict data,        ///< Data to fit
+                         const psVector * restrict errors,      ///< Errors in the data
+                         psVector * restrict initialGuess,      ///< Initial guess
+                         const psVector * restrict paramMask,   ///< 1 = fit for parameter, 0 = hold
                          // parameter constant
                          float *chiSq);
 
 /** Derive a polynomial fit by chi^2 minimisation (analytically) */
-psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly,        // /< Polynomial to fit
-                                        const psVector * restrict x,    // /< Ordinates (or NULL to just use
+psPolynomial1D *psVectorFitPolynomial1D(psPolynomial1D * myPoly,        ///< Polynomial to fit
+                                        const psVector * restrict x,    ///< Ordinates (or NULL to just use
                                         // the indices)
-                                        const psVector * restrict y,    // /< Coordinates
-                                        const psVector * restrict yErr  // /< Errors in coordinates, or NULL
+                                        const psVector * restrict y,    ///< Coordinates
+                                        const psVector * restrict yErr  ///< Errors in coordinates, or NULL
                                        );