Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : fix dpor
[simgrid.git] / include / xbt / graph.h
index 27ee96d..38a3512 100644 (file)
@@ -1,7 +1,5 @@
-/*     $Id$     */
-
-/* Copyright (c) 2006 Darina Dimitrova, Arnaud Legrand. 
-   All rights reserved.                  */
+/* Copyright (c) 2006, 2007, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -14,12 +12,50 @@ SG_BEGIN_DECL()
 
   /** @addtogroup XBT_graph
    *  @brief A graph data type with several interesting algorithms
-   * 
+   *
    * @{
    */
-     typedef struct xbt_node *xbt_node_t;
-     typedef struct xbt_edge *xbt_edge_t;
-     typedef struct xbt_graph *xbt_graph_t;
+
+typedef struct xbt_node *xbt_node_t;
+typedef struct xbt_edge *xbt_edge_t;
+typedef struct xbt_graph *xbt_graph_t;
+
+/* Node structure */
+/* Be carfull of what you do with this structure */
+/* typedef struct xbt_node *xbt_node_t; */
+typedef struct xbt_node {
+  xbt_dynar_t out;
+  xbt_dynar_t in;               /* not used when the graph is directed */
+  double position_x;            /* positive value: negative means undefined */
+  double position_y;            /* positive value: negative means undefined */
+  void *data;                   /* user data */
+  void *xbtdata;                /* private xbt data: should be reinitialized at the
+                                   beginning of your algorithm if you need to use it */
+} s_xbt_node_t;
+
+/* edge structure */
+/* Be carfull of what you do with this structure */
+/* typedef struct xbt_edge *xbt_edge_t; */
+typedef struct xbt_edge {
+  xbt_node_t src;
+  xbt_node_t dst;
+  void *data;                   /* user data */
+  void *xbtdata;                /* private xbt data: should be reinitialized at the
+                                   beginning of your algorithm if you need to use it */
+  double length;                /* positive value: negative means undefined */
+} s_xbt_edge_t;
+
+/* Graph structure */
+/* Be carfull of what you do with this structure */  
+/* typedef struct xbt_graph *xbt_graph_t; */
+typedef struct xbt_graph {
+  xbt_dynar_t nodes;
+  xbt_dynar_t edges;
+  unsigned short int directed;
+  void *data;                   /* user data */
+  void *xbtdata;                /* private xbt data: should be reinitialized at the
+                                   beginning of your algorithm if you need to use it */
+} s_xbt_graph_t;
 
 /* API */
 XBT_PUBLIC(xbt_graph_t) xbt_graph_new_graph(unsigned short int directed,
@@ -53,30 +89,37 @@ XBT_PUBLIC(int) __xbt_find_in_dynar(xbt_dynar_t dynar, void *p);
 
 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_nodes(xbt_graph_t g);
 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_edges(xbt_graph_t g);
+XBT_PUBLIC(xbt_dynar_t) xbt_graph_node_get_outedges(xbt_node_t n);
 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_source(xbt_edge_t e);
 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_target(xbt_edge_t e);
 XBT_PUBLIC(xbt_graph_t) xbt_graph_read(const char *filename, void
-                                       * (node_label_and_data) (xbt_node_t,
-                                                                const char *,
-                                                                const char *),
-                                       void
-                                       * (edge_label_and_data) (xbt_edge_t,
-                                                                const char *,
-                                                                const char *)
-  );
+                                       *(node_label_and_data) (xbt_node_t,
+                                                               const char
+                                                               *,
+                                                               const char
+                                                               *), void
+                                       *(edge_label_and_data) (xbt_edge_t,
+                                                               const char
+                                                               *,
+                                                               const char
+                                                               *)
+    );
 
 XBT_PUBLIC(void) xbt_graph_export_graphviz(xbt_graph_t g,
                                            const char *filename, const char
-                                           * (node_name) (xbt_node_t), const char
-                                           * (edge_name) (xbt_edge_t));
+                                           *(node_name) (xbt_node_t), const char
+                                           *(edge_name) (xbt_edge_t));
 XBT_PUBLIC(void) xbt_graph_export_graphxml(xbt_graph_t g,
                                            const char *filename, const char
-                                           * (node_name) (xbt_node_t), const char
-                                           * (edge_name) (xbt_edge_t),
-                                           const char *(node_data_print) (void
-                                                                          *),
-                                           const char *(edge_data_print) (void
-                                                                          *));
+                                           *(node_name) (xbt_node_t), const char
+                                           *(edge_name) (xbt_edge_t), const char
+                                           *(node_data_print) (void *), const char
+                                           *(edge_data_print) (void *));
+XBT_PUBLIC(xbt_graph_t) xbt_graph_load (const char *filename);
+XBT_PUBLIC(void) xbt_graph_save (xbt_graph_t span,
+                                 const char *filename,
+                                 const char *(nname) (xbt_node_t),
+                                 const char *(ename) (xbt_edge_t));
 
 /* Not implemented yet ! */
 /* void *xbt_graph_to_array(xbt_graph_t g);  */
@@ -85,8 +128,8 @@ XBT_PUBLIC(xbt_node_t *) xbt_graph_shortest_paths(xbt_graph_t g);
 
 
 /** @brief transforms the network structure of a directed acyclic graph given into a linear structure
-    @return: an array containing the nodes of the graph sorted in order reverse to the path of exploration 
-            if a cycle is detected an exception is raised  
+    @return: an array containing the nodes of the graph sorted in order reverse to the path of exploration
+            if a cycle is detected an exception is raised
   */
 
 XBT_PUBLIC(xbt_node_t *) xbt_graph_topo_sort(xbt_graph_t g);
@@ -111,5 +154,5 @@ XBT_PUBLIC(xbt_edge_t *) xbt_graph_spanning_tree_prim(xbt_graph_t g);
 
 
 SG_END_DECL()
-#endif /* _XBT_GRAPH_H */
+#endif                          /* _XBT_GRAPH_H */
 /** @} */