Changeset 285 for trunk/archive/pslib/include

Timestamp:

Mar 23, 2004, 10:18:01 AM (22 years ago)

Author:

eugene

Message:

cleaned doxygen comments (one function description per function)
split psLibDesign appendix into group files & updated them

Location:

trunk/archive/pslib/include

Files:

• psFunctions.h (modified) (2 diffs)
• psMetaData.h (modified) (1 diff)
• psMinimize.h (modified) (2 diffs)

trunk/archive/pslib/include/psFunctions.h

@@ -55 +55 @@
  */
 
-/** Constructors */
-psPolynomial1D *psPolynomial1DAlloc(int n //!< Number of terms
-                                    );
-psPolynomial2D *psPolynomial2DAlloc(int nX, int nY //!< Number of terms in x and y
-                                    );
-psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ //!< Number of terms in x, y and z
-                                    );
-psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ //!< Number of terms in w, x, y and z
-                                    );
-
-/** Destructors */
-void psPolynomial1DFree(psPolynomial1D *restrict myPoly //!< Polynomial to destroy
-                        );
-void psPolynomial2DFree(psPolynomial2D *restrict myPoly //!< Polynomial to destroy
-                        );
-void psPolynomial3DFree(psPolynomial3D *restrict myPoly //!< Polynomial to destroy
-                        );
-void psPolynomial4DFree(psPolynomial4D *restrict myPoly //!< Polynomial to destroy
-                        );
-
+/** Constructor */
+psPolynomial1D *psPolynomial1DAlloc(int n) //!< Number of terms
+                                    ;
+/** Constructor */
+psPolynomial2D *psPolynomial2DAlloc(int nX, int nY) //!< Number of terms in x and y
+                                    ;
+/** Constructor */
+psPolynomial3D *psPolynomial3DAlloc(int nX, int nY, int nZ) //!< Number of terms in x, y and z
+                                    ;
+/** Constructor */
+psPolynomial4D *psPolynomial4DAlloc(int nW, int nX, int nY, int nZ) //!< Number of terms in w, x, y and z
+                                    ;
+
+/** Destructor */
+void psPolynomial1DFree(psPolynomial1D *restrict myPoly) //!< Polynomial to destroy
+;
+     
+/** Destructor */
+void psPolynomial2DFree(psPolynomial2D *restrict myPoly) //!< Polynomial to destroy
+                        ;
+/** Destructor */
+void psPolynomial3DFree(psPolynomial3D *restrict myPoly) //!< Polynomial to destroy
+                        ;
+/** Destructor */
+void psPolynomial4DFree(psPolynomial4D *restrict myPoly) //!< Polynomial to destroy
+                        ;
 
 /** Evaluate 1D polynomial */
@@ -149 +155 @@
  */
 
-/** Constructors */
+/** Constructor */
 psDPolynomial1D *psDPolynomial1DAlloc(int n //!< Number of terms
     );
+/** Constructor */
 psDPolynomial2D *psDPolynomial2DAlloc(int nX, int nY //!< Number of terms in x and y
     );
+/** Constructor */
 psDPolynomial3D *psDPolynomial3DAlloc(int nX, int nY, int nZ //!< Number of terms in x, y and z
     );
+/** Constructor */
 psDPolynomial4D *psDPolynomial4DAlloc(int nW, int nX, int nY, int nZ //!< Number of terms in w, x, y and z
     );
 
 
-/** Destructors */
+/** Destructor */
 void psDPolynomial1DFree(psDPolynomial1D *restrict myPoly //!< Polynomial to destroy
     );
+/** Destructor */
 void psDPolynomial2DFree(psDPolynomial2D *restrict myPoly //!< Polynomial to destroy
     );
+/** Destructor */
 void psDPolynomial3DFree(psDPolynomial3D *restrict myPoly //!< Polynomial to destroy
     );
+/** Destructor */
 void psDPolynomial4DFree(psDPolynomial4D *restrict myPoly //!< Polynomial to destroy
     );

trunk/archive/pslib/include/psMetaData.h

@@ -75 +75 @@
 /**** Utilities **********************************************************************/
 
+/// Add entry to the end of the metadata set
 psMetaDataItem *psMetaDataAppend(psMetaDataSet *restrict ms, psMetaDataItem *restrict item);
+
+/// delete entry from the metadata set
 psMetaDataItem *psMetaDataRemove(psMetaDataSet *restrict ms, const char *restrict key);
 
+/// reset the iterator to the start of the list
 void psMetaDataSetIterator(psMetaDataSet *ms);
+
+/// get the next entry in the sequence
 psMetaDataItem *psMetaDataGetNext(psMetaDataSet *restrict ms, const char *restrict match);
+
+/// find the metadata with the specified key
 psMetaDataItem *psMetaDataLookup(const psMetaDataSet *restrict ms, const char *restrict key);
 
+/// print metadata item to the specified stream
 void psMetaDataItemPrint(FILE *fd,              // file descriptor to write to
                          const psMetaDataItem *restrict ms, // item of metadata to print

trunk/archive/pslib/include/psMinimize.h

@@ -22 +22 @@
 psFloatArray *
 psMinimizeChi2(float (*evalModel)(const psFloatArray *restrict,
-                                  const psFloatArray *restrict), //!< Model to fit; receives domain and
-                                                                 //!< parameters
+                                  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
@@ -29 +28 @@
                psFloatArray *restrict initialGuess, //!< Initial guess
                const psIntArray *restrict guessMask //!< 1 = fit for parameter, 0 = hold parameter constant
-               );
+    );
 
 /** Derive a polynomial fit by least-squares --- can be done analytically */