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