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   /** @addtogroup XBT_graph
  16    *  @brief A graph data type with several interesting algorithms
  17    *
  18    * @{
  19    */
  20
  21 typedef struct xbt_node *xbt_node_t;
  22 typedef struct xbt_edge  *xbt_edge_t;
  23 typedef struct xbt_graph  *xbt_graph_t;
  24
  25 /* API */
  26 xbt_graph_t xbt_graph_new_graph(unsigned short int directed, void *data);
  27 xbt_node_t xbt_graph_new_node(xbt_graph_t g, void *data);
  28 xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst,
  29                               void *data);
  30 void *xbt_graph_node_get_data(xbt_node_t node);
  31 void  xbt_graph_node_set_data(xbt_node_t node, void *data);
  32 void *xbt_graph_edge_get_data(xbt_edge_t edge);
  33
  34 void xbt_graph_edge_set_length(xbt_edge_t e, double length);
  35 double xbt_graph_edge_get_length(xbt_edge_t e);
  36 double* xbt_graph_get_length_matrix(xbt_graph_t g);
  37
  38 void xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
  39                            void_f_pvoid_t *node_free_function , void_f_pvoid_t *edge_free_function);
  40 void xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
  41                            void_f_pvoid_t *free_function);
  42 void xbt_graph_free_graph(xbt_graph_t g,
  43                           void_f_pvoid_t *node_free_function,
  44                           void_f_pvoid_t *edge_free_function,
  45                           void_f_pvoid_t *graph_free_function);
  46
  47 int __xbt_find_in_dynar(xbt_dynar_t dynar, void *p);
  48
  49 xbt_dynar_t xbt_graph_get_nodes(xbt_graph_t g);
  50 xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g);
  51 xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e);
  52 xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e);
  53 xbt_graph_t xbt_graph_read(const char *filename,
  54                            void *(node_label_and_data)(xbt_node_t, const char*, const char*),
  55                            void *(edge_label_and_data)(xbt_edge_t, const char*, const char*)
  56                            );
  57
  58 void xbt_graph_export_graphviz(xbt_graph_t g, const char *filename,
  59                                const char *(node_name)(xbt_node_t),
  60                                const char *(edge_name)(xbt_edge_t));
  61 void xbt_graph_export_graphxml(xbt_graph_t g, const char *filename,
  62                                const char *(node_name)(xbt_node_t),
  63                                const char *(edge_name)(xbt_edge_t),
  64                                const char *(node_data_print)(void *),
  65                                const char *(edge_data_print)(void *));
  66
  67 /* Not implemented yet ! */
  68 /* void *xbt_graph_to_array(xbt_graph_t g);  */
  69 xbt_node_t* xbt_graph_shortest_paths(xbt_graph_t g);
  70
  71
  72
  73 /** @brief transforms the network structure of a directed acyclic graph given into a linear structure
  74     @return: an array containing the nodes of the graph sorted in order reverse to the path of exploration
  75             if a cycle is detected an exception is raised
  76   */
  77
  78 xbt_node_t* xbt_graph_topo_sort(xbt_graph_t g);
  79
  80 xbt_edge_t* xbt_graph_spanning_tree_prim(xbt_graph_t g);
  81
  82
  83
  84
  85 /** Convenient for loop : g is a graph, n a node, e an edge, b a bucket and i an item **/
  86
  87 /* #define xbt_graph_foreachInNeighbor(v,n,i)            \ */
  88 /*    for(i=xbt_fifo_get_first_item((v)->in);              \ */
  89 /*      ((i)?(n=((xbt_edge_t)((xbt_fifo_get_item_content(i)) */
  90 /* )->src):(NULL));\ */
  91 /*        i=xbt_fifo_get_next_item(i)) */
  92 /* #define xbt_graph_foreachOutNeighbor(v,n,i)           \ */
  93 /*    for(i=xbt_fifo_get_first_item((v)->out);             \ */
  94 /*      ((i)?(n=((xbt_edge_t)(xbt_fifo_get_item_content(i)))->dst):(NULL));\ */
  95 /*        i=xbt_fifo_get_next_item(i)) */
  96
  97
  98
  99 SG_END_DECL()
 100
 101 #endif                          /* _XBT_GRAPH_H */
 102 /** @} */
 103
 104
 105
 106
 107