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