Changeset 1294:2dec219d9ca2 in lemon-0.x for src/work

Timestamp:

04/03/05 12:20:49 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Documentation of abstract functions is in lp_solver_skeleton.h

Location:

src/work/athos/lp

Files:

• lp_base.h (modified) (5 diffs)
• lp_glpk.cc (modified) (1 diff)
• lp_glpk.h (modified) (1 diff)
• lp_solver_skeleton.cc (modified) (1 diff)
• lp_solver_skeleton.h (modified) (1 diff)

src/work/athos/lp/lp_base.h

@@ -362 +362 @@
     _FixId cols;
 
-    /// \e
     virtual int _addCol() = 0;
-    /// \e
     virtual int _addRow() = 0;
-    /// \e
-
-    /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
-    ///
     virtual void _setRowCoeffs(int i, 
                                int length,
                                int  const * indices, 
                                Value  const * values ) = 0;
-    /// \e
-
-    /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
-    ///
     virtual void _setColCoeffs(int i, 
                                int length,
                                int  const * indices, 
                                Value  const * values ) = 0;
-    
-    /// \e
-
-    /// The lower bound of a variable (column) have to be given by an 
-    /// extended number of type Value, i.e. a finite number of type 
-    /// Value or -\ref INF.
     virtual void _setColLowerBound(int i, Value value) = 0;
-    /// \e
-
-    /// The upper bound of a variable (column) have to be given by an 
-    /// extended number of type Value, i.e. a finite number of type 
-    /// Value or \ref INF.
     virtual void _setColUpperBound(int i, Value value) = 0;
-    /// \e
-
-    /// The lower bound of a linear expression (row) have to be given by an 
-    /// extended number of type Value, i.e. a finite number of type 
-    /// Value or -\ref INF.
     virtual void _setRowLowerBound(int i, Value value) = 0;
-    /// \e
-
-    /// The upper bound of a linear expression (row) have to be given by an 
-    /// extended number of type Value, i.e. a finite number of type 
-    /// Value or \ref INF.
     virtual void _setRowUpperBound(int i, Value value) = 0;
-
-    /// \e
     virtual void _setObjCoeff(int i, Value obj_coef) = 0;
-
-    ///\e
-    
-    ///\bug Wrong interface
-    ///
     virtual SolutionStatus _solve() = 0;
-
-    ///\e
-
-    ///\bug Wrong interface
-    ///
     virtual Value _getPrimal(int i) = 0;
-    ///\e
-
-    ///\bug unimplemented!!!!
+    virtual SolutionType _getPrimalType() = 0;
+
+
     void clearObj() {}
   public:
@@ -432 +389 @@
     virtual ~LpSolverBase() {}
 
-    ///\name Building up and modification of the LP
+    ///\name Build up and modify of the LP
 
     ///@{
@@ -439 +396 @@
     Col addCol() { Col c; c.id=cols.insert(_addCol()); return c;}
 
-    ///\brief Fill the elements of a container with newly created columns
-    ///(i.e a new variables)
+    ///\brief Adds several new columns
+    ///(i.e a variables) at once
     ///
     ///This magic function takes a container as its argument
@@ -639 +596 @@
 
 
-    ///\name Solving the LP
+    ///\name Solve the LP
 
     ///@{
@@ -648 +605 @@
     ///@}
     
-    ///\name Obtaining the solution LP
+    ///\name Obtain the solution
 
     ///@{
+
+    ///\e
+    SolutionType primalType() {
+      return _getPrimalType();
+    }
 
     ///\e

src/work/athos/lp/lp_glpk.cc

@@ -249 +249 @@
   }
   
+  LpGlpk::SolutionType LpGlpk::_getPrimalType()
+  {
+    return OPTIMAL;
+  }
+  
 
 

src/work/athos/lp/lp_glpk.h

@@ -77 +77 @@
     ///
     virtual Value _getPrimal(int i);
+    ///\e
+    
+    ///\bug Unimplemented
+    ///
+    virtual SolutionType _getPrimalType();
 
   };

src/work/athos/lp/lp_solver_skeleton.cc

@@ -76 +76 @@
   }
   
+  LpSolverSkeleton::SolutionType LpSolverSkeleton::_getPrimalType()
+  {
+    return OPTIMAL;
+  }
+  
 } //namespace lemon
 

src/work/athos/lp/lp_solver_skeleton.h

@@ -30 +30 @@
     
   protected:
+    /// \e
     virtual int _addCol();
+    /// \e
     virtual int _addRow();
+    /// \e
+
+    /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
+    ///
     virtual void _setRowCoeffs(int i, 
                                int length,
                                int  const * indices, 
                                Value  const * values );
+    /// \e
+
+    /// \warning Arrays are indexed from 1 (datum at index 0 is ignored)
+    ///
     virtual void _setColCoeffs(int i, 
                                int length,
                                int  const * indices, 
-                               Value  const * values);
+                               Value  const * values );
+    
+    /// \e
+
+    /// The lower bound of a variable (column) have to be given by an 
+    /// extended number of type Value, i.e. a finite number of type 
+    /// Value or -\ref INF.
     virtual void _setColLowerBound(int i, Value value);
+    /// \e
+
+    /// The upper bound of a variable (column) have to be given by an 
+    /// extended number of type Value, i.e. a finite number of type 
+    /// Value or \ref INF.
     virtual void _setColUpperBound(int i, Value value);
+    /// \e
+
+    /// The lower bound of a linear expression (row) have to be given by an 
+    /// extended number of type Value, i.e. a finite number of type 
+    /// Value or -\ref INF.
     virtual void _setRowLowerBound(int i, Value value);
+    /// \e
+
+    /// The upper bound of a linear expression (row) have to be given by an 
+    /// extended number of type Value, i.e. a finite number of type 
+    /// Value or \ref INF.
     virtual void _setRowUpperBound(int i, Value value);
+
+    /// \e
     virtual void _setObjCoeff(int i, Value obj_coef);
+
+    ///\e
+    
+    ///\bug Wrong interface
+    ///
     virtual SolutionStatus _solve();
+
+    ///\e
+
+    ///\bug Wrong interface
+    ///
     virtual Value _getPrimal(int i);
+    ///\e
+
+    ///\bug Wrong interface
+    ///
+    virtual SolutionType _getPrimalType();
+
   public:
     LpSolverSkeleton() : LpSolverBase(), col_num(0), row_num(0) {}