lemon/lp_base.h
changeset 1458 7a483c1d38b5
parent 1445 4635352e5524
child 1460 7c58aabb9eea
     1.1 --- a/lemon/lp_base.h	Thu Jun 09 09:47:51 2005 +0000
     1.2 +++ b/lemon/lp_base.h	Thu Jun 09 09:49:48 2005 +0000
     1.3 @@ -108,11 +108,13 @@
     1.4  
     1.5    public:
     1.6  
     1.7 -    ///\e
     1.8 +    ///Possible outcomes of an LP solving procedure
     1.9      enum SolveExitStatus {
    1.10 -      ///\e
    1.11 +      ///This means that the problem has been successfully solved: either
    1.12 +      ///an optimal solution has been found or infeasibility/unboundedness
    1.13 +      ///has been proved.
    1.14        SOLVED = 0,
    1.15 -      ///\e
    1.16 +      ///Any other case (including the case when some user specified limit has been exceeded)
    1.17        UNSOLVED = 1
    1.18      };
    1.19        
    1.20 @@ -915,7 +917,11 @@
    1.21  
    1.22      ///@{
    1.23  
    1.24 -    ///\e
    1.25 +    ///\e Solve the LP problem at hand
    1.26 +    ///
    1.27 +    ///\return The result of the optimization procedure. Possible values and their meanings can be found in the documentation of \ref SolveExitStatus.
    1.28 +    ///
    1.29 +    ///\todo Which method is used to solve the problem
    1.30      SolveExitStatus solve() { return _solve(); }
    1.31      
    1.32      ///@}
    1.33 @@ -924,7 +930,7 @@
    1.34  
    1.35      ///@{
    1.36  
    1.37 -    ///\e
    1.38 +    ///\e 
    1.39      SolutionStatus primalStatus() {
    1.40        return _getPrimalStatus();
    1.41      }