Changeset 1328:a8dd11348853 in lemon-0.x

Timestamp:

04/08/05 17:24:01 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1767

Message:

• Insert LP stuff into the module structure
• More doc

Location:

src/lemon

Files:

• lp_base.h (modified) (6 diffs)
• lp_glpk.h (modified) (2 diffs)

src/lemon/lp_base.h

@@ -31 +31 @@
 ///\file
 ///\brief The interface of the LP solver interface.
+///\ingroup gen_opt_group
 namespace lemon {
   
@@ -101 +102 @@
     
   ///Common base class for LP solvers
+  
+  ///\todo Much more docs
+  ///\ingroup gen_opt_group
   class LpSolverBase {
 
@@ -218 +222 @@
     ///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;
@@ -231 +236 @@
     ///\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>
     {
@@ -310 +318 @@
     
     ///Linear constraint
-    //typedef LinConstr<Expr> Constr;
+
+    ///\todo document please
+    ///
     class Constr
     {
@@ -504 +514 @@
     ///\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;

src/lemon/lp_glpk.h

@@ -20 +20 @@
 ///\file
 ///\brief Header of the LEMON-GLPK lp solver interface.
+///\ingroup gen_opt_group
 
 #include "lp_base.h"
@@ -32 +33 @@
   /// 
   /// This class implements a lemon wrapper for GLPK.
+  ///\ingroup gen_opt_group
   class LpGlpk : public LpSolverBase {
   protected: