Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Sorry need to be call here for compile warning.
[simgrid.git] / src / xbt / graph.c
index a0f5d9e..8fdec17 100644 (file)
@@ -1,9 +1,7 @@
-/*     $Id$     */
-
 /* a generic graph library.                                                 */
 
-/* Copyright (c) 2006 Darina Dimitrova, Arnaud Legrand.                     */
-/* All rights reserved.                                                     */
+/* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -60,7 +58,7 @@ xbt_node_t xbt_graph_new_node(xbt_graph_t g, void *data)
 
 /** @brief add an edge to the given graph */
 xbt_edge_t xbt_graph_new_edge(xbt_graph_t g,
-                             xbt_node_t src, xbt_node_t dst, void *data)
+                              xbt_node_t src, xbt_node_t dst, void *data)
 {
   xbt_edge_t edge = NULL;
 
@@ -68,7 +66,7 @@ xbt_edge_t xbt_graph_new_edge(xbt_graph_t g,
   xbt_dynar_push(src->out, &edge);
   if (g->directed)
     xbt_dynar_push(dst->in, &edge);
-  else                         /* only the "out" field is used */
+  else                          /* only the "out" field is used */
     xbt_dynar_push(dst->out, &edge);
 
   edge->data = data;
@@ -80,19 +78,22 @@ xbt_edge_t xbt_graph_new_edge(xbt_graph_t g,
   return edge;
 }
 
-xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst)
+xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src,
+                              xbt_node_t dst)
 {
   xbt_edge_t edge;
-  int cursor;
+  unsigned int cursor;
 
   xbt_dynar_foreach(src->out, cursor, edge) {
-    DEBUG3("%p = %p--%p",edge,edge->src,edge->dst);
-    if((edge->src==src) && (edge->dst==dst)) return edge;
+    XBT_DEBUG("%p = %p--%p", edge, edge->src, edge->dst);
+    if ((edge->src == src) && (edge->dst == dst))
+      return edge;
   }
-  if(!g->directed) {
+  if (!g->directed) {
     xbt_dynar_foreach(src->out, cursor, edge) {
-      DEBUG3("%p = %p--%p",edge,edge->src,edge->dst);
-      if((edge->dst==src) && (edge->src==dst)) return edge;
+      XBT_DEBUG("%p = %p--%p", edge, edge->src, edge->dst);
+      if ((edge->dst == src) && (edge->src == dst))
+        return edge;
     }
   }
   return NULL;
@@ -119,16 +120,19 @@ void xbt_graph_edge_set_data(xbt_edge_t edge, void *data)
 }
 
 /** @brief Destructor
- *  @param l: poor victim
+ *  @param g: poor victim
+ *  @param node_free_function: function to use to free data associated to each node
+ *  @param edge_free_function: function to use to free data associated to each edge
+ *  @param graph_free_function: function to use to free data associated to g
  *
- * Free the graph structure. 
+ * Free the graph structure.
  */
 void xbt_graph_free_graph(xbt_graph_t g,
-                         void node_free_function(void *ptr),
-                         void edge_free_function(void *ptr),
-                         void graph_free_function(void *ptr))
+                          void_f_pvoid_t node_free_function,
+                          void_f_pvoid_t edge_free_function,
+                          void_f_pvoid_t graph_free_function)
 {
-  int cursor = 0;
+  unsigned int cursor = 0;
   xbt_node_t node = NULL;
   xbt_edge_t edge = NULL;
 
@@ -137,12 +141,12 @@ void xbt_graph_free_graph(xbt_graph_t g,
     xbt_dynar_free(&(node->out));
     xbt_dynar_free(&(node->in));
     if (node_free_function)
-      node_free_function(node->data);
+      (*node_free_function) (node->data);
   }
 
   xbt_dynar_foreach(g->edges, cursor, edge) {
     if (edge_free_function)
-      edge_free_function(edge->data);
+      (*edge_free_function) (edge->data);
   }
 
   xbt_dynar_foreach(g->nodes, cursor, node)
@@ -152,21 +156,22 @@ void xbt_graph_free_graph(xbt_graph_t g,
   xbt_dynar_foreach(g->edges, cursor, edge)
       free(edge);
   xbt_dynar_free(&(g->edges));
-
+  if (graph_free_function)
+    (*graph_free_function) (g->data);
   free(g);
-
+  xbt_graph_parse_lex_destroy();
   return;
 }
 
 
 /** @brief remove the given node from the given graph */
 void xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
-                        void_f_pvoid_t * node_free_function,
-                        void_f_pvoid_t * edge_free_function)
+                         void_f_pvoid_t node_free_function,
+                         void_f_pvoid_t edge_free_function)
 {
   unsigned long nbr;
-  int i;
-  int cursor = 0;
+  unsigned long i;
+  unsigned int cursor = 0;
   xbt_node_t node = NULL;
   xbt_edge_t edge = NULL;
 
@@ -178,16 +183,16 @@ void xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
     if ((edge->dst == n) || (edge->src == n)) {
       xbt_graph_free_edge(g, edge, edge_free_function);
     } else
-      cursor ++;
+      cursor++;
   }
 
   if ((node_free_function) && (n->data))
-    node_free_function(n->data);
+    (*node_free_function) (n->data);
 
   cursor = 0;
   xbt_dynar_foreach(g->nodes, cursor, node)
-    if (node == n)
-      xbt_dynar_cursor_rm(g->nodes, &cursor);
+      if (node == n)
+    xbt_dynar_cursor_rm(g->nodes, &cursor);
 
   xbt_dynar_free(&(n->in));
   xbt_dynar_free(&(n->out));
@@ -199,23 +204,23 @@ void xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
 
 /** @brief remove the given edge from the given graph */
 void xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
-                        void free_function(void *ptr))
+                         void_f_pvoid_t free_function)
 {
   int idx;
-  int cursor = 0;
+  unsigned int cursor = 0;
   xbt_edge_t edge = NULL;
 
   if ((free_function) && (e->data))
-    free_function(e->data);
+    (*free_function) (e->data);
 
   xbt_dynar_foreach(g->edges, cursor, edge) {
     if (edge == e) {
       if (g->directed) {
-       idx = __xbt_find_in_dynar(edge->dst->in, edge);
-       xbt_dynar_remove_at(edge->dst->in, idx, NULL);
-      } else {                 /* only the out field is used */
-       idx = __xbt_find_in_dynar(edge->dst->out, edge);
-       xbt_dynar_remove_at(edge->dst->out, idx, NULL);
+        idx = __xbt_find_in_dynar(edge->dst->in, edge);
+        xbt_dynar_remove_at(edge->dst->in, idx, NULL);
+      } else {                  /* only the out field is used */
+        idx = __xbt_find_in_dynar(edge->dst->out, edge);
+        xbt_dynar_remove_at(edge->dst->out, idx, NULL);
       }
 
       idx = __xbt_find_in_dynar(edge->src->out, edge);
@@ -231,7 +236,7 @@ void xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
 int __xbt_find_in_dynar(xbt_dynar_t dynar, void *p)
 {
 
-  int cursor = 0;
+  unsigned int cursor = 0;
   void *tmp = NULL;
 
   xbt_dynar_foreach(dynar, cursor, tmp) {
@@ -256,7 +261,6 @@ xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g)
 /** @brief Retrieve the node at the source of the given edge */
 xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e)
 {
-
   return e->src;
 }
 
@@ -266,6 +270,11 @@ xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e)
   return e->dst;
 }
 
+/** @brief Retrieve the outgoing edges of the given node */
+xbt_dynar_t xbt_graph_node_get_outedges(xbt_node_t n)
+{
+  return n->out;
+}
 
 /** @brief Set the weight of the given edge */
 void xbt_graph_edge_set_length(xbt_edge_t e, double length)
@@ -281,14 +290,14 @@ double xbt_graph_edge_get_length(xbt_edge_t e)
 
 
 /** @brief construct the adjacency matrix corresponding to the given graph
- * 
+ *
  * The weights are the distances between nodes
  */
 double *xbt_graph_get_length_matrix(xbt_graph_t g)
 {
-  int cursor = 0;
-  int in_cursor = 0;
-  int idx, i;
+  unsigned int cursor = 0;
+  unsigned int in_cursor = 0;
+  unsigned long idx, i;
   unsigned long n;
   xbt_edge_t edge = NULL;
   xbt_node_t node = NULL;
@@ -309,9 +318,9 @@ double *xbt_graph_get_length_matrix(xbt_graph_t g)
 
     xbt_dynar_foreach(node->out, in_cursor, edge) {
       if (edge->dst == node)
-       idx = __xbt_find_in_dynar(g->nodes, edge->src);
-      else                     /*case of  undirected graphs */
-       idx = __xbt_find_in_dynar(g->nodes, edge->dst);
+        idx = __xbt_find_in_dynar(g->nodes, edge->src);
+      else                      /*case of  undirected graphs */
+        idx = __xbt_find_in_dynar(g->nodes, edge->dst);
       D(cursor, idx) = edge->length;
     }
   }
@@ -322,9 +331,9 @@ double *xbt_graph_get_length_matrix(xbt_graph_t g)
 }
 
 /** @brief Floyd-Warshall algorithm for shortest path finding
- * 
- * From wikipedia: 
- * 
+ *
+ * From wikipedia:
+ *
  * The Floyd–Warshall algorithm takes as input an adjacency matrix
  * representation of a weighted, directed graph (V, E). The weight of a
  * path between two vertices is the sum of the weights of the edges along
@@ -334,9 +343,9 @@ double *xbt_graph_get_length_matrix(xbt_graph_t g)
  * the two vertices. The running time complexity is Θ(|V|3).
  */
 void xbt_floyd_algorithm(xbt_graph_t g, double *adj, double *d,
-                        xbt_node_t * p)
+                         xbt_node_t * p)
 {
-  int i, j, k;
+  unsigned long i, j, k;
   unsigned long n;
   n = xbt_dynar_length(g->nodes);
 
@@ -351,7 +360,7 @@ void xbt_floyd_algorithm(xbt_graph_t g, double *adj, double *d,
   for (i = 0; i < n; i++) {
     for (j = 0; j < n; j++) {
       if (D(i, j) != -1) {
-       P(i, j) = *((xbt_node_t *) xbt_dynar_get_ptr(g->nodes, i));
+        P(i, j) = *((xbt_node_t *) xbt_dynar_get_ptr(g->nodes, i));
       }
     }
   }
@@ -359,12 +368,12 @@ void xbt_floyd_algorithm(xbt_graph_t g, double *adj, double *d,
   for (k = 0; k < n; k++) {
     for (i = 0; i < n; i++) {
       for (j = 0; j < n; j++) {
-       if ((D(i, k) != -1) && (D(k, j) != -1)) {
-         if ((D(i, j) == -1) || (D(i, j) > D(i, k) + D(k, j))) {
-           D(i, j) = D(i, k) + D(k, j);
-           P(i, j) = P(k, j);
-         }
-       }
+        if ((D(i, k) != -1) && (D(k, j) != -1)) {
+          if ((D(i, j) == -1) || (D(i, j) > D(i, k) + D(k, j))) {
+            D(i, j) = D(i, k) + D(k, j);
+            P(i, j) = P(k, j);
+          }
+        }
       }
     }
   }
@@ -380,7 +389,7 @@ xbt_node_t *xbt_graph_shortest_paths(xbt_graph_t g)
 {
   xbt_node_t *p;
   xbt_node_t *r;
-  int i, j, k;
+  unsigned long i, j, k;
   unsigned long n;
 
   double *adj = NULL;
@@ -402,11 +411,11 @@ xbt_node_t *xbt_graph_shortest_paths(xbt_graph_t g)
       k = j;
 
       while ((P(i, k)) && (__xbt_find_in_dynar(g->nodes, P(i, k)) != i)) {
-       k = __xbt_find_in_dynar(g->nodes, P(i, k));
+        k = __xbt_find_in_dynar(g->nodes, P(i, k));
       }
 
       if (P(i, j)) {
-       R(i, j) = *((xbt_node_t *) xbt_dynar_get_ptr(g->nodes, k));
+        R(i, j) = *((xbt_node_t *) xbt_dynar_get_ptr(g->nodes, k));
       }
     }
   }
@@ -429,10 +438,10 @@ xbt_edge_t *xbt_graph_spanning_tree_prim(xbt_graph_t g)
   xbt_node_t node = NULL;
   xbt_dynar_t edge_list = NULL;
   xbt_heap_t heap = xbt_heap_new(10, NULL);
-  int cursor;
+  unsigned int cursor;
 
   xbt_assert0(!(g->directed),
-             "Spanning trees do not make sense on directed graphs");
+              "Spanning trees do not make sense on directed graphs");
 
   xbt_dynar_foreach(g->nodes, cursor, node) {
     node->xbtdata = NULL;
@@ -452,13 +461,13 @@ xbt_edge_t *xbt_graph_spanning_tree_prim(xbt_graph_t g)
       edge->src->xbtdata = (void *) 1;
       edge_list = edge->src->out;
       xbt_dynar_foreach(edge_list, cursor, e) {
-       xbt_heap_push(heap, e, -(e->length));
+        xbt_heap_push(heap, e, -(e->length));
       }
     } else {
       edge->dst->xbtdata = (void *) 1;
       edge_list = edge->dst->out;
       xbt_dynar_foreach(edge_list, cursor, e) {
-       xbt_heap_push(heap, e, -(e->length));
+        xbt_heap_push(heap, e, -(e->length));
       }
     }
     if (tree_size == tree_size_max)
@@ -470,10 +479,10 @@ xbt_edge_t *xbt_graph_spanning_tree_prim(xbt_graph_t g)
   return tree;
 }
 
-/** @brief Topological sort on the given graph 
+/** @brief Topological sort on the given graph
  *
  *  From wikipedia:
- * 
+ *
  * In graph theory, a topological sort of a directed acyclic graph (DAG) is
  * a linear ordering of its nodes which is compatible with the partial
  * order R induced on the nodes where x comes before y (xRy) if there's a
@@ -485,7 +494,8 @@ xbt_node_t *xbt_graph_topo_sort(xbt_graph_t g)
 {
 
   xbt_node_t *sorted;
-  int cursor, idx;
+  unsigned int cursor;
+  int idx;
   xbt_node_t node;
   unsigned long n;
 
@@ -495,10 +505,10 @@ xbt_node_t *xbt_graph_topo_sort(xbt_graph_t g)
   sorted = xbt_malloc(n * sizeof(xbt_node_t));
 
   xbt_dynar_foreach(g->nodes, cursor, node)
-    node->xbtdata = xbt_new0(int, 1);
+      node->xbtdata = xbt_new0(int, 1);
 
   xbt_dynar_foreach(g->nodes, cursor, node)
-    xbt_graph_depth_visit(g, node, sorted, &idx);
+      xbt_graph_depth_visit(g, node, sorted, &idx);
 
   xbt_dynar_foreach(g->nodes, cursor, node) {
     free(node->xbtdata);
@@ -510,9 +520,9 @@ xbt_node_t *xbt_graph_topo_sort(xbt_graph_t g)
 
 /** @brief First-depth graph traversal */
 void xbt_graph_depth_visit(xbt_graph_t g, xbt_node_t n,
-                          xbt_node_t * sorted, int *idx)
+                           xbt_node_t * sorted, int *idx)
 {
-  int cursor;
+  unsigned int cursor;
   xbt_edge_t edge;
 
   if (*((int *) (n->xbtdata)) == ALREADY_EXPLORED)
@@ -536,13 +546,13 @@ static xbt_graph_t parsed_graph = NULL;
 static xbt_dict_t parsed_nodes = NULL;
 
 static void *(*__parse_node_label_and_data) (xbt_node_t, const char *,
-                                            const char *) = NULL;
+                                             const char *) = NULL;
 static void *(*__parse_edge_label_and_data) (xbt_edge_t, const char *,
-                                            const char *) = NULL;
+                                             const char *) = NULL;
 
 static void __parse_graph_begin(void)
 {
-  DEBUG0("<graph>");
+  XBT_DEBUG("<graph>");
   if (A_graphxml_graph_isDirected == A_graphxml_graph_isDirected_true)
     parsed_graph = xbt_graph_new_graph(1, NULL);
   else
@@ -554,21 +564,21 @@ static void __parse_graph_begin(void)
 static void __parse_graph_end(void)
 {
   xbt_dict_free(&parsed_nodes);
-  DEBUG0("</graph>");
+  XBT_DEBUG("</graph>");
 }
 
 static void __parse_node(void)
 {
   xbt_node_t node = xbt_graph_new_node(parsed_graph, NULL);
 
-  DEBUG1("<node name=\"%s\"/>", A_graphxml_node_name);
+  XBT_DEBUG("<node name=\"%s\"/>", A_graphxml_node_name);
   if (__parse_node_label_and_data)
     node->data = __parse_node_label_and_data(node, A_graphxml_node_label,
-                                            A_graphxml_node_data);
+                                             A_graphxml_node_data);
   xbt_graph_parse_get_double(&(node->position_x),
-                            A_graphxml_node_position_x);
+                             A_graphxml_node_position_x);
   xbt_graph_parse_get_double(&(node->position_y),
-                            A_graphxml_node_position_y);
+                             A_graphxml_node_position_y);
 
   xbt_dict_set(parsed_nodes, A_graphxml_node_name, (void *) node, NULL);
 }
@@ -576,31 +586,31 @@ static void __parse_node(void)
 static void __parse_edge(void)
 {
   xbt_edge_t edge = xbt_graph_new_edge(parsed_graph,
-                                      xbt_dict_get(parsed_nodes,
-                                                   A_graphxml_edge_source),
-                                      xbt_dict_get(parsed_nodes,
-                                                   A_graphxml_edge_target),
-                                      NULL);
+                                       xbt_dict_get(parsed_nodes,
+                                                    A_graphxml_edge_source),
+                                       xbt_dict_get(parsed_nodes,
+                                                    A_graphxml_edge_target),
+                                       NULL);
 
   if (__parse_edge_label_and_data)
     edge->data = __parse_edge_label_and_data(edge, A_graphxml_edge_label,
-                                            A_graphxml_edge_data);
+                                             A_graphxml_edge_data);
 
   xbt_graph_parse_get_double(&(edge->length), A_graphxml_edge_length);
 
-  DEBUG3("<edge  source=\"%s\" target=\"%s\" length=\"%f\"/>",
-        (char *) (edge->src)->data,
-        (char *) (edge->dst)->data, xbt_graph_edge_get_length(edge));
+  XBT_DEBUG("<edge  source=\"%s\" target=\"%s\" length=\"%f\"/>",
+         (char *) (edge->src)->data,
+         (char *) (edge->dst)->data, xbt_graph_edge_get_length(edge));
 }
 
 /** @brief Import a graph from a file following the GraphXML format */
 xbt_graph_t xbt_graph_read(const char *filename,
-                          void *(node_label_and_data) (xbt_node_t,
-                                                       const char *,
-                                                       const char *),
-                          void *(edge_label_and_data) (xbt_edge_t,
-                                                       const char *,
-                                                       const char *))
+                           void *(*node_label_and_data) (xbt_node_t,
+                                                         const char *,
+                                                         const char *),
+                           void *(*edge_label_and_data) (xbt_edge_t,
+                                                         const char *,
+                                                         const char *))
 {
 
   xbt_graph_t graph = NULL;
@@ -616,7 +626,9 @@ xbt_graph_t xbt_graph_read(const char *filename,
   ETag_graphxml_edge_fun = __parse_edge;
 
   xbt_graph_parse_open(filename);
-  xbt_assert1((!xbt_graph_parse()), "Parse error in %s", filename);
+  int res;
+  res = (*xbt_graph_parse) ();
+  xbt_assert1(!res, "Parse error in %s", filename);
   xbt_graph_parse_close();
 
   graph = parsed_graph;
@@ -627,10 +639,10 @@ xbt_graph_t xbt_graph_read(const char *filename,
 
 /** @brief Export the given graph in the GraphViz formatting for visualization */
 void xbt_graph_export_graphviz(xbt_graph_t g, const char *filename,
-                              const char *(node_name) (xbt_node_t),
-                              const char *(edge_name) (xbt_edge_t))
+                               const char *(node_name) (xbt_node_t),
+                               const char *(edge_name) (xbt_edge_t))
 {
-  int cursor = 0;
+  unsigned int cursor = 0;
   xbt_node_t node = NULL;
   xbt_edge_t edge = NULL;
   FILE *file = NULL;
@@ -648,7 +660,7 @@ void xbt_graph_export_graphviz(xbt_graph_t g, const char *filename,
 
   fprintf(file, "  node [shape=box, style=filled]\n");
   fprintf(file,
-         "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
+          "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 
   xbt_dynar_foreach(g->nodes, cursor, node) {
     fprintf(file, "  \"%p\" ", node);
@@ -671,12 +683,12 @@ void xbt_graph_export_graphviz(xbt_graph_t g, const char *filename,
 
 /** @brief Export the given graph in the GraphXML format */
 void xbt_graph_export_graphxml(xbt_graph_t g, const char *filename,
-                              const char *(node_name) (xbt_node_t),
-                              const char *(edge_name) (xbt_edge_t),
-                              const char *(node_data_print) (void *),
-                              const char *(edge_data_print) (void *))
+                               const char *(node_name) (xbt_node_t),
+                               const char *(edge_name) (xbt_edge_t),
+                               const char *(node_data_print) (void *),
+                               const char *(edge_data_print) (void *))
 {
-  int cursor = 0;
+  unsigned int cursor = 0;
   xbt_node_t node = NULL;
   xbt_edge_t edge = NULL;
   FILE *file = NULL;
@@ -701,7 +713,7 @@ void xbt_graph_export_graphxml(xbt_graph_t g, const char *filename,
   }
   xbt_dynar_foreach(g->edges, cursor, edge) {
     fprintf(file, "  <edge source=\"%p\" target =\"%p\" ",
-           edge->src, edge->dst);
+            edge->src, edge->dst);
     if ((edge_name) && ((name = edge_name(edge))))
       fprintf(file, "label=\"%s\" ", name);
     if (edge->length >= 0.0)