Changeset 851:209c9d53e195 in lemon-0.x for src/hugo/minlengthpaths.h

Timestamp:

09/14/04 12:29:47 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Changes in doc.

File:

• src/hugo/minlengthpaths.h (modified) (3 diffs)

src/hugo/minlengthpaths.h

@@ -67 +67 @@
     ///Runs the algorithm.
     ///Returns k if there are at least k edge-disjoint paths from s to t.
-   ///Otherwise it returns the number of found edge-disjoint paths from s to t.
+    ///Otherwise it returns the number of found edge-disjoint paths from s to t.
     int run(Node s, Node t, int k) {
 
@@ -112 +112 @@
 
     
+    ///Total length of the paths
+    
     ///This function gives back the total length of the found paths.
-    ///Assumes that \c run() has been run and nothing changed since then.
+    ///\pre \ref run() must
+    ///be called before using this function.
     Length totalLength(){
       return mincost_flow.totalLength();
     }
 
-    ///Returns a const reference to the EdgeMap \c flow. \pre \ref run() must
+    ///Return the found flow.
+
+    ///This function returns a const reference to the EdgeMap \c flow.
+    ///\pre \ref run() must
     ///be called before using this function.
     const EdgeIntMap &getFlow() const { return mincost_flow.flow;}
 
-  ///Returns a const reference to the NodeMap \c potential (the dual solution).
+    /// Return the optimal dual solution
+    
+    ///This function returns a const reference to the NodeMap
+    ///\c potential (the dual solution).
     /// \pre \ref run() must be called before using this function.
     const EdgeIntMap &getPotential() const { return mincost_flow.potential;}
 
+    ///Checks whether the complementary slackness holds.
+
     ///This function checks, whether the given solution is optimal
     ///Running after a \c run() should return with true
-    ///In this "state of the art" this only checks optimality, doesn't bother with feasibility
+    ///Currently this function only checks optimality,
+    ///doesn't bother with feasibility
     ///
     ///\todo Is this OK here?
@@ -135 +147 @@
     }
 
+    ///Read the found paths.
+    
     ///This function gives back the \c j-th path in argument p.
     ///Assumes that \c run() has been run and nothing changed since then.
-    /// \warning It is assumed that \c p is constructed to be a path of graph \c G. If \c j is not less than the result of previous \c run, then the result here will be an empty path (\c j can be 0 as well).
-    template<typename DirPath>
-    void getPath(DirPath& p, size_t j){
+    /// \warning It is assumed that \c p is constructed to
+    ///be a path of graph \c G.
+    ///If \c j is not less than the result of previous \c run,
+    ///then the result here will be an empty path (\c j can be 0 as well).
+    template<typename Path>
+    void getPath(Path& p, size_t j){
       
       p.clear();