1.1 --- a/src/hugo/preflow.h Mon Sep 27 18:11:27 2004 +0000
1.2 +++ b/src/hugo/preflow.h Tue Sep 28 07:00:58 2004 +0000
1.3 @@ -44,7 +44,8 @@
1.4 ///functions \ref setSource, \ref setTarget, \ref setCap and \ref
1.5 ///setFlow.
1.6 ///
1.7 - ///After running \ref phase1() or \ref preflow(), the actual flow
1.8 + ///After running \ref hugo::Preflow::phase1() "phase1()"
1.9 + ///or \ref hugo::Preflow::run() "run()", the actual flow
1.10 ///value can be obtained by calling \ref flowValue(). The minimum
1.11 ///value cut can be written into a <tt>bool</tt> node map by
1.12 ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
1.13 @@ -96,8 +97,9 @@
1.14 ///the \e target.
1.15 ///- \c PRE_FLOW: any preflow, i.e. the sum of the in-flows is at
1.16 ///least the sum of the out-flows in every node except the \e source.
1.17 - ///- \c NO_FLOW: indicates an unspecified edge map. \ref flow will be
1.18 - ///set to the constant zero flow in the beginning of the algorithm in this case.
1.19 + ///- \c NO_FLOW: indicates an unspecified edge map. \c flow will be
1.20 + ///set to the constant zero flow in the beginning of
1.21 + ///the algorithm in this case.
1.22 ///
1.23 enum FlowEnum{
1.24 NO_FLOW,
1.25 @@ -194,9 +196,9 @@
1.26 ///first phase. After the first phase the maximum flow value and a
1.27 ///minimum value cut can already be computed, though a maximum flow
1.28 ///is not yet obtained. So after calling this method \ref flowValue
1.29 - ///and \ref actMinCut gives proper results.
1.30 - ///\warning \ref minCut, \ref minMinCut and \ref maxMinCut do not
1.31 - ///give minimum value cuts unless calling \ref phase2.
1.32 + ///and \ref MinCut() gives proper results.
1.33 + ///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
1.34 + ///give minimum value cuts unless calling \ref phase2().
1.35 void phase1()
1.36 {
1.37 int heur0=(int)(H0*n); //time while running 'bound decrease'
1.38 @@ -349,7 +351,7 @@
1.39 /// Returns the value of the maximum flow.
1.40
1.41 /// Returns the value of the maximum flow by returning the excess
1.42 - /// of the target node \ref t. This value equals to the value of
1.43 + /// of the target node \c t. This value equals to the value of
1.44 /// the maximum flow already after running \ref phase1.
1.45 Num flowValue() const {
1.46 return excess[t];
1.47 @@ -362,7 +364,7 @@
1.48 ///cut. This method can be called both after running \ref
1.49 ///phase1 and \ref phase2. It is much faster after
1.50 ///\ref phase1. \pre M should be a bool-valued node-map. \pre
1.51 - ///If \ref mincut is called after \ref phase2 then M should
1.52 + ///If \ref minCut() is called after \ref phase2() then M should
1.53 ///be initialized to false.
1.54 template<typename _CutMap>
1.55 void minCut(_CutMap& M) const {
1.56 @@ -425,7 +427,7 @@
1.57 ///Sets \c M to the characteristic vector of the minimum value cut
1.58 ///which is inclusionwise maximum. It is computed by processing a
1.59 ///backward bfs from the target node \c t in the residual graph.
1.60 - ///\pre \ref phase2() or preflow() should already be run.
1.61 + ///\pre \ref phase2() or run() should already be run.
1.62 template<typename _CutMap>
1.63 void maxMinCut(_CutMap& M) const {
1.64