Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / graph.h
1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef XBT_GRAPH_H
7 #define XBT_GRAPH_H
8
9 #include <xbt/dynar.h>
10 #include <xbt/misc.h> /* SG_BEGIN_DECL */
11
12 SG_BEGIN_DECL()
13
14   /** @addtogroup XBT_graph
15    *  @brief A graph data type with several interesting algorithms
16    *
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 /* Node structure */
25 /* Be careful of what you do with this structure */
26 /* typedef struct xbt_node *xbt_node_t; */
27 typedef struct xbt_node {
28   xbt_dynar_t out;
29   xbt_dynar_t in;               /* not used when the graph is directed */
30   double position_x;            /* positive value: negative means undefined */
31   double position_y;            /* positive value: negative means undefined */
32   void *data;                   /* user data */
33 } s_xbt_node_t;
34
35 /* edge structure */
36 /* Be careful of what you do with this structure */
37 /* typedef struct xbt_edge *xbt_edge_t; */
38 typedef struct xbt_edge {
39   xbt_node_t src;
40   xbt_node_t dst;
41   void *data;                   /* user data */
42 } s_xbt_edge_t;
43
44 /* Graph structure */
45 /* Be careful of what you do with this structure */
46 /* typedef struct xbt_graph *xbt_graph_t; */
47 typedef struct xbt_graph {
48   xbt_dynar_t nodes;
49   xbt_dynar_t edges;
50   unsigned short int directed;
51   void *data;                   /* user data */
52 } s_xbt_graph_t;
53
54 /* API */
55 XBT_PUBLIC xbt_graph_t xbt_graph_new_graph(unsigned short int directed, void* data);
56 XBT_PUBLIC xbt_node_t xbt_graph_new_node(xbt_graph_t g, void* data);
57 XBT_PUBLIC xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst, void* data);
58 XBT_PUBLIC void* xbt_graph_node_get_data(xbt_node_t node);
59 XBT_PUBLIC void xbt_graph_node_set_data(xbt_node_t node, void* data);
60 XBT_PUBLIC void* xbt_graph_edge_get_data(xbt_edge_t edge);
61 XBT_PUBLIC void xbt_graph_edge_set_data(xbt_edge_t edge, void* data);
62
63 XBT_PUBLIC xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst);
64
65 XBT_PUBLIC void xbt_graph_free_graph(xbt_graph_t g, void_f_pvoid_t node_free_function,
66                                      void_f_pvoid_t edge_free_function, void_f_pvoid_t graph_free_function);
67
68 XBT_PUBLIC xbt_dynar_t xbt_graph_get_nodes(xbt_graph_t g);
69 XBT_PUBLIC xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g);
70 XBT_PUBLIC xbt_dynar_t xbt_graph_node_get_outedges(xbt_node_t n);
71 XBT_PUBLIC xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e);
72 XBT_PUBLIC xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e);
73
74 SG_END_DECL()
75 #endif /* XBT_GRAPH_H */
76 /** @} */