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

Timestamp:

Mar 15, 2004, 3:20:03 PM (22 years ago)

Author:

eugene

Message:

added Doxygen \file and \defgroup entries
some basic reorganization

File:

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

trunk/archive/pslib/include/psMinimize.h

@@ -1 @@
-#if !defined(PS_MINIMISE_H)
-#define PS_MINIMISE_H
+#if !defined(PS_MINIMIZE_H)
+#define PS_MINIMIZE_H
 
 /** \file psMinimize.h
@@ -7 +7 @@
  */
 
-/* Minimisation */
-
-/** Minimise a particular function */
+/** Minimize a particular function */
 psFloatArray *
-psMinimise(float (*myFunction)(const psFloatArray *restrict),   //!< Function to minimise
+psMinimize(float (*myFunction)(const psFloatArray *restrict),   //!< Function to minimize
            psFloatArray *restrict initialGuess //!< Initial guess
            );
 
 
-/** Minimise chi^2 for input data */
+/** Minimize chi^2 for input data */
 psFloatArray *
-psMinimiseChi2(float (*evalModel)(const psFloatArray *restrict,
+psMinimizeChi2(float (*evalModel)(const psFloatArray *restrict,
                                   const psFloatArray *restrict), //!< Model to fit; receives domain and
                                                                  //!< parameters