Cosmetics.
[mtp.git] / mtp_graph.cc
1
2 ///////////////////////////////////////////////////////////////////////////
3 // This program is free software: you can redistribute it and/or modify  //
4 // it under the terms of the version 3 of the GNU General Public License //
5 // as published by the Free Software Foundation.                         //
6 //                                                                       //
7 // This program is distributed in the hope that it will be useful, but   //
8 // WITHOUT ANY WARRANTY; without even the implied warranty of            //
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      //
10 // General Public License for more details.                              //
11 //                                                                       //
12 // You should have received a copy of the GNU General Public License     //
13 // along with this program. If not, see <http://www.gnu.org/licenses/>.  //
14 //                                                                       //
15 // Written by and Copyright (C) Francois Fleuret                         //
16 // Contact <francois.fleuret@idiap.ch> for comments & bug reports        //
17 ///////////////////////////////////////////////////////////////////////////
18
19 #include "mtp_graph.h"
20
21 #include <iostream>
22 #include <float.h>
23 #include <stdlib.h>
24
25 using namespace std;
26
27 class Edge {
28 public:
29   int id, occupied;
30   scalar_t length, positivized_length;
31   Vertex *origin_vertex, *terminal_vertex;
32
33   // These are the links in the origin_vertex leaving edge list
34   Edge *next_leaving_edge, *pred_leaving_edge;
35
36   inline void invert();
37 };
38
39 class Vertex {
40 public:
41   int id;
42   Edge *leaving_edges;
43   scalar_t distance_from_source;
44   Edge *best_pred_edge_to_source;
45
46   int iteration; // Used in find_shortest_path to know if we already
47                  // added this vertex to the front
48   Vertex();
49   inline void add_edge(Edge *e);
50   inline void del_edge(Edge *e);
51 };
52
53 //////////////////////////////////////////////////////////////////////
54
55 void Edge::invert() {
56   length = - length;
57   positivized_length = 0;
58   origin_vertex->del_edge(this);
59   terminal_vertex->add_edge(this);
60   Vertex *t = terminal_vertex;
61   terminal_vertex = origin_vertex;
62   origin_vertex = t;
63 }
64
65 //////////////////////////////////////////////////////////////////////
66
67 Vertex::Vertex() {
68   leaving_edges = 0;
69 }
70
71 void Vertex::add_edge(Edge *e) {
72   e->next_leaving_edge = leaving_edges;
73   e->pred_leaving_edge = 0;
74   if(leaving_edges) { leaving_edges->pred_leaving_edge = e; }
75   leaving_edges = e;
76 }
77
78 void Vertex::del_edge(Edge *e) {
79   if(e == leaving_edges) { leaving_edges = e->next_leaving_edge; }
80   if(e->pred_leaving_edge) { e->pred_leaving_edge->next_leaving_edge = e->next_leaving_edge; }
81   if(e->next_leaving_edge) { e->next_leaving_edge->pred_leaving_edge = e->pred_leaving_edge; }
82 }
83
84 //////////////////////////////////////////////////////////////////////
85
86 MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
87                    int *from, int *to,
88                    int source, int sink) {
89   _nb_vertices = nb_vertices;
90   _nb_edges = nb_edges;
91
92   _edges = new Edge[_nb_edges];
93   _vertices = new Vertex[_nb_vertices];
94   _front = new Vertex *[_nb_vertices];
95   _new_front = new Vertex *[_nb_vertices];
96
97   _source = &_vertices[source];
98   _sink = &_vertices[sink];
99
100   for(int v = 0; v < _nb_vertices; v++) {
101     _vertices[v].id = v;
102   }
103
104   for(int e = 0; e < nb_edges; e++) {
105     _vertices[from[e]].add_edge(_edges + e);
106     _edges[e].occupied = 0;
107     _edges[e].id = e;
108     _edges[e].origin_vertex = _vertices + from[e];
109     _edges[e].terminal_vertex = _vertices + to[e];
110   }
111
112   paths = 0;
113   nb_paths = 0;
114 }
115
116 MTPGraph::~MTPGraph() {
117   delete[] _vertices;
118   delete[] _edges;
119   delete[] _front;
120   delete[] _new_front;
121   for(int p = 0; p < nb_paths; p++) delete paths[p];
122   delete[] paths;
123 }
124
125 //////////////////////////////////////////////////////////////////////
126
127 void MTPGraph::print(ostream *os) {
128   for(int k = 0; k < _nb_edges; k++) {
129     Edge *e = _edges + k;
130     (*os) << e->origin_vertex->id
131          << " -> "
132          << e->terminal_vertex->id
133          << " "
134          << e->length;
135     if(e->occupied) {
136       (*os) << " *";
137     }
138     (*os) << endl;
139   }
140 }
141
142 void MTPGraph::print_dot(ostream *os) {
143   (*os) << "digraph {" << endl;
144   // (*os) << "        node [shape=circle];" << endl;
145   (*os) << "        edge [color=gray]" << endl;
146   (*os) << "        " << _source->id << " [peripheries=2];" << endl;
147   (*os) << "        " << _sink->id << " [peripheries=2];" << endl;
148   for(int k = 0; k < _nb_edges; k++) {
149     Edge *e = _edges + k;
150     // (*os) << "  " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
151           // << ";"
152           // << endl;
153     if(e->occupied) {
154       (*os) << "        " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
155            << " [style=bold,color=black,label=\"" << e->length << "\"];" << endl;
156     } else {
157       (*os) << "        " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
158            << " [label=\"" << e->length << "\"];" << endl;
159     }
160   }
161   (*os) << "}" << endl;
162 }
163
164 //////////////////////////////////////////////////////////////////////
165
166 void MTPGraph::initialize_positivized_lengths_with_min() {
167   scalar_t length_min = 0;
168   for(int n = 0; n < _nb_vertices; n++) {
169     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
170       length_min = min(e->length, length_min);
171     }
172   }
173   for(int n = 0; n < _nb_vertices; n++) {
174     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
175       e->positivized_length = e->length - length_min;
176     }
177   }
178 }
179
180 void MTPGraph::update_positivized_lengths() {
181   for(int k = 0; k < _nb_edges; k++) {
182     Edge *e = _edges + k;
183     e->positivized_length +=
184       e->origin_vertex->distance_from_source - e->terminal_vertex->distance_from_source;
185   }
186 }
187
188 void MTPGraph::force_positivized_lengths() {
189 #ifdef VERBOSE
190   scalar_t residual_error = 0.0;
191   scalar_t max_error = 0.0;
192 #endif
193   for(int n = 0; n < _nb_vertices; n++) {
194     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
195       if(e->positivized_length < 0) {
196 #ifdef VERBOSE
197         residual_error -= e->positivized_length;
198         max_error = max(max_error, fabs(e->positivized_length));
199 #endif
200         e->positivized_length = 0.0;
201       }
202     }
203   }
204 #ifdef VERBOSE
205   cerr << "residual_error " << residual_error << " max_error " << residual_error << endl;
206 #endif
207 }
208
209 // This method does not change the edge occupation. It update
210 // distance_from_source and best_pred_edge_to_source.
211 void MTPGraph::find_shortest_path(Vertex **_front, Vertex **_new_front) {
212   Vertex **tmp_front;
213   int tmp_front_size;
214   Vertex *v, *tv;
215   Edge *e;
216   scalar_t d;
217
218   for(int v = 0; v < _nb_vertices; v++) {
219     _vertices[v].distance_from_source = FLT_MAX;
220     _vertices[v].best_pred_edge_to_source = 0;
221     _vertices[v].iteration = 0;
222   }
223
224   int iteration = 0;
225
226   int _front_size = 0, _new_front_size;
227   _front[_front_size++] = _source;
228   _source->distance_from_source = 0;
229
230   do {
231     _new_front_size = 0;
232     iteration++;
233
234     for(int f = 0; f < _front_size; f++) {
235       v = _front[f];
236       for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
237         d = v->distance_from_source + e->positivized_length;
238         tv = e->terminal_vertex;
239         if(d < tv->distance_from_source) {
240           tv->distance_from_source = d;
241           tv->best_pred_edge_to_source = e;
242           if(tv->iteration < iteration) {
243             _new_front[_new_front_size++] = tv;
244             tv->iteration = iteration;
245           }
246         }
247       }
248     }
249
250     tmp_front = _new_front;
251     _new_front = _front;
252     _front = tmp_front;
253
254     tmp_front_size = _new_front_size;
255     _new_front_size = _front_size;
256     _front_size = tmp_front_size;
257   } while(_front_size > 0);
258 }
259
260 void MTPGraph::find_best_paths(scalar_t *lengths) {
261   scalar_t total_length;
262   Vertex *v;
263   Edge *e;
264
265   for(int e = 0; e < _nb_edges; e++) {
266     _edges[e].length = lengths[e];
267     _edges[e].occupied = 0;
268     _edges[e].positivized_length = _edges[e].length;
269   }
270
271   // We use one iteration of find_shortest_path simply to propagate
272   // the distance to make all the edge lengths positive.
273   find_shortest_path(_front, _new_front);
274   update_positivized_lengths();
275
276   // #warning
277   // initialize_positivized_lengths_with_min();
278
279   do {
280     force_positivized_lengths();
281     find_shortest_path(_front, _new_front);
282     update_positivized_lengths();
283
284     total_length = 0.0;
285
286     // Do we reach the _sink?
287     if(_sink->best_pred_edge_to_source) {
288       // If yes, compute the length of the best path
289       v = _sink;
290       while(v->best_pred_edge_to_source) {
291         total_length += v->best_pred_edge_to_source->length;
292         v = v->best_pred_edge_to_source->origin_vertex;
293       }
294       // If that length is negative
295       if(total_length < 0.0) {
296 #ifdef VERBOSE
297         cerr << "Found a path of length " << total_length << endl;
298 #endif
299         // Invert all the edges along the best path
300         v = _sink;
301         while(v->best_pred_edge_to_source) {
302           e = v->best_pred_edge_to_source;
303           v = e->origin_vertex;
304           e->invert();
305           // This is the only place where we change the occupations of
306           // edges
307           e->occupied = 1 - e->occupied;
308         }
309       }
310     }
311
312   } while(total_length < 0.0);
313
314   for(int k = 0; k < _nb_edges; k++) {
315     Edge *e = _edges + k;
316     if(e->occupied) { e->invert(); }
317   }
318 }
319
320 int MTPGraph::retrieve_one_path(Edge *e, int *nodes) {
321   Edge *f, *next = 0;
322   int l = 0;
323
324   if(nodes) { nodes[l++] = e->origin_vertex->id; }
325   else l++;
326
327   while(e->terminal_vertex != _sink) {
328     if(nodes) { nodes[l++] = e->terminal_vertex->id; }
329     else l++;
330     int nb_choices = 0;
331     for(f = e->terminal_vertex->leaving_edges; f; f = f->next_leaving_edge) {
332       if(f->occupied) { nb_choices++; next = f; }
333       if(nb_choices == 0) {
334         cerr << "Non-sink path end point?!" << endl;
335         abort();
336       }
337       if(nb_choices > 1) {
338         cerr << "Non node-disjoint path, can not retrieve." << endl;
339         abort();
340       }
341     }
342     e = next;
343   }
344
345   if(nodes) { nodes[l++] = e->terminal_vertex->id; }
346   else l++;
347
348   return l;
349 }
350
351 void MTPGraph::retrieve_disjoint_paths() {
352   Edge *e;
353
354   for(int p = 0; p < nb_paths; p++) delete paths[p];
355   delete[] paths;
356
357   nb_paths = 0;
358   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
359     if(e->occupied) { nb_paths++; }
360   }
361
362   paths = new Path *[nb_paths];
363
364   int p = 0;
365   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
366     if(e->occupied) {
367       int l = retrieve_one_path(e, 0);
368       paths[p] = new Path(l);
369       retrieve_one_path(e, paths[p]->nodes);
370       p++;
371     }
372   }
373 }