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