Changeset 1294:2dec219d9ca2 in lemon-0.x for src/work/athos/lp/lp_solver_skeleton.h

Timestamp:

04/03/05 12:20:49 (19 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

File:

• src/work/athos/lp/lp_solver_skeleton.h (modified) (1 diff)

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) {}