Cosmetics.
[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   // Set the distance_from_source fields to the number of DP
40   // iterations needed to update it. Abort if the graph is not a DAG.
41   void compute_dp_ranks();
42
43   // Uses the estimated vertex distances to the source to make all the
44   // edge lengths positive, resulting in an identical added value to
45   // all the paths from the same initial node to the same final node
46   // (in particular from source to sink)
47   void update_positivized_lengths();
48
49   // It may happen that numerical errors in update_positivized_lengths
50   // make the resulting lengths negative, albeit very small. The
51   // following method forces all negative lengths to zero, and prints
52   // the total correction when compiled in VERBOSE mode.
53   void force_positivized_lengths();
54
55   // Visit the vertices according to _dp_order and update their
56   // distance from the source
57   void dp_compute_distances();
58
59   // Set in every vertex pred_edge_toward_source correspondingly to
60   // the path of shortest length. The current implementation is
61   // Dijkstra with a Binary Heap (and not with Fibonnaci heap (yet))
62   void find_shortest_path();
63
64   // Follows the path starting on edge e and returns the number of
65   // nodes to reach the sink. If path is non-null, stores in it the
66   // nodes met along the path, and computes path->length properly.
67   int retrieve_one_path(Edge *e, Path *path);
68
69   int _nb_vertices, _nb_edges;
70   Vertex *_source, *_sink;
71
72   Edge *_edges;
73   Vertex *_vertices;
74
75   // For Dijkstra
76   Vertex **_heap;
77   int _heap_size;
78
79   // Updating the distances from the source in that order will work in
80   // the original graph (which has to be a DAG)
81   Vertex **_dp_order;
82
83 public:
84
85   // These variables are filled when retrieve_disjoint_paths is called
86   int nb_paths;
87   Path **paths;
88
89   MTPGraph(int nb_vertices, int nb_edges, int *vertex_from, int *vertex_to,
90            int source, int sink);
91
92   ~MTPGraph();
93
94   // Compute the family of paths with minimum total length, set the
95   // edge occupied fields accordingly.
96   void find_best_paths(scalar_t *lengths);
97
98   // Retrieve the paths corresponding to the occupied edges, and save
99   // the result in the nb_paths and paths fields.
100   void retrieve_disjoint_paths();
101
102   void print(ostream *os);
103   void print_dot(ostream *os);
104 };
105
106 #endif