Made some parts clearer.

[mtp.git] / mtp_graph.h

diff --git a/mtp_graph.h b/mtp_graph.h
index e465688..9b34248 100644 (file)
--- a/mtp_graph.h
+++ b/mtp_graph.h
@@ -1,41 +1,64 @@
 
-///////////////////////////////////////////////////////////////////////////
-// 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
 
+#include <iostream>
+#include <cmath>
+
+using namespace std;
+
 #include "misc.h"
+#include "path.h"
 
 class Vertex;
 class Edge;
 
-class Path {
-public:
-  int starting_time;
-  int duration;
-  int *nodes;
-};
-
 class MTPGraph {
-  void initialize_positivized_lengths_with_min();
+  // 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)
   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();
-  void find_shortest_path(Vertex **front, Vertex **new_front);
+
+  // 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.
+  int retrieve_one_path(Edge *e, Path *path);
+
+  // Returns if the graph is a DAG
+  int is_dag();
 
   Vertex **_front, **_new_front;
 
@@ -47,19 +70,20 @@ class MTPGraph {
 
 public:
 
+  // These variables are filled when retrieve_disjoint_paths is called
   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();
 
-  void find_best_paths(scalar_t *lengths, int *result_edge_occupation);
-  void retrieve_paths();
+  void find_best_paths(scalar_t *lengths);
+  void retrieve_disjoint_paths();
 
-  void print();
-  void print_dot();
+  void print(ostream *os);
+  void print_dot(ostream *os);
 };
 
 #endif