f28e460be9ef99b9b9fdca50363fc36e6a0d4cab
[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   // 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   // Set in every vertex pred_edge_toward_source correspondingly to
53   // the path of shortest length. The current implementation is not
54   // Dijkstra's!
55   void find_shortest_path();
56
57   // Follows the path starting on edge e and returns the number of
58   // nodes to reach the sink. If path is non-null, stores in it the
59   // nodes met along the path, and computes path->length properly.
60   int retrieve_one_path(Edge *e, Path *path);
61
62   // Returns if the graph is a DAG
63   int is_dag();
64
65   Vertex **_front, **_new_front;
66
67   int _nb_vertices, _nb_edges;
68   Vertex *_source, *_sink;
69
70   Edge *_edges;
71   Vertex *_vertices;
72
73 public:
74
75   // These variables are filled when retrieve_disjoint_paths is called
76   int nb_paths;
77   Path **paths;
78
79   MTPGraph(int nb_vertices, int nb_edges, int *vertex_from, int *vertex_to,
80            int source, int sink);
81
82   ~MTPGraph();
83
84   // Compute the family of path with minimum total length, set the
85   // edge occupied fields accordingly.
86   void find_best_paths(scalar_t *lengths);
87
88   // Retrieve the path corresponding to the occupied edges, and save
89   // the result in the nb_paths and paths fields.
90   void retrieve_disjoint_paths();
91
92   void print(ostream *os);
93   void print_dot(ostream *os);
94 };
95
96 #endif