lemon/lp_base.h
changeset 588 58f70400e139
parent 576 745e182d0139
child 746 e4554cd6b2bf
child 957 2eebc8f7dca5
     1.1 --- a/lemon/lp_base.h	Wed Apr 15 07:05:32 2009 +0100
     1.2 +++ b/lemon/lp_base.h	Wed Apr 15 07:07:25 2009 +0100
     1.3 @@ -52,12 +52,12 @@
     1.4  
     1.5      ///Possible outcomes of an LP solving procedure
     1.6      enum SolveExitStatus {
     1.7 -      ///This means that the problem has been successfully solved: either
     1.8 +      /// = 0. It means that the problem has been successfully solved: either
     1.9        ///an optimal solution has been found or infeasibility/unboundedness
    1.10        ///has been proved.
    1.11        SOLVED = 0,
    1.12 -      ///Any other case (including the case when some user specified
    1.13 -      ///limit has been exceeded)
    1.14 +      /// = 1. Any other case (including the case when some user specified
    1.15 +      ///limit has been exceeded).
    1.16        UNSOLVED = 1
    1.17      };
    1.18  
    1.19 @@ -71,15 +71,15 @@
    1.20  
    1.21      ///Enum for \c messageLevel() parameter
    1.22      enum MessageLevel {
    1.23 -      /// no output (default value)
    1.24 +      /// No output (default value).
    1.25        MESSAGE_NOTHING,
    1.26 -      /// error messages only
    1.27 +      /// Error messages only.
    1.28        MESSAGE_ERROR,
    1.29 -      /// warnings
    1.30 +      /// Warnings.
    1.31        MESSAGE_WARNING,
    1.32 -      /// normal output
    1.33 +      /// Normal output.
    1.34        MESSAGE_NORMAL,
    1.35 -      /// verbose output
    1.36 +      /// Verbose output.
    1.37        MESSAGE_VERBOSE
    1.38      };
    1.39      
    1.40 @@ -1005,7 +1005,7 @@
    1.41      ///Gives back the name of the solver.
    1.42      const char* solverName() const {return _solverName();}
    1.43  
    1.44 -    ///\name Build up and modify the LP
    1.45 +    ///\name Build Up and Modify the LP
    1.46  
    1.47      ///@{
    1.48  
    1.49 @@ -1788,15 +1788,15 @@
    1.50  
    1.51      /// The problem types for primal and dual problems
    1.52      enum ProblemType {
    1.53 -      ///Feasible solution hasn't been found (but may exist).
    1.54 +      /// = 0. Feasible solution hasn't been found (but may exist).
    1.55        UNDEFINED = 0,
    1.56 -      ///The problem has no feasible solution
    1.57 +      /// = 1. The problem has no feasible solution.
    1.58        INFEASIBLE = 1,
    1.59 -      ///Feasible solution found
    1.60 +      /// = 2. Feasible solution found.
    1.61        FEASIBLE = 2,
    1.62 -      ///Optimal solution exists and found
    1.63 +      /// = 3. Optimal solution exists and found.
    1.64        OPTIMAL = 3,
    1.65 -      ///The cost function is unbounded
    1.66 +      /// = 4. The cost function is unbounded.
    1.67        UNBOUNDED = 4
    1.68      };
    1.69  
    1.70 @@ -1852,7 +1852,7 @@
    1.71  
    1.72      ///@}
    1.73  
    1.74 -    ///\name Obtain the solution
    1.75 +    ///\name Obtain the Solution
    1.76  
    1.77      ///@{
    1.78  
    1.79 @@ -1974,17 +1974,16 @@
    1.80  
    1.81      /// The problem types for MIP problems
    1.82      enum ProblemType {
    1.83 -      ///Feasible solution hasn't been found (but may exist).
    1.84 +      /// = 0. Feasible solution hasn't been found (but may exist).
    1.85        UNDEFINED = 0,
    1.86 -      ///The problem has no feasible solution
    1.87 +      /// = 1. The problem has no feasible solution.
    1.88        INFEASIBLE = 1,
    1.89 -      ///Feasible solution found
    1.90 +      /// = 2. Feasible solution found.
    1.91        FEASIBLE = 2,
    1.92 -      ///Optimal solution exists and found
    1.93 +      /// = 3. Optimal solution exists and found.
    1.94        OPTIMAL = 3,
    1.95 -      ///The cost function is unbounded
    1.96 -      ///
    1.97 -      ///The Mip or at least the relaxed problem is unbounded
    1.98 +      /// = 4. The cost function is unbounded.
    1.99 +      ///The Mip or at least the relaxed problem is unbounded.
   1.100        UNBOUNDED = 4
   1.101      };
   1.102  
   1.103 @@ -2006,14 +2005,14 @@
   1.104  
   1.105      ///@}
   1.106  
   1.107 -    ///\name Setting column type
   1.108 +    ///\name Set Column Type
   1.109      ///@{
   1.110  
   1.111      ///Possible variable (column) types (e.g. real, integer, binary etc.)
   1.112      enum ColTypes {
   1.113 -      ///Continuous variable (default)
   1.114 +      /// = 0. Continuous variable (default).
   1.115        REAL = 0,
   1.116 -      ///Integer variable
   1.117 +      /// = 1. Integer variable.
   1.118        INTEGER = 1
   1.119      };
   1.120  
   1.121 @@ -2034,7 +2033,7 @@
   1.122      }
   1.123      ///@}
   1.124  
   1.125 -    ///\name Obtain the solution
   1.126 +    ///\name Obtain the Solution
   1.127  
   1.128      ///@{
   1.129