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 revert();
  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::revert() {
  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 Path::Path(int l) {
  87   length = l;
  88   nodes = new int[length];
  89 }
  90
  91 Path::~Path() {
  92   delete[] nodes;
  93 }
  94
  95 //////////////////////////////////////////////////////////////////////
  96
  97 MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
  98                    int *from, int *to,
  99                    int source, int sink) {
 100   _nb_vertices = nb_vertices;
 101   _nb_edges = nb_edges;
 102
 103   _edges = new Edge[_nb_edges];
 104   _vertices = new Vertex[_nb_vertices];
 105   _front = new Vertex *[_nb_vertices];
 106   _new_front = new Vertex *[_nb_vertices];
 107
 108   _source = &_vertices[source];
 109   _sink = &_vertices[sink];
 110
 111   for(int v = 0; v < _nb_vertices; v++) {
 112     _vertices[v].id = v;
 113   }
 114
 115   for(int e = 0; e < nb_edges; e++) {
 116     _vertices[from[e]].add_edge(_edges + e);
 117     _edges[e].occupied = 0;
 118     _edges[e].id = e;
 119     _edges[e].origin_vertex = _vertices + from[e];
 120     _edges[e].terminal_vertex = _vertices + to[e];
 121   }
 122
 123   paths = 0;
 124   nb_paths = 0;
 125 }
 126
 127 MTPGraph::~MTPGraph() {
 128   delete[] _vertices;
 129   delete[] _edges;
 130   delete[] _front;
 131   delete[] _new_front;
 132   for(int p = 0; p < nb_paths; p++) delete paths[p];
 133   delete[] paths;
 134 }
 135
 136 //////////////////////////////////////////////////////////////////////
 137
 138 void MTPGraph::print(ostream *os) {
 139   for(int k = 0; k < _nb_edges; k++) {
 140     Edge *e = _edges + k;
 141     (*os) << e->origin_vertex->id
 142          << " -> "
 143          << e->terminal_vertex->id
 144          << " "
 145          << e->length;
 146     if(e->occupied) {
 147       (*os) << " *";
 148     }
 149     (*os) << endl;
 150   }
 151 }
 152
 153 void MTPGraph::print_dot(ostream *os) {
 154   (*os) << "digraph {" << endl;
 155   (*os) << "  node[shape=circle];" << endl;
 156   for(int k = 0; k < _nb_edges; k++) {
 157     Edge *e = _edges + k;
 158     if(e->occupied) {
 159       (*os) << "  " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
 160            << " [style=bold,color=black,label=\"" << e->length << "\"];" << endl;
 161     } else {
 162       (*os) << "  " << e->origin_vertex->id << " -> " << e->terminal_vertex->id
 163            << " [color=gray,label=\"" << e->length << "\"];" << endl;
 164     }
 165   }
 166   (*os) << "}" << endl;
 167 }
 168
 169 //////////////////////////////////////////////////////////////////////
 170
 171 void MTPGraph::initialize_positivized_lengths_with_min() {
 172   scalar_t length_min = 0;
 173   for(int n = 0; n < _nb_vertices; n++) {
 174     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
 175       length_min = min(e->length, length_min);
 176     }
 177   }
 178   for(int n = 0; n < _nb_vertices; n++) {
 179     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
 180       e->positivized_length = e->length - length_min;
 181     }
 182   }
 183 }
 184
 185 void MTPGraph::update_positivized_lengths() {
 186   for(int k = 0; k < _nb_edges; k++) {
 187     Edge *e = _edges + k;
 188     e->positivized_length += e->terminal_vertex->distance_from_source - e->terminal_vertex->distance_from_source;
 189   }
 190 }
 191
 192 void MTPGraph::force_positivized_lengths() {
 193 #ifdef VERBOSE
 194   scalar_t residual_error = 0.0;
 195 #endif
 196   for(int n = 0; n < _nb_vertices; n++) {
 197     for(Edge *e = _vertices[n].leaving_edges; e; e = e->next_leaving_edge) {
 198       if(e->positivized_length < 0) {
 199 #ifdef VERBOSE
 200         residual_error -= e->positivized_length;
 201 #endif
 202         e->positivized_length = 0.0;
 203       }
 204     }
 205   }
 206 #ifdef VERBOSE
 207   cerr << "residual_error " << residual_error << endl;
 208 #endif
 209 }
 210
 211 // This method does not change the edge occupation. It update
 212 // distance_from_source and best_pred_edge_to_source.
 213 void MTPGraph::find_shortest_path(Vertex **_front, Vertex **_new_front) {
 214   Vertex **tmp_front;
 215   int tmp_front_size;
 216   Vertex *v, *tv;
 217   Edge *e;
 218   scalar_t d;
 219
 220   for(int v = 0; v < _nb_vertices; v++) {
 221     _vertices[v].distance_from_source = FLT_MAX;
 222     _vertices[v].best_pred_edge_to_source = 0;
 223     _vertices[v].iteration = 0;
 224   }
 225
 226   int iteration = 0;
 227
 228   int _front_size = 0, _new_front_size;
 229   _front[_front_size++] = _source;
 230   _source->distance_from_source = 0;
 231
 232   do {
 233     _new_front_size = 0;
 234     iteration++;
 235     for(int f = 0; f < _front_size; f++) {
 236       v = _front[f];
 237       for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
 238         d = v->distance_from_source + e->positivized_length;
 239         tv = e->terminal_vertex;
 240         if(d < tv->distance_from_source) {
 241           tv->distance_from_source = d;
 242           tv->best_pred_edge_to_source = e;
 243           if(tv->iteration < iteration) {
 244             _new_front[_new_front_size++] = tv;
 245             tv->iteration = iteration;
 246           }
 247         }
 248       }
 249     }
 250
 251     tmp_front = _new_front;
 252     _new_front = _front;
 253     _front = tmp_front;
 254
 255     tmp_front_size = _new_front_size;
 256     _new_front_size = _front_size;
 257     _front_size = tmp_front_size;
 258   } while(_front_size > 0);
 259 }
 260
 261 void MTPGraph::find_best_paths(scalar_t *lengths) {
 262   scalar_t total_length;
 263   Vertex *v;
 264   Edge *e;
 265
 266   for(int e = 0; e < _nb_edges; e++) {
 267     _edges[e].length = lengths[e];
 268     _edges[e].occupied = 0;
 269     _edges[e].positivized_length = _edges[e].length;
 270   }
 271
 272   // We use one iteration of find_shortest_path simply to propagate
 273   // the distance to make all the edge lengths positive.
 274   find_shortest_path(_front, _new_front);
 275   update_positivized_lengths();
 276
 277   // #warning
 278   // initialize_positivized_lengths_with_min();
 279
 280   do {
 281     force_positivized_lengths();
 282     find_shortest_path(_front, _new_front);
 283     update_positivized_lengths();
 284
 285     total_length = 0.0;
 286
 287     // Do we reach the _sink?
 288     if(_sink->best_pred_edge_to_source) {
 289       // If yes, compute the length of the best path
 290       v = _sink;
 291       while(v->best_pred_edge_to_source) {
 292         total_length += v->best_pred_edge_to_source->length;
 293         v = v->best_pred_edge_to_source->origin_vertex;
 294       }
 295       // If that length is negative
 296       if(total_length < 0.0) {
 297 #ifdef VERBOSE
 298         cerr << "Found a path of length " << total_length << endl;
 299 #endif
 300         // Invert all the edges along the best path
 301         v = _sink;
 302         while(v->best_pred_edge_to_source) {
 303           e = v->best_pred_edge_to_source;
 304           v = e->origin_vertex;
 305           e->revert();
 306           // This is the only place where we change the occupations of
 307           // edges
 308           e->occupied = 1 - e->occupied;
 309         }
 310       }
 311     }
 312
 313   } while(total_length < 0.0);
 314
 315   for(int k = 0; k < _nb_edges; k++) {
 316     Edge *e = _edges + k;
 317     if(e->occupied) { e->revert(); }
 318   }
 319 }
 320
 321 int MTPGraph::retrieve_one_path(Edge *e, int *nodes) {
 322   Edge *f, *next;
 323   int l = 0;
 324
 325   if(nodes) { nodes[l++] = e->origin_vertex->id; }
 326   else l++;
 327
 328   while(e->terminal_vertex != _sink) {
 329     if(nodes) { nodes[l++] = e->terminal_vertex->id; }
 330     else l++;
 331     int nb_choices = 0;
 332     for(f = e->terminal_vertex->leaving_edges; f; f = f->next_leaving_edge) {
 333       if(f->occupied) { nb_choices++; next = f; }
 334       if(nb_choices == 0) {
 335         cerr << "Non-sink path end point?!" << endl;
 336         abort();
 337       }
 338       if(nb_choices > 1) {
 339         cerr << "Non node-disjoint path, can not retrieve." << endl;
 340         abort();
 341       }
 342     }
 343     e = next;
 344   }
 345
 346   if(nodes) { nodes[l++] = e->terminal_vertex->id; }
 347   else l++;
 348
 349   return l;
 350 }
 351
 352 void MTPGraph::retrieve_disjoint_paths() {
 353   Edge *e;
 354
 355   for(int p = 0; p < nb_paths; p++) delete paths[p];
 356   delete[] paths;
 357
 358   nb_paths = 0;
 359   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
 360     if(e->occupied) { nb_paths++; }
 361   }
 362
 363   paths = new Path *[nb_paths];
 364
 365   int p = 0;
 366   for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
 367     if(e->occupied) {
 368       int l = retrieve_one_path(e, 0);
 369       paths[p] = new Path(l);
 370       retrieve_one_path(e, paths[p]->nodes);
 371       p++;
 372     }
 373   }
 374 }