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

Timestamp:

May 5, 2005, 12:23:29 PM (21 years ago)

Author:

gusciora

Message:

Must add in doxygen comments.

File:

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

trunk/psLib/src/dataManip/psMinimize.h

@@ -8 +8 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.41 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-05-05 22:15:16 $
+ *  @version $Revision: 1.42 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-05-05 22:23:29 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -39 +39 @@
 typedef struct
 {
-    psS32 maxIter;                       ///< Convergence limit
+    psS32 maxIter;                     ///< Convergence limit
     psF32 tol;                         ///< Error Tolerance
     psF32 value;                       ///< Value of function at minimum
-    psS32 iter;                          ///< Number of iterations to date
+    psS32 iter;                        ///< Number of iterations to date
     psF32 lastDelta;                   ///< The last difference for the fit
 }
 psMinimization;
 
-psMinimization *psMinimizationAlloc(psS32 maxIter,
-                                    psF32 tol);
+psMinimization *psMinimizationAlloc(psS32 maxIter,   ///< Number of minimization iterations to perform.
+                                    psF32 tol        ///< Requested error tolerance
+                                   );
 
 /** Derive a polynomial fit.