Changeset - r1019:234d635ad721
« 1018:35ba72
1021:4980b0 »
gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Doc improvements in HaoOrlin (#398)
0 1 0
default
1 file changed with 21 insertions and 11 deletions:
lemon/hao_orlin.h
21
11
↑ Collapse diff ↑
lemon/hao_orlin.h
Show white space 6 line context
... ... 
@@ -55,4 +55,4 @@
55 55 
  /// 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.
58 58 
  ///
... ... 
@@ -914,2 +914,4 @@
914 914 
    /// \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.
915 917 
    ///
... ... 
@@ -926,2 +928,4 @@
926 928 
    /// \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.
927 931 
    ///
... ... 
@@ -935,4 +939,4 @@
935 939 
    ///
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()
938 942 
    /// and \ref calculateIn().
... ... 
@@ -946,5 +950,5 @@
946 950 
    ///
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.
950 954 
    void run(const Node& s) {
... ... 
@@ -967,3 +971,5 @@
967 971 
    ///
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().
969 975 
    ///
... ... 
@@ -978,5 +984,9 @@
978 984 
    ///
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
982 992 
    /// for the nodes of \f$ X \f$).
0 comments (0 inline)