Changeset 344 for trunk/archive/pslib/include/psMinimize.h

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

• trunk/archive/pslib/include/psMinimize.h (modified) (2 diffs)

trunk/archive/pslib/include/psMinimize.h

@@ -14 +14 @@
 /** Minimize a particular non-linear function */
 psFloatArray *
-psMinimize(float (*myFunction)(const psFloatArray *restrict),   //!< Function to minimize
-           psFloatArray *restrict initialGuess //!< Initial guess
+psMinimize(float (*myFunction)(const psFloatArray *restrict),   ///< Function to minimize
+           psFloatArray *restrict initialGuess ///< Initial guess
            );
 
@@ -22 +22 @@
 psFloatArray *
 psMinimizeChi2(float (*evalModel)(const psFloatArray *restrict,
-                                  const psFloatArray *restrict), //!< Model to fit; (domain and params)
-               const psFloatArray *restrict domain, //!< The domain values for the corresponding measurements
-               const psFloatArray *restrict data, //!< Data to fit
-               const psFloatArray *restrict errors, //!< Errors in the data
-               psFloatArray *restrict initialGuess, //!< Initial guess
-               const psIntArray *restrict guessMask //!< 1 = fit for parameter, 0 = hold parameter constant
+                                  const psFloatArray *restrict), ///< Model to fit; (domain and params)
+               const psFloatArray *restrict domain, ///< The domain values for the corresponding measurements
+               const psFloatArray *restrict data, ///< Data to fit
+               const psFloatArray *restrict errors, ///< Errors in the data
+               psFloatArray *restrict initialGuess, ///< Initial guess
+               const psIntArray *restrict guessMask ///< 1 = fit for parameter, 0 = hold parameter constant
     );
 
 /** Derive a polynomial fit by chi^2 minimisation --- can be done analytically */
 psPolynomial1D *
-psGetArrayPolynomial(psPolynomial1D myPoly, //!< Polynomial to fit
-                     const psFloatArray *restrict x, //!< Ordinates (or NULL to just use the indices)
-                     const psFloatArray *restrict y, //!< Coordinates
-                     const psFloatArray *restrict yErr //!< Errors in coordinates, or NULL
+psGetArrayPolynomial(psPolynomial1D myPoly, ///< Polynomial to fit
+                     const psFloatArray *restrict x, ///< Ordinates (or NULL to just use the indices)
+                     const psFloatArray *restrict y, ///< Coordinates
+                     const psFloatArray *restrict yErr ///< Errors in coordinates, or NULL
     );