diff -r 54d3c1599d08 -r 209c9d53e195 src/hugo/preflow.h --- a/src/hugo/preflow.h Tue Sep 14 10:23:26 2004 +0000 +++ b/src/hugo/preflow.h Tue Sep 14 10:29:47 2004 +0000 @@ -16,22 +16,22 @@ /// \addtogroup flowalgs /// @{ - ///Preflow algorithms class. + ///%Preflow algorithms class. ///This class provides an implementation of the \e preflow \e ///algorithm producing a flow of maximum value in a directed ///graph. The preflow algorithms are the fastest max flow algorithms - ///up-to-date. The \e source node, the \e target node, the \e + ///up to now. The \e source node, the \e target node, the \e ///capacity of the edges and the \e starting \e flow value of the ///edges should be passed to the algorithm through the ///constructor. It is possible to change these quantities using the ///functions \ref setSource, \ref setTarget, \ref setCap and \ref ///setFlow. /// - ///After running \c phase1 or \c preflow, the actual flow + ///After running \ref phase1() or \ref preflow(), the actual flow ///value can be obtained by calling \ref flowValue(). The minimum - ///value cut can be written into a \c node map of \c bools by - ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes + ///value cut can be written into a bool node map by + ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes ///the inclusionwise minimum and maximum of the minimum value cuts, ///resp.) /// @@ -129,7 +129,8 @@ ///Runs the preflow algorithm. - ///Runs the preflow algorithm. + ///Runs the preflow algorithm. + /// void run() { phase1(flow_prop); phase2(); @@ -157,7 +158,7 @@ ///minimum value cut can already be computed, though a maximum flow ///is not yet obtained. So after calling this method \ref flowValue ///and \ref minCut gives proper results. - ///\warning: \ref minMinCut and \ref maxMinCut do not + ///\warning \ref minMinCut and \ref maxMinCut do not ///give minimum value cuts unless calling \ref phase2. ///\pre The starting flow must be /// - a constant zero flow if \c fp is \c ZERO_FLOW, @@ -178,7 +179,7 @@ ///minimum value cut can already be computed, though a maximum flow ///is not yet obtained. So after calling this method \ref flowValue ///and \ref actMinCut gives proper results. - ///\warning: \ref minCut, \ref minMinCut and \ref maxMinCut do not + ///\warning \ref minCut, \ref minMinCut and \ref maxMinCut do not ///give minimum value cuts unless calling \ref phase2. void phase1() {