COIN-OR::LEMON - Graph Library

Changeset 1019:234d635ad721 in lemon


Ignore:
Timestamp:
11/15/10 08:45:12 (8 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Message:

Doc improvements in HaoOrlin? (#398)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/hao_orlin.h

    r956 r1019  
    5454  /// preflow push-relabel algorithm. Our implementation calculates 
    5555  /// the minimum cut in \f$ O(n^2\sqrt{m}) \f$ time (we use the 
    56   /// highest-label rule), or in \f$O(nm)\f$ for unit capacities. The 
    57   /// purpose of such algorithm is e.g. testing network reliability. 
     56  /// highest-label rule), or in \f$O(nm)\f$ for unit capacities. A notable 
     57  /// use of this algorithm is testing network reliability. 
    5858  /// 
    5959  /// For an undirected graph you can run just the first phase of the 
     
    913913    /// source-side (i.e. a set \f$ X\subsetneq V \f$ with 
    914914    /// \f$ source \in X \f$ and minimal outgoing capacity). 
     915    /// It updates the stored cut if (and only if) the newly found one 
     916    /// is better. 
    915917    /// 
    916918    /// \pre \ref init() must be called before using this function. 
     
    925927    /// sink-side (i.e. a set \f$ X\subsetneq V \f$ with 
    926928    /// \f$ source \notin X \f$ and minimal outgoing capacity). 
     929    /// It updates the stored cut if (and only if) the newly found one 
     930    /// is better. 
    927931    /// 
    928932    /// \pre \ref init() must be called before using this function. 
     
    934938    /// \brief Run the algorithm. 
    935939    /// 
    936     /// This function runs the algorithm. It finds nodes \c source and 
    937     /// \c target arbitrarily and then calls \ref init(), \ref calculateOut() 
     940    /// This function runs the algorithm. It chooses source node, 
     941    /// then calls \ref init(), \ref calculateOut() 
    938942    /// and \ref calculateIn(). 
    939943    void run() { 
     
    945949    /// \brief Run the algorithm. 
    946950    /// 
    947     /// This function runs the algorithm. It uses the given \c source node, 
    948     /// finds a proper \c target node and then calls the \ref init(), 
    949     /// \ref calculateOut() and \ref calculateIn(). 
     951    /// This function runs the algorithm. It calls \ref init(), 
     952    /// \ref calculateOut() and \ref calculateIn() with the given 
     953    /// source node. 
    950954    void run(const Node& s) { 
    951955      init(s); 
     
    966970    /// \brief Return the value of the minimum cut. 
    967971    /// 
    968     /// This function returns the value of the minimum cut. 
     972    /// This function returns the value of the best cut found by the 
     973    /// previously called \ref run(), \ref calculateOut() or \ref 
     974    /// calculateIn(). 
    969975    /// 
    970976    /// \pre \ref run(), \ref calculateOut() or \ref calculateIn() 
     
    977983    /// \brief Return a minimum cut. 
    978984    /// 
    979     /// This function sets \c cutMap to the characteristic vector of a 
    980     /// minimum value cut: it will give a non-empty set \f$ X\subsetneq V \f$ 
    981     /// with minimal outgoing capacity (i.e. \c cutMap will be \c true exactly 
     985    /// This function gives the best cut found by the 
     986    /// previously called \ref run(), \ref calculateOut() or \ref 
     987    /// calculateIn(). 
     988    /// 
     989    /// It sets \c cutMap to the characteristic vector of the found 
     990    /// minimum value cut - a non-empty set \f$ X\subsetneq V \f$ 
     991    /// of minimum outgoing capacity (i.e. \c cutMap will be \c true exactly 
    982992    /// for the nodes of \f$ X \f$). 
    983993    /// 
Note: See TracChangeset for help on using the changeset viewer.