COIN-OR::LEMON - Graph Library

Changeset 487:11ad69691d18 in lemon-0.x


Ignore:
Timestamp:
04/29/04 21:25:52 (16 years ago)
Author:
marci
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@645
Message:

some documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/work/jacint/max_flow.h

    r485 r487  
    8888  public:
    8989 
     90    ///\todo Document this
    9091    enum flowEnum{
    9192      ZERO_FLOW=0,
     
    105106    }
    106107   
    107     /// A preflow algorithm is run. The initial edge-set have to be a flow,
    108     /// or from a preflow, according to \c fe.
     108    /// A preflow algorithm is run.
     109    ///\pre The initial edge-map have to be a
     110    /// zero flow if \c fe is \c ZERO_FLOW,
     111    /// a flow if \c fe is \c GEN_FLOW,
     112    /// and a pre-flow it is \c PREFLOW.
    109113    void preflow( flowEnum fe ) {
    110114      preflowPhase0(fe);
     
    122126    /// according to the Edmonds-Karp algorithm
    123127    /// and augments the flow on if any.
     128    /// The return value shows if the augmentation was succesful.
    124129    bool augmentOnShortestPath();
    125130
     
    128133    /// The blocking flow is computed in a physically constructed
    129134    /// residual graph of type \c Mutablegraph.
     135    /// The return value show sif the augmentation was succesful.
    130136    template<typename MutableGraph> bool augmentOnBlockingFlow();
    131137
    132138    /// The same as \c augmentOnBlockingFlow<MutableGraph> but the
    133139    /// residual graph is not constructed physically.
     140    /// The return value shows if the augmentation was succesful.
    134141    bool augmentOnBlockingFlow2();
    135142
     
    160167    }
    161168
    162 
    163169    /// The unique inclusionwise minimum cut is computed by
    164170    /// processing a bfs from s in the residual graph.
     
    243249    void minCut(CutMap& M) { minMinCut(M); }
    244250
    245     ///
    246     void resetSource(Node _s) {s=_s;}
    247251    ///
    248     void resetTarget(Node _t) {t=_t;}
     252    void resetSource(Node _s) { s=_s; }
     253    ///
     254    void resetTarget(Node _t) { t=_t; }
    249255   
    250256    /// capacity-map is changed.
Note: See TracChangeset for help on using the changeset viewer.