Moved all the global variables into Global global;
[mtp.git] / mtp_graph.cc
index 2832e71..dc38321 100644 (file)
@@ -24,6 +24,7 @@
 
 #include "mtp_graph.h"
 
+#include <cmath>
 #include <float.h>
 
 using namespace std;
@@ -43,9 +44,10 @@ public:
 
 class Vertex {
 public:
-  Edge *leaving_edges;
   scalar_t distance_from_source;
   Edge *pred_edge_toward_source;
+
+  Edge *leaving_edge_list_root;
   Vertex **heap_slot;
 
   Vertex();
@@ -53,7 +55,7 @@ public:
   inline void add_leaving_edge(Edge *e);
   inline void del_leaving_edge(Edge *e);
   inline void decrease_distance_in_heap(Vertex **heap);
-  inline void increase_distance_in_heap(Vertex **heap, int heap_size);
+  inline void increase_distance_in_heap(Vertex **heap, Vertex **heap_bottom);
 };
 
 //////////////////////////////////////////////////////////////////////
@@ -69,19 +71,21 @@ void Edge::invert() {
 //////////////////////////////////////////////////////////////////////
 
 Vertex::Vertex() {
-  leaving_edges = 0;
+  leaving_edge_list_root = 0;
 }
 
 void Vertex::add_leaving_edge(Edge *e) {
-  e->next_leaving_edge = leaving_edges;
+  e->next_leaving_edge = leaving_edge_list_root;
   e->pred_leaving_edge = 0;
-  if(leaving_edges) { leaving_edges->pred_leaving_edge = e; }
-  leaving_edges = e;
+  if(leaving_edge_list_root) {
+    leaving_edge_list_root->pred_leaving_edge = e;
+  }
+  leaving_edge_list_root = e;
 }
 
 void Vertex::del_leaving_edge(Edge *e) {
-  if(e == leaving_edges) {
-    leaving_edges = e->next_leaving_edge;
+  if(e == leaving_edge_list_root) {
+    leaving_edge_list_root = e->next_leaving_edge;
   }
   if(e->pred_leaving_edge) {
     e->pred_leaving_edge->next_leaving_edge = e->next_leaving_edge;
@@ -104,18 +108,18 @@ void Vertex::decrease_distance_in_heap(Vertex **heap) {
   }
 }
 
-void Vertex::increase_distance_in_heap(Vertex **heap, int heap_size) {
+void Vertex::increase_distance_in_heap(Vertex **heap, Vertex **heap_bottom) {
   Vertex **c1, **c2, **h;
   // omg, that's beautiful
   h = heap_slot;
   while(c1 = heap + 2 * (h - heap) + 1,
-        c1 < heap + heap_size &&
+        c1 < heap_bottom &&
         (c2 = c1 + 1,
          (*c1)->distance_from_source < (*h)->distance_from_source
          ||
-         (c2 < heap + heap_size && (*c2)->distance_from_source < (*h)->distance_from_source)
+         (c2 < heap_bottom && (*c2)->distance_from_source < (*h)->distance_from_source)
          )) {
-    if(c2 < heap + heap_size && (*c2)->distance_from_source <= (*c1)->distance_from_source) {
+    if(c2 < heap_bottom && (*c2)->distance_from_source <= (*c1)->distance_from_source) {
       swap(*c2, *h);
       swap((*c2)->heap_slot, (*h)->heap_slot);
       h = c2;
@@ -129,7 +133,7 @@ void Vertex::increase_distance_in_heap(Vertex **heap, int heap_size) {
 
 //////////////////////////////////////////////////////////////////////
 
-static int compare_vertex(const void *v1, const void *v2) {
+static int compare_vertices_on_distance(const void *v1, const void *v2) {
   scalar_t delta =
     (*((Vertex **) v1))->distance_from_source -
     (*((Vertex **) v2))->distance_from_source;
@@ -138,6 +142,8 @@ static int compare_vertex(const void *v1, const void *v2) {
   else return 0;
 }
 
+//////////////////////////////////////////////////////////////////////
+
 MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
                    int *vertex_from, int *vertex_to,
                    int source, int sink) {
@@ -167,16 +173,9 @@ MTPGraph::MTPGraph(int nb_vertices, int nb_edges,
   paths = 0;
   nb_paths = 0;
 
-  if(compute_dp_ranks()) {
-    // Here the distance_from_source field of every vertex is the
-    // number of DP iterations needed to update it. Hence we only have
-    // to process the vertex in that order.
-    for(int v = 0; v < _nb_vertices; v++) { _dp_order[v] = &_vertices[v]; }
-    qsort(_dp_order, _nb_vertices, sizeof(Vertex *), compare_vertex);
-  } else {
-    cerr << __FILE__ << ": This graph is not a DAG." << endl;
-    abort();
-  }
+  compute_dp_ranks();
+  for(int v = 0; v < _nb_vertices; v++) { _dp_order[v] = &_vertices[v]; }
+  qsort(_dp_order, _nb_vertices, sizeof(Vertex *), compare_vertices_on_distance);
 }
 
 MTPGraph::~MTPGraph() {
@@ -190,17 +189,73 @@ MTPGraph::~MTPGraph() {
 
 //////////////////////////////////////////////////////////////////////
 
+void MTPGraph::compute_dp_ranks() {
+  Vertex *v;
+  Edge *e;
+
+  // This procedure computes for each node the longest link from the
+  // source and abort if the graph is not a DAG. It works by removing
+  // successively nodes without predecessor: At the first iteration it
+  // removes the source, then the nodes with incoming edge only from
+  // the source, etc. If it can remove all the nodes that way, the
+  // graph is a DAG. If at some point it can not remove node anymore
+  // and there are some remaining nodes, the graph is not a DAG. The
+  // rank of a node is the iteration at which is it removed, and we
+  // set the distance_from_source fields to this value.
+
+  Vertex **with_predecessor = new Vertex *[_nb_vertices];
+
+  // All the nodes are with_predecessor at first
+  for(int k = 0; k < _nb_vertices; k++) {
+    _vertices[k].distance_from_source = 0;
+    with_predecessor[k] = &_vertices[k];
+  }
+
+  scalar_t rank = 1;
+  int nb_with_predecessor = _nb_vertices, pred_nb_with_predecessor;
+
+  do {
+    // We set the distance_from_source field of all the vertices with incoming
+    // edges to the current rank value
+    for(int f = 0; f < nb_with_predecessor; f++) {
+      v = with_predecessor[f];
+      for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
+        e->terminal_vertex->distance_from_source = rank;
+      }
+    }
+
+    pred_nb_with_predecessor = nb_with_predecessor;
+    nb_with_predecessor = 0;
+
+    // We keep all the vertices with incoming nodes
+    for(int f = 0; f < pred_nb_with_predecessor; f++) {
+      v = with_predecessor[f];
+      if(v->distance_from_source == rank) {
+        with_predecessor[nb_with_predecessor++] = v;
+      }
+    }
+
+    rank++;
+  } while(nb_with_predecessor < pred_nb_with_predecessor);
+
+  delete[] with_predecessor;
+
+  if(nb_with_predecessor > 0) {
+    cerr << __FILE__ << ": The graph is not a DAG." << endl;
+    abort();
+  }
+}
+
+//////////////////////////////////////////////////////////////////////
+
 void MTPGraph::print(ostream *os) {
   for(int k = 0; k < _nb_edges; k++) {
     Edge *e = _edges + k;
     (*os) << e->origin_vertex - _vertices
-         << " -> "
-         << e->terminal_vertex - _vertices
-         << " "
-         << e->length;
-    if(e->occupied) {
-      (*os) << " *";
-    }
+          << " -> "
+          << e->terminal_vertex - _vertices
+          << " (" << e->length << ")";
+    if(e->occupied) { (*os) << " *"; }
     (*os) << endl;
   }
 }
@@ -246,7 +301,6 @@ void MTPGraph::force_positivized_lengths() {
     Edge *e = _edges + k;
 
     if(e->positivized_length < 0) {
-
 #ifdef VERBOSE
       residual_error -= e->positivized_length;
       max_error = max(max_error, - e->positivized_length);
@@ -259,60 +313,6 @@ void MTPGraph::force_positivized_lengths() {
 #endif
 }
 
-int MTPGraph::compute_dp_ranks() {
-  Vertex *v;
-  Edge *e;
-
-  // This procedure computes for each node the longest link from the
-  // source and abort if the graph is not a DAG. It works by removing
-  // successively nodes without predecessor: At the first iteration it
-  // removes the source, then the nodes with incoming edge only from
-  // the source, etc. If it can remove all the nodes that way, the
-  // graph is a DAG. If at some point it can not remove node anymore
-  // and there are some remaining nodes, the graph is not a DAG. The
-  // rank of a node is the iteration at which is it removed, and we
-  // set the distance_from_source fields to this value.
-
-  Vertex **active = new Vertex *[_nb_vertices];
-
-  // All the nodes are active at first
-  for(int k = 0; k < _nb_vertices; k++) {
-    _vertices[k].distance_from_source = 0;
-    active[k] = &_vertices[k];
-  }
-
-  scalar_t rank = 1;
-  int nb_active = _nb_vertices, pred_nb_active;
-
-  do {
-    // We set the distance_from_source field of all the vertices with incoming
-    // edges to the current rank value
-    for(int f = 0; f < nb_active; f++) {
-      v = active[f];
-      for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
-        e->terminal_vertex->distance_from_source = rank;
-      }
-    }
-
-    pred_nb_active = nb_active;
-    nb_active = 0;
-
-    // We keep all the vertices with incoming nodes
-    for(int f = 0; f < pred_nb_active; f++) {
-      v = active[f];
-      if(v->distance_from_source == rank) {
-        active[nb_active++] = v;
-      }
-    }
-
-    rank++;
-  } while(nb_active < pred_nb_active);
-
-  delete[] active;
-
-  return nb_active == 0;
-}
-
 void MTPGraph::dp_compute_distances() {
   Vertex *v, *tv;
   Edge *e;
@@ -327,13 +327,12 @@ void MTPGraph::dp_compute_distances() {
 
   for(int k = 0; k < _nb_vertices; k++) {
     v = _dp_order[k];
-    for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
+    for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
       d = v->distance_from_source + e->positivized_length;
       tv = e->terminal_vertex;
       if(d < tv->distance_from_source) {
         tv->distance_from_source = d;
         tv->pred_edge_toward_source = e;
-        tv->decrease_distance_in_heap(_heap);
       }
     }
   }
@@ -344,7 +343,7 @@ void MTPGraph::dp_compute_distances() {
 // pred_edge_toward_source.
 
 void MTPGraph::find_shortest_path() {
-  Vertex *v, *tv, **a, **b;
+  Vertex *v, *tv, **last_slot;
   Edge *e;
   scalar_t d;
 
@@ -361,16 +360,16 @@ void MTPGraph::find_shortest_path() {
     // Get the closest to the source
     v = _heap[0];
 
-    // Remove it from the heap (swap it with the last in the heap, and
+    // Remove it from the heap (swap it with the last_slot in the heap, and
     // update the distance of that one)
     _heap_size--;
-    a = _heap;
-    b = _heap + _heap_size;
-    swap(*a, *b); swap((*a)->heap_slot, (*b)->heap_slot);
-    _heap[0]->increase_distance_in_heap(_heap, _heap_size);
+    last_slot = _heap + _heap_size;
+    swap(*_heap, *last_slot); swap((*_heap)->heap_slot, (*last_slot)->heap_slot);
+    _heap[0]->increase_distance_in_heap(_heap, _heap + _heap_size);
 
-    // Now update the neighbors of the currently closest to the source
-    for(e = v->leaving_edges; e; e = e->next_leaving_edge) {
+    // Now update the neighbors of the node currently closest to the
+    // source
+    for(e = v->leaving_edge_list_root; e; e = e->next_leaving_edge) {
       d = v->distance_from_source + e->positivized_length;
       tv = e->terminal_vertex;
       if(d < tv->distance_from_source) {
@@ -384,7 +383,7 @@ void MTPGraph::find_shortest_path() {
 }
 
 void MTPGraph::find_best_paths(scalar_t *lengths) {
-  scalar_t total_length;
+  scalar_t shortest_path_length;
   Vertex *v;
   Edge *e;
 
@@ -394,15 +393,21 @@ void MTPGraph::find_best_paths(scalar_t *lengths) {
     _edges[e].positivized_length = _edges[e].length;
   }
 
-  // Update the distances to the source in "good order"
+  // Compute the distance of all the nodes from the source by just
+  // visiting them in the proper DAG ordering we computed when
+  // building the graph
   dp_compute_distances();
 
   do {
+    // Use the current distance from the source to make all edge
+    // lengths positive
     update_positivized_lengths();
+    // Fix numerical errors
     force_positivized_lengths();
+
     find_shortest_path();
 
-    total_length = 0.0;
+    shortest_path_length = 0.0;
 
     // Do we reach the sink?
     if(_sink->pred_edge_toward_source) {
@@ -410,13 +415,13 @@ void MTPGraph::find_best_paths(scalar_t *lengths) {
       // original edge lengths
       v = _sink;
       while(v->pred_edge_toward_source) {
-        total_length += v->pred_edge_toward_source->length;
+        shortest_path_length += v->pred_edge_toward_source->length;
         v = v->pred_edge_toward_source->origin_vertex;
       }
       // If that length is negative
-      if(total_length < 0.0) {
+      if(shortest_path_length < 0.0) {
 #ifdef VERBOSE
-        cerr << __FILE__ << ": Found a path of length " << total_length << endl;
+        cerr << __FILE__ << ": Found a path of length " << shortest_path_length << endl;
 #endif
         // Invert all the edges along the best path
         v = _sink;
@@ -431,7 +436,7 @@ void MTPGraph::find_best_paths(scalar_t *lengths) {
       }
     }
 
-  } while(total_length < 0.0);
+  } while(shortest_path_length < 0.0);
 
   // Put back the graph in its original state (i.e. invert edges which
   // have been inverted in the process)
@@ -457,7 +462,7 @@ int MTPGraph::retrieve_one_path(Edge *e, Path *path) {
     } else l++;
 
     nb_occupied_next = 0;
-    for(f = e->terminal_vertex->leaving_edges; f; f = f->next_leaving_edge) {
+    for(f = e->terminal_vertex->leaving_edge_list_root; f; f = f->next_leaving_edge) {
       if(f->occupied) { nb_occupied_next++; next = f; }
     }
 
@@ -492,14 +497,14 @@ void MTPGraph::retrieve_disjoint_paths() {
   delete[] paths;
 
   nb_paths = 0;
-  for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
+  for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
     if(e->occupied) { nb_paths++; }
   }
 
   paths = new Path *[nb_paths];
 
   p = 0;
-  for(e = _source->leaving_edges; e; e = e->next_leaving_edge) {
+  for(e = _source->leaving_edge_list_root; e; e = e->next_leaving_edge) {
     if(e->occupied) {
       l = retrieve_one_path(e, 0);
       paths[p] = new Path(l);