Changeset 1112:b258584569f2 in lemon-0.x for src/work/marci/lp

Timestamp:

02/01/05 16:26:47 (20 years ago)

Author:

marci

Branch:

default

Phase:

public

Convert:

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

Message:

try of grouping for documentation

File:

• src/work/marci/lp/lp_solver_base.h (modified) (7 diffs)

src/work/marci/lp/lp_solver_base.h

@@ -178 +178 @@
     solvers, i.e. it makes possible to write algorithms using LP's, 
     in which the solver can be changed to an other one easily.
+    \nosubgrouping
   */
   template <typename _Value>
   class LPSolverBase {
-  public:
+    
+    /*! @name Unchategorized functions and types (public members)
+    */
+    //@{
+  public:
+
+    //UNCATEGORIZED
+
     /// \e
     typedef _Value Value;
@@ -206 +214 @@
     /// \e
     virtual ~LPSolverBase() { }
-
-    //MATRIX INDEPEDENT MANIPULATING FUNCTIONS
-
-  public:
+    //@}
+
+    /*! @name Medium level interface (public members)
+      These functions appear in the low level and also in the high level 
+      interfaces thus these each of these functions have to be implemented 
+      only once in the different interfaces.
+      This means that these functions have to be reimplemented for all of the 
+      different lp solvers. These are basic functions, and have the same 
+      parameter lists in the low and high level interfaces. 
+    */
+    //@{
+  public:
+
+    //UNCATEGORIZED FUNCTIONS
+
     /// \e
     virtual void setMinimize() = 0;
@@ -215 +234 @@
     virtual void setMaximize() = 0;
 
-    //LOW LEVEL INTERFACE, MATRIX MANIPULATING FUNCTIONS
-
+    //SOLVER FUNCTIONS
+
+    /// \e
+    virtual void solveSimplex() = 0;
+    /// \e
+    virtual void solvePrimalSimplex() = 0;
+    /// \e
+    virtual void solveDualSimplex() = 0;
+    /// \e
+
+    //SOLUTION RETRIEVING
+
+    /// \e
+    virtual _Value getObjVal() = 0;
+
+    //OTHER FUNCTIONS
+
+    /// \e
+    virtual int rowNum() const = 0;
+    /// \e
+    virtual int colNum() const = 0;
+    /// \e
+    virtual int warmUp() = 0;
+    /// \e
+    virtual void printWarmUpStatus(int i) = 0;
+    /// \e
+    virtual int getPrimalStatus() = 0;
+    /// \e
+    virtual void printPrimalStatus(int i) = 0;
+    /// \e
+    virtual int getDualStatus() = 0;
+    /// \e
+    virtual void printDualStatus(int i) = 0;
+    /// Returns the status of the slack variable assigned to row \c row_it.
+    virtual int getRowStat(const RowIt& row_it) = 0;
+    /// \e
+    virtual void printRowStatus(int i) = 0;
+    /// Returns the status of the variable assigned to column \c col_it.
+    virtual int getColStat(const ColIt& col_it) = 0;
+    /// \e
+    virtual void printColStatus(int i) = 0;
+
+    //@}
+
+    /*! @name Low level interface (protected members)
+      Problem manipulating functions in the low level interface
+    */
+    //@{
   protected:
+
+    //MATRIX MANIPULATING FUNCTIONS
+
     /// \e
     virtual int _addCol() = 0;
@@ -280 +348 @@
     /// \e
     virtual _Value _getObjCoef(int i) = 0;
-
-    //LOW LEVEL, SOLUTION RETRIEVING FUNCTIONS
-
-  protected:
+    
+    //SOLUTION RETRIEVING
+
     /// \e
     virtual _Value _getPrimal(int i) = 0;
-
-    //HIGH LEVEL INTERFACE, MATRIX MANIPULATING FUNTIONS
-
-  public:
+    //@}
+    
+    /*! @name High level interface (public members)
+      Problem manipulating functions in the high level interface
+    */
+    //@{
+  public:
+
+    //MATRIX MANIPULATING FUNCTIONS
+
     /// \e
     ColIt addCol() {
@@ -403 +476 @@
     }
 
-    //MOST HIGH LEVEL, USER FRIEND FUNCTIONS
+    //SOLUTION RETRIEVING FUNCTIONS
+
+    /// \e
+    _Value getPrimal(const ColIt& col_it) {
+      return _getPrimal(col_iter_map[col_it]);
+    }    
+
+    //@}
+
+    /*! @name User friend interface
+      Problem manipulating functions in the user friend interface
+    */
+    //@{
+
+    //EXPRESSION TYPES
 
     /// \e
@@ -409 +496 @@
     /// \e
     typedef Expr<RowIt, _Value> DualExpression;
+
+    //MATRIX MANIPULATING FUNCTIONS
+
     /// \e
     void setRowCoeffs(RowIt row_it, const Expression& expr) {
@@ -436 +526 @@
       }
     }
-
-    //SOLVER FUNCTIONS
-
-    /// \e
-    virtual void solveSimplex() = 0;
-    /// \e
-    virtual void solvePrimalSimplex() = 0;
-    /// \e
-    virtual void solveDualSimplex() = 0;
-    /// \e
-
-    //HIGH LEVEL, SOLUTION RETRIEVING FUNCTIONS
-
-  public:
-
-    /// \e
-    _Value getPrimal(const ColIt& col_it) {
-      return _getPrimal(col_iter_map[col_it]);
-    }
-    /// \e
-    virtual _Value getObjVal() = 0;
-
-    //OTHER FUNCTIONS
-
-    /// \e
-    virtual int rowNum() const = 0;
-    /// \e
-    virtual int colNum() const = 0;
-    /// \e
-    virtual int warmUp() = 0;
-    /// \e
-    virtual void printWarmUpStatus(int i) = 0;
-    /// \e
-    virtual int getPrimalStatus() = 0;
-    /// \e
-    virtual void printPrimalStatus(int i) = 0;
-    /// \e
-    virtual int getDualStatus() = 0;
-    /// \e
-    virtual void printDualStatus(int i) = 0;
-    /// Returns the status of the slack variable assigned to row \c row_it.
-    virtual int getRowStat(const RowIt& row_it) = 0;
-    /// \e
-    virtual void printRowStatus(int i) = 0;
-    /// Returns the status of the variable assigned to column \c col_it.
-    virtual int getColStat(const ColIt& col_it) = 0;
-    /// \e
-    virtual void printColStatus(int i) = 0;
+    //@}
   };