[Lemon-commits] [lemon_svn] alpar: r1767 - hugo/trunk/src/lemon

[Lemon SVN]

Author: alpar
Date: Fri Apr  8 17:24:01 2005
New Revision: 1767

Modified:
   hugo/trunk/src/lemon/lp_base.h
   hugo/trunk/src/lemon/lp_glpk.h

Log:
- Insert LP stuff into the module structure
- More doc

Modified: hugo/trunk/src/lemon/lp_base.h
==============================================================================
--- hugo/trunk/src/lemon/lp_base.h	(original)
+++ hugo/trunk/src/lemon/lp_base.h	Fri Apr  8 17:24:01 2005
@@ -30,6 +30,7 @@
 
 ///\file
 ///\brief The interface of the LP solver interface.
+///\ingroup gen_opt_group
 namespace lemon {
   
   ///Internal data structure to convert floating id's to fix one's
@@ -100,6 +101,9 @@
   };
     
   ///Common base class for LP solvers
+  
+  ///\todo Much more docs
+  ///\ingroup gen_opt_group
   class LpSolverBase {
 
   public:
@@ -217,7 +221,8 @@
     ///2*v-3.12*(v-w/2)+2
     ///v*2.1+(3*v+(v*12+w+6)*3)/2
     ///\endcode
-    ///are valid expressions. The usual assignment operations are also defined.
+    ///are valid \ref Expr "Expr"essions.
+    ///The usual assignment operations are also defined.
     ///\code
     ///e=v+w;
     ///e+=2*v-3.12*(v-w/2)+2;
@@ -230,8 +235,11 @@
     ///double c=e.constComp();
     ///\endcode
     ///
-    ///\note that \ref clear() not only sets all coefficients to 0 but also
+    ///\note \ref clear() not only sets all coefficients to 0 but also
     ///clears the constant components.
+    ///
+    ///\sa Constr
+    ///
     class Expr : public std::map<Col,Value>
     {
     public:
@@ -309,7 +317,9 @@
     };
     
     ///Linear constraint
-    //typedef LinConstr<Expr> Constr;
+
+    ///\todo document please
+    ///
     class Constr
     {
     public:
@@ -503,6 +513,8 @@
     ///\param u is the upper bound (\ref INF means no bound)
     ///\bug This is a temportary function. The interface will change to
     ///a better one.
+    ///\todo Option to control whether a constraint with a single variable is
+    ///added or not.
     void setRow(Row r, Value l,const Expr &e, Value u) {
       std::vector<int> indices;
       std::vector<Value> values;

Modified: hugo/trunk/src/lemon/lp_glpk.h
==============================================================================
--- hugo/trunk/src/lemon/lp_glpk.h	(original)
+++ hugo/trunk/src/lemon/lp_glpk.h	Fri Apr  8 17:24:01 2005
@@ -19,6 +19,7 @@
 
 ///\file
 ///\brief Header of the LEMON-GLPK lp solver interface.
+///\ingroup gen_opt_group
 
 #include "lp_base.h"
 extern "C" {
@@ -31,6 +32,7 @@
   /// \brief Wrapper for GLPK solver
   /// 
   /// This class implements a lemon wrapper for GLPK.
+  ///\ingroup gen_opt_group
   class LpGlpk : public LpSolverBase {
   protected:
     LPX* lp;