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 <iostream>
  28 #include <float.h>
  29 #include <stdlib.h>
  30
  31 using namespace std;
  32
  33 class Edge {
  34 public:
  35   int id, occupied;
  36   scalar_t length, positivized_length;
  37   Vertex *origin_vertex, *terminal_vertex;
  38
  39   // These are the links in the origin_vertex leaving edge list
  40   Edge *next_leaving_edge, *pred_leaving_edge;
  41
  42   inline void invert();
  43 };
  44
  45 class Vertex {
  46 public:
  47   int id;
  48   Edge *leaving_edges;
  49   scalar_t distance_from_source;
  50   Edge *pred_edge_toward_source;
  51
  52   int iteration; // Used in find_shortest_path to know if we already
  53                  // added this vertex to the front
  54   Vertex();
  55   inline void add_leaving_edge(Edge *e);
  56   inline void del_leaving_edge(Edge *e);
  57 };
  58
  59 //////////////////////////////////////////////////////////////////////
  60
  61 void Edge::invert() {
  62   length = - length;
  63   positivized_length = 0;
  64   origin_vertex->del_leaving_edge(this);
  65   terminal_vertex->add_leaving_edge(this);
  66   Vertex *t = terminal_vertex;
  67   terminal_vertex = origin_vertex;
  68   origin_vertex = t;
  69 }
  70
  71 //////////////////////////////////////////////////////////////////////
  72
  73 Vertex::Vertex() {
  74   leaving_edges = 0;
  75 }
  76
  77 void Vertex::add_leaving_edge(Edge *e) {
  78   e->next_leaving_edge = leaving_edges;
  79   e->pred_leaving_edge = 0;
  80   if(leaving_edges) { leaving_edges->pred_leaving_edge = e; }
  81   leaving_edges = e;
  82 }
  83
  84 void Vertex::del_leaving_edge(Edge *e) {
  85   if(e == leaving_edges) {
  86     leaving_edges = e->next_leaving_edge;
  87   }
  88   if(e->pred_leaving_edge) {
  89     e->pred_leaving_edge->next_leaving_edge = e->next_leaving_edge;
  90   }
  91   if(e->next_leaving_edge) {
  92     e->next_leaving_edge->pred_leaving_edge = e->pred_leaving_edge;
  93   }
  94 }
  95
  96 //////////////////////////////////////////////////////////////////////
  97
  98 MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
  99                    int *vertex_from, int *vertex_to,
 100                    int source, int sink) {
 101   _nb_vertices = nb_vertices;
 102   _nb_edges = nb_edges;
 103
 104   _edges = new Edge[_nb_edges];
 105   _vertices = new Vertex[_nb_vertices];
 106   _front = new Vertex *[_nb_vertices];
 107   _new_front = new Vertex *[_nb_vertices];
 108
 109   _source = &_vertices[source];
 110   _sink = &_vertices[sink];
 111
 112   for(int k = 0; k < _nb_vertices; k++) {
 113     _vertices[k].id = k;
 114   }
 115
 116   for(int e = 0; e < nb_edges; e++) {
 117     _vertices[vertex_from[e]].add_leaving_edge(_edges + e);
 118     _edges[e].occupied = 0;
 119     _edges[e].id = e;
 120     _edges[e].origin_vertex = _vertices + vertex_from[e];
 121     _edges[e].terminal_vertex = _vertices + vertex_to[e];
 122   }
 123
 124   paths = 0;
 125   nb_paths = 0;
 126 }
 127
 128 MTPGraph::~MTPGraph() {
 129   delete[] _vertices;
 130   delete[] _edges;
 131   delete[] _front;
 132   delete[] _new_front;
 133   for(int p = 0; p < nb_paths; p++) delete paths[p];
 134   delete[] paths;
 135 }
 136
 137 //////////////////////////////////////////////////////////////////////
 138
 139 void MTPGraph::print(ostream *os) {
 140   for(int k = 0; k < _nb_edges; k++) {
 141     Edge *e = _edges + k;
 142     (*os) << e->origin_vertex->id
 143          << " -> "
 144          << e->terminal_vertex->id
 145          << " "
 146          << e->length;
 147     if(e->occupied) {
 148       (*os) << " *";
 149     }
 150     (*os) << endl;
 151   }
 152 }
 153
 154 void MTPGraph::print_dot(ostream *os) {
 155   (*os) << "digraph {" << endl;
 156   (*os) << "        node [shape=circle,width=0.75,fixedsize=true];" << endl;
 157   (*os) << "        edge [color=gray,arrowhead=open]" << endl;
 158   (*os) << "        " << _source->id << " [peripheries=2];" << endl;
 159   (*os) << "        " << _sink->id << " [peripheries=2];" << endl;
 160   for(int k = 0; k < _nb_edges; k++) {
 161     Edge *e = _edges + k;
 162     // (*os) << "  " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
 163     // << ";"
 164     // << endl;
 165     (*os) << "        " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
 166           << " [";
 167     if(e->occupied) {
 168       (*os) << "style=bold,color=black,";
 169     }
 170     (*os) << "label=\"" << e->length << "\"];" << endl;
 171   }
 172   (*os) << "}" << endl;
 173 }
 174
 175 //////////////////////////////////////////////////////////////////////
 176
 177 void MTPGraph::update_positivized_lengths() {
 178   for(int k = 0; k < _nb_edges; k++) {
 179     Edge *e = _edges + k;
 180     e->positivized_length +=
 181       e->origin_vertex->distance_from_source - e->terminal_vertex->distance_from_source;
 182   }
 183 }
 184
 185 void MTPGraph::force_positivized_lengths() {
 186 #ifdef VERBOSE
 187   scalar_t residual_error = 0.0;
 188   scalar_t max_error = 0.0;
 189 #endif
 190   for(int n = 0; n < _nb_vertices; n++) {
 191     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
 192       if(e->positivized_length < 0) {
 193 #ifdef VERBOSE
 194         residual_error -= e->positivized_length;
 195         max_error = max(max_error, - e->positivized_length);
 196 #endif
 197         e->positivized_length = 0.0;
 198       }
 199     }
 200   }
 201 #ifdef VERBOSE
 202   cerr << "residual_error " << residual_error << " max_error " << residual_error << endl;
 203 #endif
 204 }
 205
 206 int MTPGraph::is_dag() {
 207   Vertex *v, *tv;
 208   Edge *e;
 209
 210   // We put everybody in the front
 211   for(int k = 0; k < _nb_vertices; k++) {
 212     _vertices[k].iteration = 0;
 213     _front[k] = &_vertices[k];
 214   }
 215
 216   int front_size = _nb_vertices, nb_with_incoming;
 217   int iteration = 0;
 218   int new_front_size, pred_front_size;
 219
 220   do {
 221     iteration++;
 222     nb_with_incoming = 0;
 223
 224     // We set the iteration field of all vertex with incoming edges to
 225     // the current iteration value
 226     for(int f = 0; f < front_size; f++) {
 227       v = _front[f];
 228       for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
 229         tv = e->terminal_vertex;
 230         tv->iteration = iteration;
 231       }
 232     }
 233
 234     new_front_size = 0;
 235     // We remove all vertex without incoming edge
 236     for(int f = 0; f < front_size; f++) {
 237       v = _front[f];
 238       if(v->iteration == iteration) {
 239         _front[new_front_size++] = v;
 240       }
 241     }
 242
 243     pred_front_size = front_size;
 244     front_size = new_front_size;
 245   } while(front_size < pred_front_size);
 246
 247   return front_size == 0;
 248 }
 249
 250 // This method does not change the edge occupation. It update
 251 // distance_from_source and pred_edge_toward_source.
 252 void MTPGraph::find_shortest_path() {
 253   Vertex **tmp_front;
 254   int tmp_front_size;
 255   Vertex *v, *tv;
 256   Edge *e;
 257   scalar_t d;
 258
 259   for(int k = 0; k < _nb_vertices; k++) {
 260     _vertices[k].distance_from_source = FLT_MAX;
 261     _vertices[k].pred_edge_toward_source = 0;
 262     _vertices[k].iteration = 0;
 263   }
 264
 265   int iteration = 0;
 266
 267   int front_size = 0, new_front_size;
 268   _front[front_size++] = _source;
 269   _source->distance_from_source = 0;
 270
 271   do {
 272     new_front_size = 0;
 273     iteration++;
 274
 275     for(int f = 0; f < front_size; f++) {
 276       v = _front[f];
 277       for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
 278         d = v->distance_from_source + e->positivized_length;
 279         tv = e->terminal_vertex;
 280         if(d < tv->distance_from_source) {
 281           tv->distance_from_source = d;
 282           tv->pred_edge_toward_source = e;
 283           if(tv->iteration < iteration) {
 284             _new_front[new_front_size++] = tv;
 285             tv->iteration = iteration;
 286           }
 287         }
 288       }
 289     }
 290
 291     tmp_front = _new_front;
 292     _new_front = _front;
 293     _front = tmp_front;
 294
 295     tmp_front_size = new_front_size;
 296     new_front_size = front_size;
 297     front_size = tmp_front_size;
 298   } while(front_size > 0);
 299 }
 300
 301 void MTPGraph::find_best_paths(scalar_t *lengths) {
 302   scalar_t total_length;
 303   Vertex *v;
 304   Edge *e;
 305
 306   for(int e = 0; e < _nb_edges; e++) {
 307     _edges[e].length = lengths[e];
 308     _edges[e].occupied = 0;
 309     _edges[e].positivized_length = _edges[e].length;
 310   }
 311
 312   // Let's be a bit paranoid
 313   ASSERT(is_dag());
 314
 315   // We use one iteration of find_shortest_path simply to propagate
 316   // the distance to make all the edge lengths positive.
 317   find_shortest_path();
 318
 319   do {
 320     update_positivized_lengths();
 321     force_positivized_lengths();
 322     find_shortest_path();
 323
 324     total_length = 0.0;
 325
 326     // Do we reach the _sink?
 327     if(_sink->pred_edge_toward_source) {
 328       // If yes, compute the length of the best path
 329       v = _sink;
 330       while(v->pred_edge_toward_source) {
 331         total_length += v->pred_edge_toward_source->length;
 332         v = v->pred_edge_toward_source->origin_vertex;
 333       }
 334       // If that length is negative
 335       if(total_length < 0.0) {
 336 #ifdef VERBOSE
 337         cerr << "Found a path of length " << total_length << endl;
 338 #endif
 339         // Invert all the edges along the best path
 340         v = _sink;
 341         while(v->pred_edge_toward_source) {
 342           e = v->pred_edge_toward_source;
 343           v = e->origin_vertex;
 344           e->invert();
 345           // This is the only place where we change the occupations of
 346           // edges
 347           e->occupied = 1 - e->occupied;
 348         }
 349       }
 350     }
 351
 352   } while(total_length < 0.0);
 353
 354   // Put back the graph in its original state (i.e. invert edges which
 355   // have been inverted in the process)
 356   for(int k = 0; k < _nb_edges; k++) {
 357     Edge *e = _edges + k;
 358     if(e->occupied) { e->invert(); }
 359   }
 360 }
 361
 362 int MTPGraph::retrieve_one_path(Edge *e, Path *path) {
 363   Edge *f, *next = 0;
 364   int l = 0;
 365
 366   if(path) {
 367     path->nodes[l++] = e->origin_vertex->id;
 368     path->length = e->length;
 369   } else l++;
 370
 371   while(e->terminal_vertex != _sink) {
 372     if(path) {
 373       path->nodes[l++] = e->terminal_vertex->id;
 374       path->length += e->length;
 375     } else l++;
 376     int nb_choices = 0;
 377     for(f = e->terminal_vertex->leaving_edges; f; f = f->next_leaving_edge) {
 378       if(f->occupied) { nb_choices++; next = f; }
 379       if(nb_choices == 0) {
 380         cerr << "retrieve_one_path: Non-sink end point." << endl;
 381         abort();
 382       }
 383       if(nb_choices > 1) {
 384         cerr << "retrieve_one_path: Non node-disjoint paths." << endl;
 385         abort();
 386       }
 387     }
 388     e = next;
 389   }
 390
 391   if(path) {
 392     path->nodes[l++] = e->terminal_vertex->id;
 393     path->length += e->length;
 394   } else l++;
 395
 396   return l;
 397 }
 398
 399 void MTPGraph::retrieve_disjoint_paths() {
 400   Edge *e;
 401
 402   for(int p = 0; p < nb_paths; p++) delete paths[p];
 403   delete[] paths;
 404
 405   nb_paths = 0;
 406   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
 407     if(e->occupied) { nb_paths++; }
 408   }
 409
 410   paths = new Path *[nb_paths];
 411
 412   int p = 0;
 413   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
 414     if(e->occupied) {
 415       int l = retrieve_one_path(e, 0);
 416       paths[p] = new Path(l);
 417       retrieve_one_path(e, paths[p]);
 418       p++;
 419     }
 420   }
 421 }