include/xbt/graph.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2006 Darina Dimitrova, Arnaud Legrand.
   4    All rights reserved.                  */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _XBT_GRAPH_H
  10 #define _XBT_GRAPH_H
  11 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  12 #include "xbt/dynar.h"
  13 SG_BEGIN_DECL()
  14
  15 typedef struct xbt_node *xbt_node_t;
  16 typedef struct xbt_edge  *xbt_edge_t;
  17 typedef struct xbt_graph  *xbt_graph_t;
  18
  19 /* API */
  20 xbt_graph_t xbt_graph_new_graph(unsigned short int directed, void *data);
  21 xbt_node_t xbt_graph_new_node(xbt_graph_t g, void *data);
  22 xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst,
  23                               void *data);
  24 void xbt_graph_edge_set_length(xbt_edge_t e, double length);
  25 double xbt_graph_edge_get_length(xbt_edge_t e);
  26 double* xbt_graph_get_length_matrix(xbt_graph_t g);
  27
  28 void xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
  29                            void_f_pvoid_t *free_function);
  30 void xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
  31                            void_f_pvoid_t *free_function);
  32 void xbt_graph_free_graph(xbt_graph_t g,
  33                           void_f_pvoid_t *node_free_function,
  34                           void_f_pvoid_t *edge_free_function,
  35                           void_f_pvoid_t *graph_free_function);
  36
  37 xbt_dynar_t xbt_graph_get_nodes(xbt_graph_t g);
  38 xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g);
  39 xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e);
  40 xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e);
  41 xbt_graph_t xbt_graph_read(const char *filename);
  42
  43 /* Not implemented yet ! */
  44 void xbt_export_graphviz(xbt_graph_t g, const char *filename,
  45                          const char *(node_name)(xbt_node_t),
  46                          const char *(edge_name)(xbt_edge_t)
  47                          );
  48
  49 void xbt_graph_export_surfxml(xbt_graph_t g,
  50                               const char *filename,
  51                               const char *(node_name)(xbt_node_t),
  52                               const char *(edge_name)(xbt_edge_t)
  53                               );
  54
  55 /* void *xbt_graph_to_array(xbt_graph_t g);  */
  56 xbt_node_t* xbt_graph_shortest_paths(xbt_graph_t g);
  57 void xbt_graph_topological_sort(xbt_graph_t g);
  58
  59
  60
  61
  62 /** Convenient for loop : g is a graph, n a node, e an edge, b a bucket and i an item **/
  63
  64 /* #define xbt_graph_foreachInNeighbor(v,n,i)            \ */
  65 /*    for(i=xbt_fifo_get_first_item((v)->in);              \ */
  66 /*      ((i)?(n=((xbt_edge_t)((xbt_fifo_get_item_content(i)) */
  67 /* )->src):(NULL));\ */
  68 /*        i=xbt_fifo_get_next_item(i)) */
  69 /* #define xbt_graph_foreachOutNeighbor(v,n,i)           \ */
  70 /*    for(i=xbt_fifo_get_first_item((v)->out);             \ */
  71 /*      ((i)?(n=((xbt_edge_t)(xbt_fifo_get_item_content(i)))->dst):(NULL));\ */
  72 /*        i=xbt_fifo_get_next_item(i)) */
  73
  74
  75
  76 SG_END_DECL()
  77
  78 #endif                          /* _XBT_GRAPH_H */
  79
  80
  81
  82
  83
  84