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