X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mtp.git;a=blobdiff_plain;f=mtp_graph.h;h=b07e4618c62e44dd9c120ad261667e282898c71d;hp=6b8c181afe7c734f2da324e4a37de6b71b310546;hb=90a6bc97162d199e3b840bf178f49854e5df91fa;hpb=7704ecb19140055b21e1012cd0d394f2a6db98eb

diff --git a/mtp_graph.h b/mtp_graph.h
index 6b8c181..b07e461 100644
--- a/mtp_graph.h
+++ b/mtp_graph.h
@@ -1,20 +1,26 @@
 
-///////////////////////////////////////////////////////////////////////////
-// This program is free software: you can redistribute it and/or modify  //
-// it under the terms of the version 3 of the GNU General Public License //
-// as published by the Free Software Foundation.                         //
-//                                                                       //
-// This program is distributed in the hope that it will be useful, but   //
-// WITHOUT ANY WARRANTY; without even the implied warranty of            //
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      //
-// General Public License for more details.                              //
-//                                                                       //
-// You should have received a copy of the GNU General Public License     //
-// along with this program. If not, see <http://www.gnu.org/licenses/>.  //
-//                                                                       //
-// Written by and Copyright (C) Francois Fleuret                         //
-// Contact <francois.fleuret@idiap.ch> for comments & bug reports        //
-///////////////////////////////////////////////////////////////////////////
+/*
+ *  mtp is the ``Multi Tracked Paths'', an implementation of the
+ *  k-shortest paths algorithm for multi-target tracking.
+ *
+ *  Copyright (c) 2012 Idiap Research Institute, http://www.idiap.ch/
+ *  Written by Francois Fleuret <francois.fleuret@idiap.ch>
+ *
+ *  This file is part of mtp.
+ *
+ *  mtp is free software: you can redistribute it and/or modify it
+ *  under the terms of the GNU General Public License version 3 as
+ *  published by the Free Software Foundation.
+ *
+ *  mtp is distributed in the hope that it will be useful, but WITHOUT
+ *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ *  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+ *  License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with selector.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
 
 #ifndef MTP_GRAPH_H
 #define MTP_GRAPH_H
@@ -32,11 +38,19 @@ class Edge;
 
 class MTPGraph {
   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 force such length to zero, and print the
+  // 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();
-  // Retrieve the path starting on edge e and return its length. If
-  // nodes is non-null, stores the node met along the path in it.
-  int retrieve_one_path(Edge *e, int *nodes);
+  // 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.
+  int retrieve_one_path(Edge *e, Path *path);
+  // Returns if the graph is a DAG
+  int is_dag();
 
   Vertex **_front, **_new_front;
 
@@ -52,7 +66,7 @@ public:
   int nb_paths;
   Path **paths;
 
-  MTPGraph(int nb_vertices, int nb_edges, int *from, int *to,
+  MTPGraph(int nb_vertices, int nb_edges, int *vertex_from, int *vertex_to,
            int source, int sink);
 
   ~MTPGraph();