Changeset 2620:8f41a3129746 in lemon-0.x for lemon/capacity_scaling.h

Timestamp:

10/05/08 15:37:17 (16 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3505

Message:

Doc improvements

File:

• lemon/capacity_scaling.h (modified) (15 diffs)

lemon/capacity_scaling.h

@@ -53 +53 @@
   ///
   /// \author Peter Kovacs
-
   template < typename Graph,
              typename LowerMap = typename Graph::template EdgeMap<int>,
@@ -126 +125 @@
       {}
 
-      /// Runs the algorithm from the given source node.
+      /// Run the algorithm from the given source node.
       Node run(Node s, Capacity delta = 1) {
         HeapCrossRef heap_cross_ref(_graph, Heap::PRE_HEAP);
@@ -372 +371 @@
     }
 
-    /// \brief Sets the flow map.
-    ///
-    /// Sets the flow map.
+    /// \brief Set the flow map.
+    ///
+    /// Set the flow map.
     ///
     /// \return \c (*this)
@@ -386 +385 @@
     }
 
-    /// \brief Sets the potential map.
-    ///
-    /// Sets the potential map.
+    /// \brief Set the potential map.
+    ///
+    /// Set the potential map.
     ///
     /// \return \c (*this)
@@ -401 +400 @@
 
     /// \name Execution control
-    /// The only way to execute the algorithm is to call the run()
-    /// function.
 
     /// @{
 
-    /// \brief Runs the algorithm.
-    ///
-    /// Runs the algorithm.
+    /// \brief Run the algorithm.
+    ///
+    /// This function runs the algorithm.
     ///
     /// \param scaling Enable or disable capacity scaling.
@@ -423 +420 @@
 
     /// \name Query Functions
-    /// The result of the algorithm can be obtained using these
-    /// functions.
-    /// \n run() must be called before using them.
+    /// The results of the algorithm can be obtained using these
+    /// functions.\n
+    /// \ref lemon::CapacityScaling::run() "run()" must be called before
+    /// using them.
 
     /// @{
 
-    /// \brief Returns a const reference to the edge map storing the
+    /// \brief Return a const reference to the edge map storing the
     /// found flow.
     ///
-    /// Returns a const reference to the edge map storing the found flow.
+    /// Return a const reference to the edge map storing the found flow.
     ///
     /// \pre \ref run() must be called before using this function.
@@ -439 +437 @@
     }
 
-    /// \brief Returns a const reference to the node map storing the
+    /// \brief Return a const reference to the node map storing the
     /// found potentials (the dual solution).
     ///
-    /// Returns a const reference to the node map storing the found
+    /// Return a const reference to the node map storing the found
     /// potentials (the dual solution).
     ///
@@ -450 +448 @@
     }
 
-    /// \brief Returns the flow on the given edge.
-    ///
-    /// Returns the flow on the given edge.
+    /// \brief Return the flow on the given edge.
+    ///
+    /// Return the flow on the given edge.
     ///
     /// \pre \ref run() must be called before using this function.
@@ -459 +457 @@
     }
 
-    /// \brief Returns the potential of the given node.
-    ///
-    /// Returns the potential of the given node.
+    /// \brief Return the potential of the given node.
+    ///
+    /// Return the potential of the given node.
     ///
     /// \pre \ref run() must be called before using this function.
@@ -468 +466 @@
     }
 
-    /// \brief Returns the total cost of the found flow.
-    ///
-    /// Returns the total cost of the found flow. The complexity of the
+    /// \brief Return the total cost of the found flow.
+    ///
+    /// Return the total cost of the found flow. The complexity of the
     /// function is \f$ O(e) \f$.
     ///
@@ -485 +483 @@
   private:
 
-    /// Initializes the algorithm.
+    /// Initialize the algorithm.
     bool init(bool scaling) {
       if (!_valid_supply) return false;
@@ -536 +534 @@
     }
 
-    /// Executes the capacity scaling algorithm.
+    /// Execute the capacity scaling algorithm.
     bool startWithScaling() {
       // Processing capacity scaling phases
@@ -568 +566 @@
           if (_excess[n] <= -_delta) _deficit_nodes.push_back(n);
         }
-        int next_node = 0;
+        int next_node = 0, next_def_node = 0;
 
         // Finding augmenting shortest paths
@@ -575 +573 @@
           if (_delta > 1) {
             bool delta_deficit = false;
-            for (int i = 0; i < int(_deficit_nodes.size()); ++i) {
-              if (_excess[_deficit_nodes[i]] <= -_delta) {
+            for ( ; next_def_node < int(_deficit_nodes.size());
+                    ++next_def_node ) {
+              if (_excess[_deficit_nodes[next_def_node]] <= -_delta) {
                 delta_deficit = true;
                 break;
@@ -642 +641 @@
     }
 
-    /// Executes the successive shortest path algorithm.
+    /// Execute the successive shortest path algorithm.
     bool startWithoutScaling() {
       // Finding excess nodes