Simplified a bit find_shortest_path.
[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
30 using namespace std;
31
32 #include "misc.h"
33 #include "path.h"
34
35 class Vertex;
36 class Edge;
37
38 class MTPGraph {
39
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   // all the paths from the same initial node to the same final node
43   // (in particular from source to 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   // Visit the vertices according to _dp_order and update their
53   // distance from the source
54   void dp_compute_distances();
55
56   // Set in every vertex pred_edge_toward_source correspondingly to
57   // the path of shortest length. The current implementation is
58   // Dijkstra with a Binary Heap (and not with Fibonnaci heap (yet))
59   void find_shortest_path();
60
61   // Follows the path starting on edge e and returns the number of
62   // nodes to reach the sink. If path is non-null, stores in it the
63   // nodes met along the path, and computes path->length properly.
64   int retrieve_one_path(Edge *e, Path *path);
65
66   int _nb_vertices, _nb_edges;
67   Vertex *_source, *_sink;
68
69   Edge *_edges;
70   Vertex *_vertices;
71
72   // For Dijkstra
73   Vertex **_heap;
74
75   // Updating the distances from the source in that order will work in
76   // the original graph (which has to be a DAG)
77   Vertex **_dp_order;
78
79   // Fills _dp_order
80   void compute_dp_ordering();
81 public:
82
83   // These variables are filled when retrieve_disjoint_paths is called
84   int nb_paths;
85   Path **paths;
86
87   MTPGraph(int nb_vertices, int nb_edges, int *vertex_from, int *vertex_to,
88            int source, int sink);
89
90   ~MTPGraph();
91
92   // Compute the family of paths with minimum total length, set the
93   // edge occupied fields accordingly.
94   void find_best_paths(scalar_t *lengths);
95
96   // Retrieve the paths corresponding to the occupied edges, and save
97   // the result in the nb_paths and paths fields.
98   void retrieve_disjoint_paths();
99
100   void print(ostream *os);
101   void print_dot(ostream *os);
102 };
103
104 #endif