Small improvement in documentation.
authorkpeter
Sun, 16 Sep 2007 14:21:12 +0000
changeset 24739ffff9051a4b
parent 2472 fb60f631790b
child 2474 e6368948d5f7
Small improvement in documentation.
lemon/preflow.h
     1.1 --- a/lemon/preflow.h	Sun Sep 16 13:29:42 2007 +0000
     1.2 +++ b/lemon/preflow.h	Sun Sep 16 14:21:12 2007 +0000
     1.3 @@ -210,6 +210,8 @@
     1.4      ///minCut returns a minimum cut.     
     1.5      ///\warning \ref minMinCut and \ref maxMinCut do not give minimum
     1.6      ///value cuts unless calling \ref phase2.  
     1.7 +    ///\warning A real flow map (i.e. not \ref lemon::NullMap "NullMap")
     1.8 +    ///is needed for this phase.
     1.9      ///\pre The starting flow must be 
    1.10      ///- a constant zero flow if \c fp is \c ZERO_FLOW, 
    1.11      ///- an arbitary flow if \c fp is \c GEN_FLOW, 
    1.12 @@ -232,6 +234,8 @@
    1.13      ///minCut returns a minimum cut.
    1.14      ///\warning \ref minMinCut() and \ref maxMinCut() do not
    1.15      ///give minimum value cuts unless calling \ref phase2().
    1.16 +    ///\warning A real flow map (i.e. not \ref lemon::NullMap "NullMap")
    1.17 +    ///is needed for this phase.
    1.18      void phase1()
    1.19      {
    1.20        int heur0=int(H0*_node_num);  //time while running 'bound decrease'