[oMetah-devel] ometah common/itsPoint.hpp common/itsSet.hpp pr...

[Johann]

CVSROOT:        /cvsroot/ometah
Module name:    ometah
Branch:         
Changes by:     Johann <address@hidden> 05/02/04 15:10:19

Modified files:
        common         : itsPoint.hpp itsSet.hpp 
        problem        : itsProblem.hpp 

Log message:
        * format of comments

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/ometah/ometah/common/itsPoint.hpp.diff?tr1=1.1&tr2=1.2&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/ometah/ometah/common/itsSet.hpp.diff?tr1=1.1&tr2=1.2&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/ometah/ometah/problem/itsProblem.hpp.diff?tr1=1.1&tr2=1.2&r1=text&r2=text

Patches:
Index: ometah/common/itsPoint.hpp
diff -u ometah/common/itsPoint.hpp:1.1 ometah/common/itsPoint.hpp:1.2
--- ometah/common/itsPoint.hpp:1.1      Fri Feb  4 14:12:59 2005
+++ ometah/common/itsPoint.hpp  Fri Feb  4 15:10:18 2005
@@ -22,21 +22,21 @@
  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
  
- #ifndef ITSPOINT
- #define ITSPOINT
+#ifndef ITSPOINT
+#define ITSPOINT
  
  
- //! itsPoint class
- /*! A common class for the Benchmark, that includes a value
-        and a solution vector */
- 
+//! The point abstraction
+/*! 
+  A point is a value and a solution vector
+*/
  class itsPoint
  {
  public:
-        //! the solution vector 
-        vector<double> solution;
-        //! the value vector
-     vector<double> values;
+   //! the solution vector 
+   vector<double> solution;
+   //! the value vector
+   vector<double> values;
  }
  
- #endif
+#endif
Index: ometah/common/itsSet.hpp
diff -u ometah/common/itsSet.hpp:1.1 ometah/common/itsSet.hpp:1.2
--- ometah/common/itsSet.hpp:1.1        Fri Feb  4 14:51:47 2005
+++ ometah/common/itsSet.hpp    Fri Feb  4 15:10:18 2005
@@ -22,23 +22,37 @@
  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
  
- #ifndef ITSSET
- #define ITSSET
+#ifndef ITSSET
+#define ITSSET
  
- 
- template <class T>
- 
- class itsSet
- {
- protected:
-        /*! the collection hash map contains T classes */
-        vector<T> collection;
- public:
-        /*! add a T to be defined in the collection hash map */
-        void add(T);
-        /*! remove a T member from the collection hash map */
-        void remove(string);
- }
- 
- 
- #endif ITSSET
+//! A common class for all sets of objects
+/*!
+  It uses templates to permit any kind of instanciation
+*/ 
+template <class T>
+class itsSet
+{
+protected:
+
+  //! The collection of instance
+  /*! 
+    The collection hash map contains T classes 
+  */
+  vector<T> collection;
+  
+public:
+  //! Add an object
+  /*!  
+    Add a T in the collection hash map, which is of the form
+    [<string> => <object>]
+  */
+  void add(T);
+  
+  //! Remove an object
+  /*! 
+    Remove a T member from the collection hash map, specifying its key
+  */
+  void remove(string);
+}
+
+#endif ITSSET
Index: ometah/problem/itsProblem.hpp
diff -u ometah/problem/itsProblem.hpp:1.1 ometah/problem/itsProblem.hpp:1.2
--- ometah/problem/itsProblem.hpp:1.1   Fri Feb  4 14:25:56 2005
+++ ometah/problem/itsProblem.hpp       Fri Feb  4 15:10:19 2005
@@ -30,14 +30,16 @@
 
 
 //! The base classe for problems instances
-/*! All classes of problem inherit from itsProblem, and declares the
+/*! 
+  All classes of problem inherit from itsProblem, and declares the
   virtual functions.
  */
 class itsProblem 
 {
 protected:
   //! The name of the problem
-  /*! This must be a unique name in the source tree
+  /*! 
+    This must be a unique name in the source tree
   */
   string name;
 
@@ -81,13 +83,15 @@
 
 
   //! Return all available informations in a fashion way
-  /*! Concatenate all string describing the problem and returns them.
+  /*! 
+    Concatenate all string describing the problem and returns them.
   */
   string getInformations();
 
 
   //! The objective function
-  /*! This is the main part of the problem. This function computes the
+  /*! 
+    This is the main part of the problem. This function computes the
     value of the point and return it.
    */
   virtual vector<double> objectiveFunction(itsPoint);
@@ -95,7 +99,8 @@
 
 
 //! Abstract factory base class for problem instances
-/*! This is the base class for all factory classes
+/*! 
+  This is the base class for all factory classes
  */
 class itsProblemFactory
 {