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