Made some parts clearer.
[mtp.git] / mtp_graph.h
1
2 /*
3  *  mtp is the ``Multi Tracked Paths'', an implementation of the
4  *  k-shortest paths algorithm for multi-target tracking.
5  *
6  *  Copyright (c) 2012 Idiap Research Institute, http://www.idiap.ch/
7  *  Written by Francois Fleuret <francois.fleuret@idiap.ch>
8  *
9  *  This file is part of mtp.
10  *
11  *  mtp is free software: you can redistribute it and/or modify it
12  *  under the terms of the GNU General Public License version 3 as
13  *  published by the Free Software Foundation.
14  *
15  *  mtp is distributed in the hope that it will be useful, but WITHOUT
16  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17  *  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
18  *  License for more details.
19  *
20  *  You should have received a copy of the GNU General Public License
21  *  along with selector.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24
25 #ifndef MTP_GRAPH_H
26 #define MTP_GRAPH_H
27
28 #include <iostream>
29 #include <cmath>
30
31 using namespace std;
32
33 #include "misc.h"
34 #include "path.h"
35
36 class Vertex;
37 class Edge;
38
39 class MTPGraph {
40   // Uses the estimated vertex distances to the source to make all the
41   // edge lengths positive, resulting in an identical added value to
42   // the total length of any path from source to a certain node (in
43   // particular the sink)
44   void update_positivized_lengths();
45
46   // It may happen that numerical errors in update_positivized_lengths
47   // make the resulting lengths negative, albeit very small. The
48   // following method forces all negative lengths to zero, and prints
49   // the total correction when compiled in VERBOSE mode.
50   void force_positivized_lengths();
51
52   // Set the edge pred_edge_toward_source correspondingly to the path
53   // of shortest length. The current implementation is not Dijkstra's!
54   void find_shortest_path();
55
56   // Follows the path starting on edge e and returns its length. If
57   // nodes is non-null, stores in it the nodes met along the path.
58   int retrieve_one_path(Edge *e, Path *path);
59
60   // Returns if the graph is a DAG
61   int is_dag();
62
63   Vertex **_front, **_new_front;
64
65   int _nb_vertices, _nb_edges;
66   Vertex *_source, *_sink;
67
68   Edge *_edges;
69   Vertex *_vertices;
70
71 public:
72
73   // These variables are filled when retrieve_disjoint_paths is called
74   int nb_paths;
75   Path **paths;
76
77   MTPGraph(int nb_vertices, int nb_edges, int *vertex_from, int *vertex_to,
78            int source, int sink);
79
80   ~MTPGraph();
81
82   void find_best_paths(scalar_t *lengths);
83   void retrieve_disjoint_paths();
84
85   void print(ostream *os);
86   void print_dot(ostream *os);
87 };
88
89 #endif