Changeset 1458:7a483c1d38b5 in lemon-0.x for lemon/lp_base.h

Timestamp:

06/09/05 11:49:48 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Not ready, but I commit it for simplicity.

File:

• lemon/lp_base.h (modified) (3 diffs)

lemon/lp_base.h

@@ -109 +109 @@
   public:
 
-    ///\e
+    ///Possible outcomes of an LP solving procedure
     enum SolveExitStatus {
-      ///\e
+      ///This means that the problem has been successfully solved: either
+      ///an optimal solution has been found or infeasibility/unboundedness
+      ///has been proved.
       SOLVED = 0,
-      ///\e
+      ///Any other case (including the case when some user specified limit has been exceeded)
       UNSOLVED = 1
     };
@@ -916 +918 @@
     ///@{
 
-    ///\e
+    ///\e Solve the LP problem at hand
+    ///
+    ///\return The result of the optimization procedure. Possible values and their meanings can be found in the documentation of \ref SolveExitStatus.
+    ///
+    ///\todo Which method is used to solve the problem
     SolveExitStatus solve() { return _solve(); }
     
@@ -925 +931 @@
     ///@{
 
-    ///\e
+    ///\e 
     SolutionStatus primalStatus() {
       return _getPrimalStatus();