X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=mtp_graph.h;h=bdf8674b9033f575e9687ec3be1000dcb41fb693;hb=20f94c6bff1541da8d0639966787dc8aaafea025;hp=9093a8b465d5b4b094d0c8e2cab425db5e2649b0;hpb=fa06c8a9f47351526c626703be5c75591a499f76;p=mtp.git

diff --git a/mtp_graph.h b/mtp_graph.h
index 9093a8b..bdf8674 100644
--- a/mtp_graph.h
+++ b/mtp_graph.h
@@ -37,14 +37,27 @@ class Vertex;
 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
+  // 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
+  // make the resulting lengths negative, albeit very small. The
+  // following method forces all negative lengths to zero, and prints
+  // the total correction when compiled in VERBOSE mode.
   void force_positivized_lengths();
+
   // Set the edge pred_edge_toward_source correspondingly to the path
   // 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
   int is_dag();
 
@@ -67,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);