From: Francois Fleuret <francois@fleuret.org>
Date: Mon, 17 Sep 2012 13:24:25 +0000 (+0200)
Subject: Comment update.
X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=commitdiff_plain;h=20f94c6bff1541da8d0639966787dc8aaafea025;p=mtp.git

Comment update.
---

diff --git a/mtp_graph.h b/mtp_graph.h
index 9b34248..bdf8674 100644
--- a/mtp_graph.h
+++ b/mtp_graph.h
@@ -39,8 +39,8 @@ class Edge;
 class MTPGraph {
   // Uses the estimated vertex distances to the source to make all the
   // edge lengths positive, resulting in an identical added value to
-  // the total length of any path from source to a certain node (in
-  // particular the sink)
+  // all the paths from the same initial node to the same final node
+  // (in particular from source to sink)
   void update_positivized_lengths();
 
   // It may happen that numerical errors in update_positivized_lengths
@@ -53,8 +53,9 @@ class MTPGraph {
   // of shortest length. The current implementation is not Dijkstra's!
   void find_shortest_path();
 
-  // Follows the path starting on edge e and returns its length. If
-  // nodes is non-null, stores in it the nodes met along the path.
+  // Follows the path starting on edge e and returns the number of
+  // nodes to reach the sink. If path is non-null, stores in it the
+  // nodes met along the path, and computes path->length properly.
   int retrieve_one_path(Edge *e, Path *path);
 
   // Returns if the graph is a DAG
@@ -79,7 +80,12 @@ public:
 
   ~MTPGraph();
 
+  // Compute the family of path with minimum total length, set the
+  // edge occupied fields accordingly.
   void find_best_paths(scalar_t *lengths);
+
+  // Retrieve the path corresponding to the occupied edges, and save
+  // the result in the nb_paths and paths fields.
   void retrieve_disjoint_paths();
 
   void print(ostream *os);