[Lemon-commits] [lemon_svn] alpar: r2473 - hugo/trunk/lemon

[Lemon SVN]

Author: alpar
Date: Wed Jan 18 10:42:08 2006
New Revision: 2473

Modified:
   hugo/trunk/lemon/preflow.h

Log:
- tolerance() added. 
- better doc.

Modified: hugo/trunk/lemon/preflow.h
==============================================================================
--- hugo/trunk/lemon/preflow.h	(original)
+++ hugo/trunk/lemon/preflow.h	Wed Jan 18 10:42:08 2006
@@ -108,36 +108,34 @@
     ///Indicates the property of the starting flow map.
     
     ///Indicates the property of the starting flow map.
-    ///The meanings are as follows:
-    ///- \c ZERO_FLOW: constant zero flow
-    ///- \c GEN_FLOW: any flow, i.e. the sum of the in-flows equals to
-    ///the sum of the out-flows in every node except the \e source and
-    ///the \e target.
-    ///- \c PRE_FLOW: any preflow, i.e. the sum of the in-flows is at 
-    ///least the sum of the out-flows in every node except the \e source.
-    ///- \c NO_FLOW: indicates an unspecified edge map. \c flow will be 
-    ///set to the constant zero flow in the beginning of
-    ///the algorithm in this case.
     ///
     enum FlowEnum{
+      ///indicates an unspecified edge map. \c flow will be 
+      ///set to the constant zero flow in the beginning of
+      ///the algorithm in this case.
       NO_FLOW,
+      ///constant zero flow
       ZERO_FLOW,
+      ///any flow, i.e. the sum of the in-flows equals to
+      ///the sum of the out-flows in every node except the \c source and
+      ///the \c target.
       GEN_FLOW,
+      ///any preflow, i.e. the sum of the in-flows is at 
+      ///least the sum of the out-flows in every node except the \c source.
       PRE_FLOW
     };
 
     ///Indicates the state of the preflow algorithm.
 
     ///Indicates the state of the preflow algorithm.
-    ///The meanings are as follows:
-    ///- \c AFTER_NOTHING: before running the algorithm or
-    ///  at an unspecified state.
-    ///- \c AFTER_PREFLOW_PHASE_1: right after running \c phase1
-    ///- \c AFTER_PREFLOW_PHASE_2: after running \ref phase2()
     ///
     enum StatusEnum {
+      ///before running the algorithm or
+      ///at an unspecified state.
       AFTER_NOTHING,
+      ///right after running \ref phase1()
       AFTER_PREFLOW_PHASE_1,      
+      ///after running \ref phase2()
       AFTER_PREFLOW_PHASE_2
     };
     
@@ -168,8 +166,12 @@
 	  throw InvalidArgument();
       }
     
+    ///Give a reference to the tolerance handler class
+
+    ///Give a reference to the tolerance handler class
+    ///\sa Tolerance
+    TOL &tolerance() { return surely; }
 
-                                                                              
     ///Runs the preflow algorithm.  
 
     ///Runs the preflow algorithm.