Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Adding licence, getting rid of useless includes and cosmetics
[simgrid.git] / 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
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(const char *name, 
21                                 unsigned short int directed, void *data);
22 xbt_node_t xbt_graph_new_node(xbt_graph_t g,const char *name, void *data);
23 xbt_edge_t xbt_graph_new_edge(xbt_graph_t g,const char *name,
24                               xbt_node_t src, xbt_node_t dst, void *data);
25
26 void xbt_graph_remove_node(xbt_graph_t g, xbt_node_t n, 
27                            void_f_pvoid_t *free_function);
28 void xbt_graph_remove_edge(xbt_graph_t g, xbt_edge_t e, 
29                            void_f_pvoid_t *free_function);
30 void xbt_graph_free_graph(xbt_graph_t g, 
31                           void_f_pvoid_t *node_free_function,
32                           void_f_pvoid_t *edge_free_function,
33                           void_f_pvoid_t *graph_free_function);
34
35 /* Not implemented yet ! */
36 void xbt_export_graphviz(xbt_graph_t g, const char *filename,
37                          const char *(node_name)(xbt_node_t),
38                          const char *(edge_name)(xbt_edge_t)
39                          );
40
41 void xbt_graph_export_surfxml(xbt_graph_t g,
42                               const char *filename,
43                               const char *(node_name)(xbt_node_t),
44                               const char *(edge_name)(xbt_edge_t)
45                               );
46
47 void *xbt_graph_to_array(xbt_graph_t g); 
48 void xbt_graph_shortest_paths(xbt_graph_t g);
49 void xbt_graph_topological_sort(xbt_graph_t g);
50
51
52
53
54 /** Convenient for loop : g is a graph, n a node, e an edge, b a bucket and i an item **/
55
56 /* #define xbt_graph_foreachInNeighbor(v,n,i)            \ */
57 /*    for(i=xbt_fifo_get_first_item((v)->in);              \ */
58 /*      ((i)?(n=((xbt_edge_t)((xbt_fifo_get_item_content(i)) */
59 /* )->src):(NULL));\ */
60 /*        i=xbt_fifo_get_next_item(i)) */
61 /* #define xbt_graph_foreachOutNeighbor(v,n,i)           \ */
62 /*    for(i=xbt_fifo_get_first_item((v)->out);             \ */
63 /*      ((i)?(n=((xbt_edge_t)(xbt_fifo_get_item_content(i)))->dst):(NULL));\ */
64 /*        i=xbt_fifo_get_next_item(i)) */
65
66
67
68 SG_END_DECL()
69
70 #endif                          /* _XBT_GRAPH_H */
71
72
73
74
75
76