1 /* Copyright (c) 2006, 2007, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/misc.h" /* SG_BEGIN_DECL */
10 #include "xbt/dynar.h"
13 /** @addtogroup XBT_graph
14 * @brief A graph data type with several interesting algorithms
19 typedef struct xbt_node *xbt_node_t;
20 typedef struct xbt_edge *xbt_edge_t;
21 typedef struct xbt_graph *xbt_graph_t;
24 /* Be carfull of what you do with this structure */
25 /* typedef struct xbt_node *xbt_node_t; */
26 typedef struct xbt_node {
28 xbt_dynar_t in; /* not used when the graph is directed */
29 double position_x; /* positive value: negative means undefined */
30 double position_y; /* positive value: negative means undefined */
31 void *data; /* user data */
32 void *xbtdata; /* private xbt data: should be reinitialized at the
33 beginning of your algorithm if you need to use it */
37 /* Be carfull of what you do with this structure */
38 /* typedef struct xbt_edge *xbt_edge_t; */
39 typedef struct xbt_edge {
42 void *data; /* user data */
43 void *xbtdata; /* private xbt data: should be reinitialized at the
44 beginning of your algorithm if you need to use it */
45 double length; /* positive value: negative means undefined */
49 /* Be carfull of what you do with this structure */
50 /* typedef struct xbt_graph *xbt_graph_t; */
51 typedef struct xbt_graph {
54 unsigned short int directed;
55 void *data; /* user data */
56 void *xbtdata; /* private xbt data: should be reinitialized at the
57 beginning of your algorithm if you need to use it */
61 XBT_PUBLIC(xbt_graph_t) xbt_graph_new_graph(unsigned short int directed,
63 XBT_PUBLIC(xbt_node_t) xbt_graph_new_node(xbt_graph_t g, void *data);
64 XBT_PUBLIC(xbt_edge_t) xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src,
65 xbt_node_t dst, void *data);
66 XBT_PUBLIC(void *) xbt_graph_node_get_data(xbt_node_t node);
67 XBT_PUBLIC(void) xbt_graph_node_set_data(xbt_node_t node, void *data);
68 XBT_PUBLIC(void *) xbt_graph_edge_get_data(xbt_edge_t edge);
69 XBT_PUBLIC(void) xbt_graph_edge_set_data(xbt_edge_t edge, void *data);
71 XBT_PUBLIC(xbt_edge_t) xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src,
74 XBT_PUBLIC(void) xbt_graph_edge_set_length(xbt_edge_t e, double length);
75 XBT_PUBLIC(double) xbt_graph_edge_get_length(xbt_edge_t e);
76 XBT_PUBLIC(double *) xbt_graph_get_length_matrix(xbt_graph_t g);
78 XBT_PUBLIC(void) xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
79 void_f_pvoid_t node_free_function,
80 void_f_pvoid_t edge_free_function);
81 XBT_PUBLIC(void) xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
82 void_f_pvoid_t free_function);
83 XBT_PUBLIC(void) xbt_graph_free_graph(xbt_graph_t g,
84 void_f_pvoid_t node_free_function,
85 void_f_pvoid_t edge_free_function,
86 void_f_pvoid_t graph_free_function);
88 XBT_PUBLIC(int) __xbt_find_in_dynar(xbt_dynar_t dynar, void *p);
90 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_nodes(xbt_graph_t g);
91 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_edges(xbt_graph_t g);
92 XBT_PUBLIC(xbt_dynar_t) xbt_graph_node_get_outedges(xbt_node_t n);
93 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_source(xbt_edge_t e);
94 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_target(xbt_edge_t e);
95 XBT_PUBLIC(xbt_graph_t) xbt_graph_read(const char *filename, void
96 *(node_label_and_data) (xbt_node_t,
101 *(edge_label_and_data) (xbt_edge_t,
108 XBT_PUBLIC(void) xbt_graph_export_graphviz(xbt_graph_t g,
109 const char *filename, const char
110 *(node_name) (xbt_node_t), const char
111 *(edge_name) (xbt_edge_t));
112 XBT_PUBLIC(void) xbt_graph_export_graphxml(xbt_graph_t g,
113 const char *filename, const char
114 *(node_name) (xbt_node_t), const char
115 *(edge_name) (xbt_edge_t), const char
116 *(node_data_print) (void *), const char
117 *(edge_data_print) (void *));
118 XBT_PUBLIC(xbt_graph_t) xbt_graph_load (const char *filename);
119 XBT_PUBLIC(void) xbt_graph_save (xbt_graph_t span,
120 const char *filename,
121 const char *(nname) (xbt_node_t),
122 const char *(ename) (xbt_edge_t));
124 /* Not implemented yet ! */
125 /* void *xbt_graph_to_array(xbt_graph_t g); */
126 XBT_PUBLIC(xbt_node_t *) xbt_graph_shortest_paths(xbt_graph_t g);
130 /** @brief transforms the network structure of a directed acyclic graph given into a linear structure
131 @return: an array containing the nodes of the graph sorted in order reverse to the path of exploration
132 if a cycle is detected an exception is raised
135 XBT_PUBLIC(xbt_node_t *) xbt_graph_topo_sort(xbt_graph_t g);
137 XBT_PUBLIC(xbt_edge_t *) xbt_graph_spanning_tree_prim(xbt_graph_t g);
142 /** Convenient for loop : g is a graph, n a node, e an edge, b a bucket and i an item **/
144 /* #define xbt_graph_foreachInNeighbor(v,n,i) \ */
145 /* for(i=xbt_fifo_get_first_item((v)->in); \ */
146 /* ((i)?(n=((xbt_edge_t)((xbt_fifo_get_item_content(i)) */
147 /* )->src):(NULL));\ */
148 /* i=xbt_fifo_get_next_item(i)) */
149 /* #define xbt_graph_foreachOutNeighbor(v,n,i) \ */
150 /* for(i=xbt_fifo_get_first_item((v)->out); \ */
151 /* ((i)?(n=((xbt_edge_t)(xbt_fifo_get_item_content(i)))->dst):(NULL));\ */
152 /* i=xbt_fifo_get_next_item(i)) */
157 #endif /* _XBT_GRAPH_H */