Ticket #326: 326-lp-mip-1e16e62a9ea1.patch

lemon/lp_base.h

@@ -1790 +1790 @@
   ///
   /// \brief Common base class for LP solvers
   ///
-  /// This class is an abstract base class for LP solvers. This class
+  /// This class is an abstract base class for LP solvers. It
   /// provides a full interface for set and modify an LP problem,
   /// solve it and retrieve the solution. You can use one of the
   /// descendants as a concrete implementation, or the \c Lp
@@ -1800 +1800 @@
   class LpSolver : virtual public LpBase {
   public:
 
-    /// The problem types for primal and dual problems
+    /// \brief The problem types for primal and dual problems
+    ///
+    /// The problem types for primal and dual problems.
     enum ProblemType {
       /// = 0. Feasible solution hasn't been found (but may exist).
       UNDEFINED = 0,
@@ -1814 +1816 @@
       UNBOUNDED = 4
     };
 
-    ///The basis status of variables
+    /// \brief The basis status of variables
+    ///
+    /// The basis status of variables.
     enum VarStatus {
       /// The variable is in the basis
       BASIC, 
@@ -1857 +1861 @@
 
     ///@{
 
-    ///\e Solve the LP problem at hand
+    ///\brief Solve the specified LP problem
     ///
+    ///This function solves the specified LP problem.
     ///\return The result of the optimization procedure. Possible
     ///values and their meanings can be found in the documentation of
     ///\ref SolveExitStatus.
@@ -1870 +1875 @@
 
     ///@{
 
-    /// The type of the primal problem
+    /// Return the type of the primal problem
+
+    /// This function returns the type of the primal problem.
+    /// \see ProblemType
     ProblemType primalType() const {
       return _getPrimalType();
     }
 
-    /// The type of the dual problem
+    /// Return the type of the dual problem
+
+    /// This function returns the type of the dual problem.
+    /// \see ProblemType
     ProblemType dualType() const {
       return _getDualType();
     }
 
+    /// Return the primal value of the objective function
+    
+    /// This function returns the primal value of the objective function.
+    /// \return
+    /// - \ref INF or -\ref INF means either infeasibility or unboundedness
+    ///   of the primal problem, depending on whether we minimize or maximize.
+    /// - \ref NaN if no primal solution is found.
+    /// - The (finite) objective value if an optimal solution is found.
+    Value primalValue() const { return _getPrimalValue()+obj_const_comp;}
+
+    /// Return the primal value of the objective function
+
+    /// This function returns the primal value of the objective function.
+    /// It is an alias for \ref primalValue().
+    Value primal() const { return _getPrimalValue()+obj_const_comp;}
+
     /// Return the primal value of the column
 
-    /// Return the primal value of the column.
+    /// This function returns the primal value of the given column.
     /// \pre The problem is solved.
     Value primal(Col c) const { return _getPrimal(cols(id(c))); }
 
     /// Return the primal value of the expression
 
-    /// Return the primal value of the expression, i.e. the dot
-    /// product of the primal solution and the expression.
+    /// This function returns the primal value of the given expression,
+    /// i.e. the dot product of the primal solution and the expression.
     /// \pre The problem is solved.
     Value primal(const Expr& e) const {
       double res = *e;
@@ -1898 +1925 @@
       }
       return res;
     }
-    /// Returns a component of the primal ray
+
+    /// Return a component of the primal ray
     
     /// The primal ray is solution of the modified primal problem,
     /// where we change each finite bound to 0, and we looking for a
@@ -1915 +1943 @@
 
     /// Return the dual value of the row
 
-    /// Return the dual value of the row.
+    /// This function returns the dual value of the given row.
     /// \pre The problem is solved.
     Value dual(Row r) const { return _getDual(rows(id(r))); }
 
     /// Return the dual value of the dual expression
 
-    /// Return the dual value of the dual expression, i.e. the dot
-    /// product of the dual solution and the dual expression.
+    /// This function returns the dual value of the given dual expression,
+    /// i.e. the dot product of the dual solution and the dual expression.
     /// \pre The problem is solved.
     Value dual(const DualExpr& e) const {
       double res = 0.0;
@@ -1932 +1960 @@
       return res;
     }
 
-    /// Returns a component of the dual ray
+    /// Return a component of the dual ray
     
     /// The dual ray is solution of the modified primal problem, where
     /// we change each finite bound to 0 (i.e. the objective function
@@ -1949 +1977 @@
 
     /// Return the basis status of the column
 
+    /// This function returns the basis status of the column.
     /// \see VarStatus
     VarStatus colStatus(Col c) const { return _getColStatus(cols(id(c))); }
 
     /// Return the basis status of the row
 
+    /// This function returns the basis status of the row.
     /// \see VarStatus
     VarStatus rowStatus(Row r) const { return _getRowStatus(rows(id(r))); }
-
-    ///The value of the objective function
-
-    ///\return
-    ///- \ref INF or -\ref INF means either infeasibility or unboundedness
-    /// of the primal problem, depending on whether we minimize or maximize.
-    ///- \ref NaN if no primal solution is found.
-    ///- The (finite) objective value if an optimal solution is found.
-    Value primal() const { return _getPrimalValue()+obj_const_comp;}
     ///@}
 
-  protected:
-
   };
 
 
@@ -1976 +1995 @@
   ///
   /// \brief Common base class for MIP solvers
   ///
-  /// This class is an abstract base class for MIP solvers. This class
+  /// This class is an abstract base class for MIP solvers. It
   /// provides a full interface for set and modify an MIP problem,
   /// solve it and retrieve the solution. You can use one of the
   /// descendants as a concrete implementation, or the \c Lp
@@ -1986 +2005 @@
   class MipSolver : virtual public LpBase {
   public:
 
-    /// The problem types for MIP problems
+    /// \brief The problem types for MIP problems
+    ///
+    /// The problem types for MIP problems.
     enum ProblemType {
       /// = 0. Feasible solution hasn't been found (but may exist).
       UNDEFINED = 0,
@@ -2010 +2031 @@
 
     ///@{
 
-    /// Solve the MIP problem at hand
+    ///\brief Solve the specified MIP problem
     ///
+    ///This function solves the specified MIP problem.
     ///\return The result of the optimization procedure. Possible
     ///values and their meanings can be found in the documentation of
     ///\ref SolveExitStatus.
@@ -2022 +2044 @@
     ///\name Set Column Type
     ///@{
 
-    ///Possible variable (column) types (e.g. real, integer, binary etc.)
-    enum ColTypes {
+    /// The column types for MIP problems.
+
+    /// The column (variable) types for MIP problems.
+    ///
+    enum ColType {
       /// = 0. Continuous variable (default).
       REAL = 0,
       /// = 1. Integer variable.
       INTEGER = 1
     };
 
+    /// \brief The column types for MIP problems. It is an obsolete alias for
+    /// \ref ColType.
+    typedef ColType ColTypes;
+
     ///Sets the type of the given column to the given type
 
-    ///Sets the type of the given column to the given type.
+    ///This function sets the type of the given column to the given type.
     ///
     void colType(Col c, ColTypes col_type) {
       _setColType(cols(id(c)),col_type);
@@ -2040 +2069 @@
 
     ///Gives back the type of the column.
 
-    ///Gives back the type of the column.
+    ///This function gives back the type of the column.
     ///
     ColTypes colType(Col c) const {
       return _getColType(cols(id(c)));
@@ -2051 +2080 @@
 
     ///@{
 
-    /// The type of the MIP problem
+    /// Return the type of the MIP problem
+
+    /// This function returns the type of the MIP problem.
+    /// \see ProblemType
     ProblemType type() const {
       return _getType();
     }
 
-    /// Return the value of the row in the solution
+    /// Return the value of the objective function
+    
+    /// This function returns the value of the objective function.
+    /// \return
+    /// - \ref INF or -\ref INF means either infeasibility or unboundedness
+    ///   of the problem, depending on whether we minimize or maximize.
+    /// - \ref NaN if no primal solution is found.
+    /// - The (finite) objective value if an optimal solution is found.
+    Value solValue() const { return _getSolValue()+obj_const_comp;}
 
-    ///  Return the value of the row in the solution.
+    /// Return the value of the objective function
+    
+    /// This function returns value of the objective function.
+    /// It is an alias for \ref solValue().
+    Value sol() const { return _getSolValue()+obj_const_comp;}
+
+    /// Return the value of the column
+
+    /// This function returns the value of the given column in the solution.
     /// \pre The problem is solved.
     Value sol(Col c) const { return _getSol(cols(id(c))); }
 
-    /// Return the value of the expression in the solution
+    /// Return the value of the expression
 
-    /// Return the value of the expression in the solution, i.e. the
-    /// dot product of the solution and the expression.
+    /// This function returns the value of the given expression in the solution,
+    /// i.e. the dot product of the solution and the expression.
     /// \pre The problem is solved.
     Value sol(const Expr& e) const {
       double res = *e;
@@ -2074 +2122 @@
       }
       return res;
     }
-    ///The value of the objective function
-    
-    ///\return
-    ///- \ref INF or -\ref INF means either infeasibility or unboundedness
-    /// of the problem, depending on whether we minimize or maximize.
-    ///- \ref NaN if no primal solution is found.
-    ///- The (finite) objective value if an optimal solution is found.
-    Value solValue() const { return _getSolValue()+obj_const_comp;}
+
     ///@}
 
   protected: