Changeset 1527:7ceab500e1f6 in lemon-0.x for lemon/suurballe.h

Timestamp:

07/01/05 12:33:27 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Doc review+corrections in my own documentation according to the reviewers comments.

File:

• lemon/suurballe.h (modified) (6 diffs)

lemon/suurballe.h

@@ -40 +40 @@
   /// edge-weighted directed graph having minimal total weight (length).
   ///
-  ///\warning Length values should be nonnegative.
+  ///\warning Length values should be nonnegative!
   /// 
   ///\param Graph The directed graph type the algorithm runs on.
@@ -122 +122 @@
       
       paths.clear();
-      //total_length=0;
       paths.resize(k);
       for (int j=0; j<i; ++j){
@@ -136 +135 @@
           n = G.target(e);
           paths[j].push_back(e);
-          //total_length += length[e];
           reversed[e] = 1-reversed[e];
         }
@@ -167 +165 @@
     ///This function checks, whether the given solution is optimal.
     ///Currently this function only checks optimality,
-    ///doesn't bother with feasibility
+    ///doesn't bother with feasibility.
     ///It is meant for testing purposes.
     bool checkComplementarySlackness(){
@@ -176 +174 @@
     
     ///This function gives back the \c j-th path in argument p.
-    ///Assumes that \c run() has been run and nothing changed since then.
+    ///Assumes that \c run() has been run and nothing has changed since then.
     /// \warning It is assumed that \c p is constructed to
     ///be a path of graph \c G.
@@ -183 +181 @@
     ///
     ///\param Path The type of the path structure to put the result to (must meet lemon path concept).
-    ///\param p The path to put the result to 
-    ///\param j Which path you want to get from the found paths (in a real application you would get the found paths iteratively)
+    ///\param p The path to put the result to.
+    ///\param j Which path you want to get from the found paths (in a real application you would get the found paths iteratively).
     template<typename Path>
     void getPath(Path& p, size_t j){