- tolerance() added.
authoralpar
Wed, 18 Jan 2006 09:42:08 +0000
changeset 1898f030c01e6173
parent 1897 dd90f57b01d1
child 1899 2d4835f5a86a
- tolerance() added.
- better doc.
lemon/preflow.h
     1.1 --- a/lemon/preflow.h	Wed Jan 18 09:40:53 2006 +0000
     1.2 +++ b/lemon/preflow.h	Wed Jan 18 09:42:08 2006 +0000
     1.3 @@ -108,36 +108,34 @@
     1.4      ///Indicates the property of the starting flow map.
     1.5      
     1.6      ///Indicates the property of the starting flow map.
     1.7 -    ///The meanings are as follows:
     1.8 -    ///- \c ZERO_FLOW: constant zero flow
     1.9 -    ///- \c GEN_FLOW: any flow, i.e. the sum of the in-flows equals to
    1.10 -    ///the sum of the out-flows in every node except the \e source and
    1.11 -    ///the \e target.
    1.12 -    ///- \c PRE_FLOW: any preflow, i.e. the sum of the in-flows is at 
    1.13 -    ///least the sum of the out-flows in every node except the \e source.
    1.14 -    ///- \c NO_FLOW: indicates an unspecified edge map. \c flow will be 
    1.15 -    ///set to the constant zero flow in the beginning of
    1.16 -    ///the algorithm in this case.
    1.17      ///
    1.18      enum FlowEnum{
    1.19 +      ///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        NO_FLOW,
    1.23 +      ///constant zero flow
    1.24        ZERO_FLOW,
    1.25 +      ///any flow, i.e. the sum of the in-flows equals to
    1.26 +      ///the sum of the out-flows in every node except the \c source and
    1.27 +      ///the \c target.
    1.28        GEN_FLOW,
    1.29 +      ///any preflow, i.e. the sum of the in-flows is at 
    1.30 +      ///least the sum of the out-flows in every node except the \c source.
    1.31        PRE_FLOW
    1.32      };
    1.33  
    1.34      ///Indicates the state of the preflow algorithm.
    1.35  
    1.36      ///Indicates the state of the preflow algorithm.
    1.37 -    ///The meanings are as follows:
    1.38 -    ///- \c AFTER_NOTHING: before running the algorithm or
    1.39 -    ///  at an unspecified state.
    1.40 -    ///- \c AFTER_PREFLOW_PHASE_1: right after running \c phase1
    1.41 -    ///- \c AFTER_PREFLOW_PHASE_2: after running \ref phase2()
    1.42      ///
    1.43      enum StatusEnum {
    1.44 +      ///before running the algorithm or
    1.45 +      ///at an unspecified state.
    1.46        AFTER_NOTHING,
    1.47 +      ///right after running \ref phase1()
    1.48        AFTER_PREFLOW_PHASE_1,      
    1.49 +      ///after running \ref phase2()
    1.50        AFTER_PREFLOW_PHASE_2
    1.51      };
    1.52      
    1.53 @@ -168,8 +166,12 @@
    1.54  	  throw InvalidArgument();
    1.55        }
    1.56      
    1.57 +    ///Give a reference to the tolerance handler class
    1.58  
    1.59 -                                                                              
    1.60 +    ///Give a reference to the tolerance handler class
    1.61 +    ///\sa Tolerance
    1.62 +    TOL &tolerance() { return surely; }
    1.63 +
    1.64      ///Runs the preflow algorithm.  
    1.65  
    1.66      ///Runs the preflow algorithm.