Changeset 487:11ad69691d18 in lemon-0.x for src/work

Timestamp:

04/29/04 21:25:52 (20 years ago)

Author:

marci

Branch:

default

Phase:

public

Convert:

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

Message:

some documentation

File:

• src/work/jacint/max_flow.h (modified) (6 diffs)

src/work/jacint/max_flow.h

@@ -88 +88 @@
   public:
  
+    ///\todo Document this
     enum flowEnum{
       ZERO_FLOW=0,
@@ -105 +106 @@
     }
     
-    /// A preflow algorithm is run. The initial edge-set have to be a flow, 
-    /// or from a preflow, according to \c fe.
+    /// A preflow algorithm is run. 
+    ///\pre The initial edge-map have to be a 
+    /// zero flow if \c fe is \c ZERO_FLOW,
+    /// a flow if \c fe is \c GEN_FLOW, 
+    /// and a pre-flow it is \c PREFLOW.
     void preflow( flowEnum fe ) {
       preflowPhase0(fe);
@@ -122 +126 @@
     /// according to the Edmonds-Karp algorithm 
     /// and augments the flow on if any. 
+    /// The return value shows if the augmentation was succesful.
     bool augmentOnShortestPath();
 
@@ -128 +133 @@
     /// The blocking flow is computed in a physically constructed 
     /// residual graph of type \c Mutablegraph.
+    /// The return value show sif the augmentation was succesful.
     template<typename MutableGraph> bool augmentOnBlockingFlow();
 
     /// The same as \c augmentOnBlockingFlow<MutableGraph> but the 
     /// residual graph is not constructed physically.
+    /// The return value shows if the augmentation was succesful.
     bool augmentOnBlockingFlow2();
 
@@ -160 +167 @@
     }
 
-
     /// The unique inclusionwise minimum cut is computed by 
     /// processing a bfs from s in the residual graph.
@@ -243 +249 @@
     void minCut(CutMap& M) { minMinCut(M); }
 
-    /// 
-    void resetSource(Node _s) {s=_s;}
     ///
-    void resetTarget(Node _t) {t=_t;}
+    void resetSource(Node _s) { s=_s; }
+    ///
+    void resetTarget(Node _t) { t=_t; }
    
     /// capacity-map is changed.