Changeset 153 for trunk/archive/pslib/include/psMinimise.h

Timestamp:

Mar 9, 2004, 12:28:16 PM (22 years ago)

Author:

Paul Price

Message:

Doxygen-ated the source files.

File:

• trunk/archive/pslib/include/psMinimise.h (modified) (1 diff)

trunk/archive/pslib/include/psMinimise.h

@@ -7 +7 @@
 /* Minimisation */
 
-/* Minimise a particular function */
+/** Minimise a particular function */
 psFloatArray *
-psMinimise(float (*myFunction)(const psFloatArray *restrict),   // Function to minimise
-           psFloatArray *restrict initialGuess // Initial guess
+psMinimise(float (*myFunction)(const psFloatArray *restrict),   //!< Function to minimise
+           psFloatArray *restrict initialGuess //!< Initial guess
            );
 
 
-/* Minimise chi^2 for input data */
+/** Minimise chi^2 for input data */
 psFloatArray *
 psMinimiseChi2(float (*evalModel)(const psFloatArray *restrict,
-                                  const psFloatArray *restrict), // Model to fit; receives domain and
-                                                                   // parameters
-               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; receives domain and
+                                                                 //!< parameters
+               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 that goes through the points --- can be done analytically */
+/** Derive a polynomial that goes through the points --- can be done analytically */
 psFloatArray *
-psGetArrayPolynomial(const psFloatArray *restrict ord, // Ordinates (or NULL to just use the indices)
-                     const psFloatArray *restrict coord // Coordinates
+psGetArrayPolynomial(const psFloatArray *restrict ord, //!< Ordinates (or NULL to just use the indices)
+                     const psFloatArray *restrict coord //!< Coordinates
     );