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_ordering();
 177 }
 178
 179 MTPGraph::~MTPGraph() {
 180   delete[] _vertices;
 181   delete[] _dp_order;
 182   delete[] _heap;
 183   delete[] _edges;
 184   for(int p = 0; p < nb_paths; p++) delete paths[p];
 185   delete[] paths;
 186 }
 187
 188 //////////////////////////////////////////////////////////////////////
 189
 190 void MTPGraph::print(ostream *os) {
 191   for(int k = 0; k < _nb_edges; k++) {
 192     Edge *e = &_edges[k];
 193     (*os) << e->origin_vertex - _vertices
 194           << " -> "
 195           << e->terminal_vertex - _vertices
 196           << " (" << e->length << ")";
 197     if(e->occupied) { (*os) << " *"; }
 198     (*os) << endl;
 199   }
 200 }
 201
 202 void MTPGraph::print_dot(ostream *os) {
 203   (*os) << "digraph {" << endl;
 204   (*os) << "        rankdir=\"LR\";" << endl;
 205   (*os) << "        node [shape=circle,width=0.75,fixedsize=true];" << endl;
 206   (*os) << "        edge [color=gray,arrowhead=open]" << endl;
 207   (*os) << "        " << _source - _vertices << " [peripheries=2];" << endl;
 208   (*os) << "        " << _sink - _vertices << " [peripheries=2];" << endl;
 209   for(int k = 0; k < _nb_edges; k++) {
 210     Edge *e = &_edges[k];
 211     (*os) << "        "
 212           << e->origin_vertex - _vertices
 213           << " -> "
 214           << e->terminal_vertex - _vertices
 215           << " [";
 216     if(e->occupied) {
 217       (*os) << "style=bold,color=black,";
 218     }
 219     (*os) << "label=\"" << e->length << "\"];" << endl;
 220   }
 221   (*os) << "}" << endl;
 222 }
 223
 224 //////////////////////////////////////////////////////////////////////
 225
 226 void MTPGraph::update_positivized_lengths() {
 227   for(int k = 0; k < _nb_edges; k++) {
 228     Edge *e = &_edges[k];
 229     e->positivized_length +=
 230       e->origin_vertex->distance_from_source - e->terminal_vertex->distance_from_source;
 231   }
 232 }
 233
 234 void MTPGraph::force_positivized_lengths() {
 235 #ifdef VERBOSE
 236   scalar_t residual_error = 0.0;
 237   scalar_t max_error = 0.0;
 238 #endif
 239   for(int k = 0; k < _nb_edges; k++) {
 240     Edge *e = &_edges[k];
 241
 242     if(e->positivized_length < 0) {
 243 #ifdef VERBOSE
 244       residual_error -= e->positivized_length;
 245       max_error = max(max_error, - e->positivized_length);
 246 #endif
 247       e->positivized_length = 0.0;
 248     }
 249   }
 250 #ifdef VERBOSE
 251   cerr << __FILE__ << ": residual_error " << residual_error << " max_error " << residual_error << endl;
 252 #endif
 253 }
 254
 255 void MTPGraph::dp_compute_distances() {
 256   Vertex *v, *tv;
 257   Edge *e;
 258   scalar_t d;
 259
 260   for(int k = 0; k < _nb_vertices; k++) {
 261     _vertices[k].distance_from_source = FLT_MAX;
 262     _vertices[k].pred_edge_toward_source = 0;
 263   }
 264
 265   _source->distance_from_source = 0;
 266
 267   for(int k = 0; k < _nb_vertices; k++) {
 268     v = _dp_order[k];
 269     for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 270       d = v->distance_from_source + e->positivized_length;
 271       tv = e->terminal_vertex;
 272       if(d < tv->distance_from_source) {
 273         tv->distance_from_source = d;
 274         tv->pred_edge_toward_source = e;
 275       }
 276     }
 277   }
 278 }
 279
 280 // This method does not change the edge occupation. It only sets
 281 // properly, for every vertex, the fields distance_from_source and
 282 // pred_edge_toward_source.
 283
 284 void MTPGraph::find_shortest_path() {
 285   Vertex *v, *tv, **last_slot;
 286   Edge *e;
 287   scalar_t d;
 288
 289   for(int k = 0; k < _nb_vertices; k++) {
 290     _vertices[k].distance_from_source = FLT_MAX;
 291     _vertices[k].pred_edge_toward_source = 0;
 292   }
 293
 294   _heap_size = _nb_vertices;
 295   _source->distance_from_source = 0;
 296   _source->decrease_distance_in_heap(_heap);
 297
 298   do {
 299     // Get the closest to the source
 300     v = _heap[0];
 301
 302     // Remove it from the heap (swap it with the last_slot in the heap, and
 303     // update the distance of that one)
 304     _heap_size--;
 305     last_slot = _heap + _heap_size;
 306     swap(*_heap, *last_slot); swap((*_heap)->heap_slot, (*last_slot)->heap_slot);
 307     _heap[0]->increase_distance_in_heap(_heap, _heap + _heap_size);
 308
 309     // Now update the neighbors of the node currently closest to the
 310     // source
 311     for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 312       d = v->distance_from_source + e->positivized_length;
 313       tv = e->terminal_vertex;
 314       if(d < tv->distance_from_source) {
 315         ASSERT(tv->heap_slot - _heap < _heap_size);
 316         tv->distance_from_source = d;
 317         tv->pred_edge_toward_source = e;
 318         tv->decrease_distance_in_heap(_heap);
 319       }
 320     }
 321   } while(_heap_size > 0);
 322 }
 323
 324 void MTPGraph::find_best_paths(scalar_t *lengths) {
 325   scalar_t shortest_path_length;
 326   Vertex *v;
 327   Edge *e;
 328
 329   for(int e = 0; e < _nb_edges; e++) {
 330     _edges[e].length = lengths[e];
 331     _edges[e].occupied = 0;
 332     _edges[e].positivized_length = _edges[e].length;
 333   }
 334
 335   // Compute the distance of all the nodes from the source by just
 336   // visiting them in the proper DAG ordering we computed when
 337   // building the graph
 338   dp_compute_distances();
 339
 340   do {
 341     // Use the current distance from the source to make all edge
 342     // lengths positive
 343     update_positivized_lengths();
 344     // Fix numerical errors
 345     force_positivized_lengths();
 346
 347     find_shortest_path();
 348
 349     shortest_path_length = 0.0;
 350
 351     // Do we reach the sink?
 352     if(_sink->pred_edge_toward_source) {
 353       // If yes, compute the length of the best path according to the
 354       // original edge lengths
 355       v = _sink;
 356       while(v->pred_edge_toward_source) {
 357         shortest_path_length += v->pred_edge_toward_source->length;
 358         v = v->pred_edge_toward_source->origin_vertex;
 359       }
 360       // If that length is negative
 361       if(shortest_path_length < 0.0) {
 362 #ifdef VERBOSE
 363         cerr << __FILE__ << ": Found a path of length " << shortest_path_length << endl;
 364 #endif
 365         // Invert all the edges along the best path
 366         v = _sink;
 367         while(v->pred_edge_toward_source) {
 368           e = v->pred_edge_toward_source;
 369           v = e->origin_vertex;
 370           e->invert();
 371           // This is the only place where we change the occupations of
 372           // edges
 373           e->occupied = 1 - e->occupied;
 374         }
 375       }
 376     }
 377
 378   } while(shortest_path_length < 0.0);
 379
 380   // Put back the graph in its original state (i.e. invert edges which
 381   // have been inverted in the process)
 382   for(int k = 0; k < _nb_edges; k++) {
 383     e = &_edges[k];
 384     if(e->occupied) { e->invert(); }
 385   }
 386 }
 387
 388 int MTPGraph::retrieve_one_path(Edge *e, Path *path) {
 389   Edge *f, *next = 0;
 390   int l = 0, nb_occupied_next;
 391
 392   if(path) {
 393     path->nodes[l++] = int(e->origin_vertex - _vertices);
 394     path->length = e->length;
 395   } else l++;
 396
 397   while(e->terminal_vertex != _sink) {
 398     if(path) {
 399       path->nodes[l++] = int(e->terminal_vertex - _vertices);
 400       path->length += e->length;
 401     } else l++;
 402
 403     nb_occupied_next = 0;
 404     for(f = e->terminal_vertex->leaving_edge_list_root; f; f = f->next_leaving_edge) {
 405       if(f->occupied) { nb_occupied_next++; next = f; }
 406     }
 407
 408 #ifdef DEBUG
 409     if(nb_occupied_next == 0) {
 410       cerr << __FILE__ << ": retrieve_one_path: Non-sink end point." << endl;
 411       abort();
 412     }
 413
 414     else if(nb_occupied_next > 1) {
 415       cerr << __FILE__ << ": retrieve_one_path: Non node-disjoint paths." << endl;
 416       abort();
 417     }
 418 #endif
 419
 420     e = next;
 421   }
 422
 423   if(path) {
 424     path->nodes[l++] = int(e->terminal_vertex - _vertices);
 425     path->length += e->length;
 426   } else l++;
 427
 428   return l;
 429 }
 430
 431 //////////////////////////////////////////////////////////////////////
 432
 433 void MTPGraph::compute_dp_ordering() {
 434   Vertex *v;
 435   Edge *e;
 436   int tv;
 437
 438   // This procedure computes for each node the longest link from the
 439   // source, and abort if the graph is not a DAG, and order the node
 440   // in _dp_order according to that value.
 441
 442   int *nb_predecessors = new int[_nb_vertices];
 443
 444   Vertex **already_processed = _dp_order, **front = _dp_order, **new_front = _dp_order;
 445
 446   for(int k = 0; k < _nb_vertices; k++) {
 447     nb_predecessors[k] = 0;
 448   }
 449
 450   for(int k = 0; k < _nb_vertices; k++) {
 451     v = &_vertices[k];
 452     for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 453       tv = int(e->terminal_vertex - _vertices);
 454       nb_predecessors[tv]++;
 455     }
 456   }
 457
 458   for(int k = 0; k < _nb_vertices; k++) {
 459     if(nb_predecessors[k] == 0) {
 460       *(front++) = _vertices + k;
 461     }
 462   }
 463
 464   scalar_t rank = 1;
 465   while(already_processed < front) {
 466     new_front = front;
 467     while(already_processed < front) {
 468       v = *(already_processed++);
 469       v->distance_from_source = rank;
 470       for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 471         tv = int(e->terminal_vertex - _vertices);
 472         nb_predecessors[tv]--;
 473         ASSERT(nb_predecessors[tv] >= 0);
 474         if(nb_predecessors[tv] == 0) {
 475           *(new_front++) = e->terminal_vertex;
 476         }
 477       }
 478     }
 479     front = new_front;
 480     rank++;
 481   }
 482
 483   if(already_processed < _dp_order + _nb_vertices) {
 484     cerr << __FILE__ << ": The graph is not a DAG." << endl;
 485     abort();
 486   }
 487
 488   delete[] nb_predecessors;
 489
 490   for(int v = 0; v < _nb_vertices; v++) { _dp_order[v] = &_vertices[v]; }
 491   qsort(_dp_order, _nb_vertices, sizeof(Vertex *), compare_vertices_on_distance);
 492 }
 493
 494 //////////////////////////////////////////////////////////////////////
 495
 496 void MTPGraph::retrieve_disjoint_paths() {
 497   Edge *e;
 498   int p, l;
 499
 500   for(int p = 0; p < nb_paths; p++) delete paths[p];
 501   delete[] paths;
 502
 503   nb_paths = 0;
 504   for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 505     if(e->occupied) { nb_paths++; }
 506   }
 507
 508   paths = new Path *[nb_paths];
 509
 510   p = 0;
 511   for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
 512     if(e->occupied) {
 513       l = retrieve_one_path(e, 0);
 514       paths[p] = new Path(l);
 515       retrieve_one_path(e, paths[p]);
 516       p++;
 517     }
 518   }
 519 }