mtp_graph.cc

   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 #include "mtp_graph.h"
  26
  27 #include <cmath>
  28 #include <float.h>
  29
  30 using namespace std;
  31
  32 class Edge {
  33 public:
  34   int occupied;
  35   scalar_t length, positivized_length;
  36   Vertex *origin_vertex, *terminal_vertex;
  37
  38   // These fields are used for the linked list of a vertex's leaving
  39   // edge list. We have to do insertions / deletions.
  40   Edge *next_leaving_edge, *pred_leaving_edge;
  41
  42   inline void invert();
  43 };
  44
  45 class Vertex {
  46 public:
  47   scalar_t distance_from_source;
  48   Edge *pred_edge_toward_source;
  49
  50   Edge *leaving_edge_list_root;
  51   Vertex **heap_slot;
  52
  53   Vertex();
  54
  55   inline void add_leaving_edge(Edge *e);
  56   inline void del_leaving_edge(Edge *e);
  57   inline void decrease_distance_in_heap(Vertex **heap);
  58   inline void increase_distance_in_heap(Vertex **heap, Vertex **heap_bottom);
  59 };
  60
  61 //////////////////////////////////////////////////////////////////////
  62
  63 void Edge::invert() {
  64   length = - length;
  65   positivized_length = - positivized_length;
  66   origin_vertex->del_leaving_edge(this);
  67   terminal_vertex->add_leaving_edge(this);
  68   swap(terminal_vertex, origin_vertex);
  69 }
  70
  71 //////////////////////////////////////////////////////////////////////
  72
  73 Vertex::Vertex() {
  74   leaving_edge_list_root = 0;
  75 }
  76
  77 void Vertex::add_leaving_edge(Edge *e) {
  78   e->next_leaving_edge = leaving_edge_list_root;
  79   e->pred_leaving_edge = 0;
  80   if(leaving_edge_list_root) {
  81     leaving_edge_list_root->pred_leaving_edge = e;
  82   }
  83   leaving_edge_list_root = e;
  84 }
  85
  86 void Vertex::del_leaving_edge(Edge *e) {
  87   if(e == leaving_edge_list_root) {
  88     leaving_edge_list_root = e->next_leaving_edge;
  89   }
  90   if(e->pred_leaving_edge) {
  91     e->pred_leaving_edge->next_leaving_edge = e->next_leaving_edge;
  92   }
  93   if(e->next_leaving_edge) {
  94     e->next_leaving_edge->pred_leaving_edge = e->pred_leaving_edge;
  95   }
  96 }
  97
  98 void Vertex::decrease_distance_in_heap(Vertex **heap) {
  99   Vertex **p, **h;
 100   // There is some beauty in that
 101   h = heap_slot;
 102   while(h > heap &&
 103         (p = heap + (h - heap + 1) / 2 - 1,
 104          (*p)->distance_from_source > (*h)->distance_from_source)) {
 105     swap(*p, *h);
 106     swap((*p)->heap_slot, (*h)->heap_slot);
 107     h = p;
 108   }
 109 }
 110
 111 void Vertex::increase_distance_in_heap(Vertex **heap, Vertex **heap_bottom) {
 112   Vertex **c1, **c2, **h;
 113   // omg, that's beautiful
 114   h = heap_slot;
 115   while(c1 = heap + 2 * (h - heap) + 1,
 116         c1 < heap_bottom &&
 117         (c2 = c1 + 1,
 118          (*c1)->distance_from_source < (*h)->distance_from_source
 119          ||
 120          (c2 < heap_bottom && (*c2)->distance_from_source < (*h)->distance_from_source)
 121          )) {
 122     if(c2 < heap_bottom && (*c2)->distance_from_source <= (*c1)->distance_from_source) {
 123       swap(*c2, *h);
 124       swap((*c2)->heap_slot, (*h)->heap_slot);
 125       h = c2;
 126     } else {
 127       swap(*c1, *h);
 128       swap((*c1)->heap_slot, (*h)->heap_slot);
 129       h = c1;
 130     }
 131   }
 132 }
 133
 134 //////////////////////////////////////////////////////////////////////
 135
 136 static int compare_vertices_on_distance(const void *v1, const void *v2) {
 137   scalar_t delta =
 138     (*((Vertex **) v1))->distance_from_source -
 139     (*((Vertex **) v2))->distance_from_source;
 140   if(delta < 0) return -1;
 141   else if(delta > 0) return 1;
 142   else return 0;
 143 }
 144
 145 //////////////////////////////////////////////////////////////////////
 146
 147 MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
 148                    int *vertex_from, int *vertex_to,
 149                    int source, int sink) {
 150   _nb_vertices = nb_vertices;
 151   _nb_edges = nb_edges;
 152
 153   _edges = new Edge[_nb_edges];
 154   _vertices = new Vertex[_nb_vertices];
 155   _heap = new Vertex *[_nb_vertices];
 156   _dp_order = new Vertex *[_nb_vertices];
 157
 158   _source = &_vertices[source];
 159   _sink = &_vertices[sink];
 160
 161   for(int e = 0; e < nb_edges; e++) {
 162     _vertices[vertex_from[e]].add_leaving_edge(_edges + e);
 163     _edges[e].occupied = 0;
 164     _edges[e].origin_vertex = _vertices + vertex_from[e];
 165     _edges[e].terminal_vertex = _vertices + vertex_to[e];
 166   }
 167
 168   for(int v = 0; v < _nb_vertices; v++) {
 169     _heap[v] = &_vertices[v];
 170     _vertices[v].heap_slot = &_heap[v];
 171   }
 172
 173   paths = 0;
 174   nb_paths = 0;
 175
 176   compute_dp_ranks();
 177   for(int v = 0; v < _nb_vertices; v++) { _dp_order[v] = &_vertices[v]; }
 178   qsort(_dp_order, _nb_vertices, sizeof(Vertex *), compare_vertices_on_distance);
 179 }
 180
 181 MTPGraph::~MTPGraph() {
 182   delete[] _vertices;
 183   delete[] _dp_order;
 184   delete[] _heap;
 185   delete[] _edges;
 186   for(int p = 0; p < nb_paths; p++) delete paths[p];
 187   delete[] paths;
 188 }
 189
 190 //////////////////////////////////////////////////////////////////////
 191
 192 void MTPGraph::compute_dp_ranks() {
 193   Vertex *v;
 194   Edge *e;
 195
 196   // This procedure computes for each node the longest link from the
 197   // source and abort if the graph is not a DAG. It works by removing
 198   // successively nodes without predecessor: At the first iteration it
 199   // removes the source, then the nodes with incoming edge only from
 200   // the source, etc. If it can remove all the nodes that way, the
 201   // graph is a DAG. If at some point it can not remove node anymore
 202   // and there are some remaining nodes, the graph is not a DAG. The
 203   // rank of a node is the iteration at which is it removed, and we
 204   // set the distance_from_source fields to this value.
 205
 206   Vertex **with_predecessor = new Vertex *[_nb_vertices];
 207
 208   // All the nodes are with_predecessor at first
 209   for(int k = 0; k < _nb_vertices; k++) {
 210     _vertices[k].distance_from_source = 0;
 211     with_predecessor[k] = &_vertices[k];
 212   }
 213
 214   scalar_t rank = 1;
 215   int nb_with_predecessor = _nb_vertices, pred_nb_with_predecessor;
 216
 217   do {
 218     // We set the distance_from_source field of all the vertices with incoming
 219     // edges to the current rank value
 220     for(int f = 0; f < nb_with_predecessor; f++) {
 221       v = with_predecessor[f];
 222       for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 223         e->terminal_vertex->distance_from_source = rank;
 224       }
 225     }
 226
 227     pred_nb_with_predecessor = nb_with_predecessor;
 228     nb_with_predecessor = 0;
 229
 230     // We keep all the vertices with incoming nodes
 231     for(int f = 0; f < pred_nb_with_predecessor; f++) {
 232       v = with_predecessor[f];
 233       if(v->distance_from_source == rank) {
 234         with_predecessor[nb_with_predecessor++] = v;
 235       }
 236     }
 237
 238     rank++;
 239   } while(nb_with_predecessor < pred_nb_with_predecessor);
 240
 241   delete[] with_predecessor;
 242
 243   if(nb_with_predecessor > 0) {
 244     cerr << __FILE__ << ": The graph is not a DAG." << endl;
 245     abort();
 246   }
 247 }
 248
 249 //////////////////////////////////////////////////////////////////////
 250
 251 void MTPGraph::print(ostream *os) {
 252   for(int k = 0; k < _nb_edges; k++) {
 253     Edge *e = _edges + k;
 254     (*os) << e->origin_vertex - _vertices
 255           << " -> "
 256           << e->terminal_vertex - _vertices
 257           << " (" << e->length << ")";
 258     if(e->occupied) { (*os) << " *"; }
 259     (*os) << endl;
 260   }
 261 }
 262
 263 void MTPGraph::print_dot(ostream *os) {
 264   (*os) << "digraph {" << endl;
 265   (*os) << "        rankdir=\"LR\";" << endl;
 266   (*os) << "        node [shape=circle,width=0.75,fixedsize=true];" << endl;
 267   (*os) << "        edge [color=gray,arrowhead=open]" << endl;
 268   (*os) << "        " << _source - _vertices << " [peripheries=2];" << endl;
 269   (*os) << "        " << _sink - _vertices << " [peripheries=2];" << endl;
 270   for(int k = 0; k < _nb_edges; k++) {
 271     Edge *e = _edges + k;
 272     (*os) << "        "
 273           << e->origin_vertex - _vertices
 274           << " -> "
 275           << e->terminal_vertex - _vertices
 276           << " [";
 277     if(e->occupied) {
 278       (*os) << "style=bold,color=black,";
 279     }
 280     (*os) << "label=\"" << e->length << "\"];" << endl;
 281   }
 282   (*os) << "}" << endl;
 283 }
 284
 285 //////////////////////////////////////////////////////////////////////
 286
 287 void MTPGraph::update_positivized_lengths() {
 288   for(int k = 0; k < _nb_edges; k++) {
 289     Edge *e = _edges + k;
 290     e->positivized_length +=
 291       e->origin_vertex->distance_from_source - e->terminal_vertex->distance_from_source;
 292   }
 293 }
 294
 295 void MTPGraph::force_positivized_lengths() {
 296 #ifdef VERBOSE
 297   scalar_t residual_error = 0.0;
 298   scalar_t max_error = 0.0;
 299 #endif
 300   for(int k = 0; k < _nb_edges; k++) {
 301     Edge *e = _edges + k;
 302
 303     if(e->positivized_length < 0) {
 304 #ifdef VERBOSE
 305       residual_error -= e->positivized_length;
 306       max_error = max(max_error, - e->positivized_length);
 307 #endif
 308       e->positivized_length = 0.0;
 309     }
 310   }
 311 #ifdef VERBOSE
 312   cerr << __FILE__ << ": residual_error " << residual_error << " max_error " << residual_error << endl;
 313 #endif
 314 }
 315
 316 void MTPGraph::dp_compute_distances() {
 317   Vertex *v, *tv;
 318   Edge *e;
 319   scalar_t d;
 320
 321   for(int k = 0; k < _nb_vertices; k++) {
 322     _vertices[k].distance_from_source = FLT_MAX;
 323     _vertices[k].pred_edge_toward_source = 0;
 324   }
 325
 326   _source->distance_from_source = 0;
 327
 328   for(int k = 0; k < _nb_vertices; k++) {
 329     v = _dp_order[k];
 330     for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 331       d = v->distance_from_source + e->positivized_length;
 332       tv = e->terminal_vertex;
 333       if(d < tv->distance_from_source) {
 334         tv->distance_from_source = d;
 335         tv->pred_edge_toward_source = e;
 336       }
 337     }
 338   }
 339 }
 340
 341 // This method does not change the edge occupation. It only sets
 342 // properly, for every vertex, the fields distance_from_source and
 343 // pred_edge_toward_source.
 344
 345 void MTPGraph::find_shortest_path() {
 346   Vertex *v, *tv, **last_slot;
 347   Edge *e;
 348   scalar_t d;
 349
 350   for(int k = 0; k < _nb_vertices; k++) {
 351     _vertices[k].distance_from_source = FLT_MAX;
 352     _vertices[k].pred_edge_toward_source = 0;
 353   }
 354
 355   _heap_size = _nb_vertices;
 356   _source->distance_from_source = 0;
 357   _source->decrease_distance_in_heap(_heap);
 358
 359   do {
 360     // Get the closest to the source
 361     v = _heap[0];
 362
 363     // Remove it from the heap (swap it with the last_slot in the heap, and
 364     // update the distance of that one)
 365     _heap_size--;
 366     last_slot = _heap + _heap_size;
 367     swap(*_heap, *last_slot); swap((*_heap)->heap_slot, (*last_slot)->heap_slot);
 368     _heap[0]->increase_distance_in_heap(_heap, _heap + _heap_size);
 369
 370     // Now update the neighbors of the node currently closest to the
 371     // source
 372     for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 373       d = v->distance_from_source + e->positivized_length;
 374       tv = e->terminal_vertex;
 375       if(d < tv->distance_from_source) {
 376         ASSERT(tv->heap_slot - _heap < _heap_size);
 377         tv->distance_from_source = d;
 378         tv->pred_edge_toward_source = e;
 379         tv->decrease_distance_in_heap(_heap);
 380       }
 381     }
 382   } while(_heap_size > 0);
 383 }
 384
 385 void MTPGraph::find_best_paths(scalar_t *lengths) {
 386   scalar_t shortest_path_length;
 387   Vertex *v;
 388   Edge *e;
 389
 390   for(int e = 0; e < _nb_edges; e++) {
 391     _edges[e].length = lengths[e];
 392     _edges[e].occupied = 0;
 393     _edges[e].positivized_length = _edges[e].length;
 394   }
 395
 396   // Compute the distance of all the nodes from the source by just
 397   // visiting them in the proper DAG ordering we computed when
 398   // building the graph
 399   dp_compute_distances();
 400
 401   do {
 402     // Use the current distance from the source to make all edge
 403     // lengths positive
 404     update_positivized_lengths();
 405     // Fix numerical errors
 406     force_positivized_lengths();
 407
 408     find_shortest_path();
 409
 410     shortest_path_length = 0.0;
 411
 412     // Do we reach the sink?
 413     if(_sink->pred_edge_toward_source) {
 414       // If yes, compute the length of the best path according to the
 415       // original edge lengths
 416       v = _sink;
 417       while(v->pred_edge_toward_source) {
 418         shortest_path_length += v->pred_edge_toward_source->length;
 419         v = v->pred_edge_toward_source->origin_vertex;
 420       }
 421       // If that length is negative
 422       if(shortest_path_length < 0.0) {
 423 #ifdef VERBOSE
 424         cerr << __FILE__ << ": Found a path of length " << shortest_path_length << endl;
 425 #endif
 426         // Invert all the edges along the best path
 427         v = _sink;
 428         while(v->pred_edge_toward_source) {
 429           e = v->pred_edge_toward_source;
 430           v = e->origin_vertex;
 431           e->invert();
 432           // This is the only place where we change the occupations of
 433           // edges
 434           e->occupied = 1 - e->occupied;
 435         }
 436       }
 437     }
 438
 439   } while(shortest_path_length < 0.0);
 440
 441   // Put back the graph in its original state (i.e. invert edges which
 442   // have been inverted in the process)
 443   for(int k = 0; k < _nb_edges; k++) {
 444     e = _edges + k;
 445     if(e->occupied) { e->invert(); }
 446   }
 447 }
 448
 449 int MTPGraph::retrieve_one_path(Edge *e, Path *path) {
 450   Edge *f, *next = 0;
 451   int l = 0, nb_occupied_next;
 452
 453   if(path) {
 454     path->nodes[l++] = e->origin_vertex - _vertices;
 455     path->length = e->length;
 456   } else l++;
 457
 458   while(e->terminal_vertex != _sink) {
 459     if(path) {
 460       path->nodes[l++] = e->terminal_vertex - _vertices;
 461       path->length += e->length;
 462     } else l++;
 463
 464     nb_occupied_next = 0;
 465     for(f = e->terminal_vertex->leaving_edge_list_root; f; f = f->next_leaving_edge) {
 466       if(f->occupied) { nb_occupied_next++; next = f; }
 467     }
 468
 469 #ifdef DEBUG
 470     if(nb_occupied_next == 0) {
 471       cerr << __FILE__ << ": retrieve_one_path: Non-sink end point." << endl;
 472       abort();
 473     }
 474
 475     else if(nb_occupied_next > 1) {
 476       cerr << __FILE__ << ": retrieve_one_path: Non node-disjoint paths." << endl;
 477       abort();
 478     }
 479 #endif
 480
 481     e = next;
 482   }
 483
 484   if(path) {
 485     path->nodes[l++] = e->terminal_vertex - _vertices;
 486     path->length += e->length;
 487   } else l++;
 488
 489   return l;
 490 }
 491
 492 void MTPGraph::retrieve_disjoint_paths() {
 493   Edge *e;
 494   int p, l;
 495
 496   for(int p = 0; p < nb_paths; p++) delete paths[p];
 497   delete[] paths;
 498
 499   nb_paths = 0;
 500   for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 501     if(e->occupied) { nb_paths++; }
 502   }
 503
 504   paths = new Path *[nb_paths];
 505
 506   p = 0;
 507   for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 508     if(e->occupied) {
 509       l = retrieve_one_path(e, 0);
 510       paths[p] = new Path(l);
 511       retrieve_one_path(e, paths[p]);
 512       p++;
 513     }
 514   }
 515 }