# Changeset 1019:234d635ad721 in lemon for lemon

Ignore:
Timestamp:
11/15/10 08:45:12 (12 years ago)
Branch:
default
Phase:
public
Message:

Doc improvements in HaoOrlin? (#398)

File:
1 edited

### Legend:

Unmodified
 r956 /// preflow push-relabel algorithm. Our implementation calculates /// the minimum cut in \f$O(n^2\sqrt{m}) \f$ time (we use the /// highest-label rule), or in \f$O(nm)\f$ for unit capacities. The /// purpose of such algorithm is e.g. testing network reliability. /// highest-label rule), or in \f$O(nm)\f$ for unit capacities. A notable /// use of this algorithm is testing network reliability. /// /// For an undirected graph you can run just the first phase of the /// source-side (i.e. a set \f$X\subsetneq V \f$ with /// \f$source \in X \f$ and minimal outgoing capacity). /// It updates the stored cut if (and only if) the newly found one /// is better. /// /// \pre \ref init() must be called before using this function. /// sink-side (i.e. a set \f$X\subsetneq V \f$ with /// \f$source \notin X \f$ and minimal outgoing capacity). /// It updates the stored cut if (and only if) the newly found one /// is better. /// /// \pre \ref init() must be called before using this function. /// \brief Run the algorithm. /// /// This function runs the algorithm. It finds nodes \c source and /// \c target arbitrarily and then calls \ref init(), \ref calculateOut() /// This function runs the algorithm. It chooses source node, /// then calls \ref init(), \ref calculateOut() /// and \ref calculateIn(). void run() { /// \brief Run the algorithm. /// /// This function runs the algorithm. It uses the given \c source node, /// finds a proper \c target node and then calls the \ref init(), /// \ref calculateOut() and \ref calculateIn(). /// This function runs the algorithm. It calls \ref init(), /// \ref calculateOut() and \ref calculateIn() with the given /// source node. void run(const Node& s) { init(s); /// \brief Return the value of the minimum cut. /// /// This function returns the value of the minimum cut. /// This function returns the value of the best cut found by the /// previously called \ref run(), \ref calculateOut() or \ref /// calculateIn(). /// /// \pre \ref run(), \ref calculateOut() or \ref calculateIn() /// \brief Return a minimum cut. /// /// This function sets \c cutMap to the characteristic vector of a /// minimum value cut: it will give a non-empty set \f$X\subsetneq V \f$ /// with minimal outgoing capacity (i.e. \c cutMap will be \c true exactly /// This function gives the best cut found by the /// previously called \ref run(), \ref calculateOut() or \ref /// calculateIn(). /// /// It sets \c cutMap to the characteristic vector of the found /// minimum value cut - a non-empty set \f$X\subsetneq V \f$ /// of minimum outgoing capacity (i.e. \c cutMap will be \c true exactly /// for the nodes of \f$X \f$). ///