Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
64e0648d8dac3b8491a867369c318c38ac63f577
[simgrid.git] / include / xbt / graph.h
1 /* Copyright (c) 2006, 2007, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef _XBT_GRAPH_H
8 #define _XBT_GRAPH_H
9 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
10 #include "xbt/dynar.h"
11 SG_BEGIN_DECL()
12
13   /** @addtogroup XBT_graph
14    *  @brief A graph data type with several interesting algorithms
15    *
16    * @{
17    */
18 typedef struct xbt_node *xbt_node_t;
19 typedef struct xbt_edge *xbt_edge_t;
20 typedef struct xbt_graph *xbt_graph_t;
21
22 /* API */
23 XBT_PUBLIC(xbt_graph_t) xbt_graph_new_graph(unsigned short int directed,
24                                             void *data);
25 XBT_PUBLIC(xbt_node_t) xbt_graph_new_node(xbt_graph_t g, void *data);
26 XBT_PUBLIC(xbt_edge_t) xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src,
27                                           xbt_node_t dst, void *data);
28 XBT_PUBLIC(void *) xbt_graph_node_get_data(xbt_node_t node);
29 XBT_PUBLIC(void) xbt_graph_node_set_data(xbt_node_t node, void *data);
30 XBT_PUBLIC(void *) xbt_graph_edge_get_data(xbt_edge_t edge);
31 XBT_PUBLIC(void) xbt_graph_edge_set_data(xbt_edge_t edge, void *data);
32
33 XBT_PUBLIC(xbt_edge_t) xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src,
34                                           xbt_node_t dst);
35
36 XBT_PUBLIC(void) xbt_graph_edge_set_length(xbt_edge_t e, double length);
37 XBT_PUBLIC(double) xbt_graph_edge_get_length(xbt_edge_t e);
38 XBT_PUBLIC(double *) xbt_graph_get_length_matrix(xbt_graph_t g);
39
40 XBT_PUBLIC(void) xbt_graph_free_node(xbt_graph_t g, xbt_node_t n,
41                                      void_f_pvoid_t node_free_function,
42                                      void_f_pvoid_t edge_free_function);
43 XBT_PUBLIC(void) xbt_graph_free_edge(xbt_graph_t g, xbt_edge_t e,
44                                      void_f_pvoid_t free_function);
45 XBT_PUBLIC(void) xbt_graph_free_graph(xbt_graph_t g,
46                                       void_f_pvoid_t node_free_function,
47                                       void_f_pvoid_t edge_free_function,
48                                       void_f_pvoid_t graph_free_function);
49
50 XBT_PUBLIC(int) __xbt_find_in_dynar(xbt_dynar_t dynar, void *p);
51
52 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_nodes(xbt_graph_t g);
53 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_edges(xbt_graph_t g);
54 XBT_PUBLIC(xbt_dynar_t) xbt_graph_node_get_outedges(xbt_node_t n);
55 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_source(xbt_edge_t e);
56 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_target(xbt_edge_t e);
57 XBT_PUBLIC(xbt_graph_t) xbt_graph_read(const char *filename, void
58                                        *(node_label_and_data) (xbt_node_t,
59                                                                const char
60                                                                *,
61                                                                const char
62                                                                *), void
63                                        *(edge_label_and_data) (xbt_edge_t,
64                                                                const char
65                                                                *,
66                                                                const char
67                                                                *)
68     );
69
70 XBT_PUBLIC(void) xbt_graph_export_graphviz(xbt_graph_t g,
71                                            const char *filename, const char
72                                            *(node_name) (xbt_node_t), const char
73                                            *(edge_name) (xbt_edge_t));
74 XBT_PUBLIC(void) xbt_graph_export_graphxml(xbt_graph_t g,
75                                            const char *filename, const char
76                                            *(node_name) (xbt_node_t), const char
77                                            *(edge_name) (xbt_edge_t), const char
78                                            *(node_data_print) (void *), const char
79                                            *(edge_data_print) (void *));
80 XBT_PUBLIC(xbt_graph_t) xbt_graph_load (const char *filename);
81 XBT_PUBLIC(void) xbt_graph_save (xbt_graph_t span,
82                                  const char *filename,
83                                  const char *(nname) (xbt_node_t),
84                                  const char *(ename) (xbt_edge_t));
85
86 /* Not implemented yet ! */
87 /* void *xbt_graph_to_array(xbt_graph_t g);  */
88 XBT_PUBLIC(xbt_node_t *) xbt_graph_shortest_paths(xbt_graph_t g);
89
90
91
92 /** @brief transforms the network structure of a directed acyclic graph given into a linear structure
93     @return: an array containing the nodes of the graph sorted in order reverse to the path of exploration
94             if a cycle is detected an exception is raised
95   */
96
97 XBT_PUBLIC(xbt_node_t *) xbt_graph_topo_sort(xbt_graph_t g);
98
99 XBT_PUBLIC(xbt_edge_t *) xbt_graph_spanning_tree_prim(xbt_graph_t g);
100
101
102
103
104 /** Convenient for loop : g is a graph, n a node, e an edge, b a bucket and i an item **/
105
106 /* #define xbt_graph_foreachInNeighbor(v,n,i)            \ */
107 /*    for(i=xbt_fifo_get_first_item((v)->in);              \ */
108 /*      ((i)?(n=((xbt_edge_t)((xbt_fifo_get_item_content(i)) */
109 /* )->src):(NULL));\ */
110 /*        i=xbt_fifo_get_next_item(i)) */
111 /* #define xbt_graph_foreachOutNeighbor(v,n,i)           \ */
112 /*    for(i=xbt_fifo_get_first_item((v)->out);             \ */
113 /*      ((i)?(n=((xbt_edge_t)(xbt_fifo_get_item_content(i)))->dst):(NULL));\ */
114 /*        i=xbt_fifo_get_next_item(i)) */
115
116
117
118 SG_END_DECL()
119 #endif                          /* _XBT_GRAPH_H */
120 /** @} */