Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Some new functions to this. Bloatware, here we come.
[simgrid.git] / include / xbt / graph.h
index 2718e6e..658402c 100644 (file)
 #include "xbt/dynar.h"
 SG_BEGIN_DECL()
 
-typedef struct xbt_node *xbt_node_t;
+  /** @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_graph *xbt_graph_t;
 
 /* API */
 xbt_graph_t xbt_graph_new_graph(unsigned short int directed, void *data);
 xbt_node_t xbt_graph_new_node(xbt_graph_t g, void *data);
 xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst, 
                              void *data);
+void *xbt_graph_node_get_data(xbt_node_t node);
+void  xbt_graph_node_set_data(xbt_node_t node, void *data);
+void *xbt_graph_edge_get_data(xbt_edge_t edge);
+void  xbt_graph_edge_set_data(xbt_edge_t edge, void *data);
+
+xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst);
+
 void xbt_graph_edge_set_length(xbt_edge_t e, double length);
 double xbt_graph_edge_get_length(xbt_edge_t e);
 double* xbt_graph_get_length_matrix(xbt_graph_t g);
@@ -40,24 +53,34 @@ xbt_dynar_t xbt_graph_get_nodes(xbt_graph_t g);
 xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g);
 xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e);
 xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e);
-xbt_graph_t xbt_graph_read(const char *filename);
+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*)
+                          );
  
+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));
+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 *));
 
 /* Not implemented yet ! */
-void xbt_export_graphviz(xbt_graph_t g, const char *filename,
-                        const char *(node_name)(xbt_node_t),
-                        const char *(edge_name)(xbt_edge_t)
-                        );
-
-void xbt_graph_export_surfxml(xbt_graph_t g,
-                             const char *filename,
-                             const char *(node_name)(xbt_node_t),
-                             const char *(edge_name)(xbt_edge_t)
-                             );
-
 /* void *xbt_graph_to_array(xbt_graph_t g);  */
 xbt_node_t* xbt_graph_shortest_paths(xbt_graph_t g);
-void xbt_graph_topological_sort(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  
+  */
+
+xbt_node_t* xbt_graph_topo_sort(xbt_graph_t g);
+
+xbt_edge_t* xbt_graph_spanning_tree_prim(xbt_graph_t g);
 
 
 
@@ -79,7 +102,7 @@ void xbt_graph_topological_sort(xbt_graph_t g);
 SG_END_DECL()
 
 #endif                         /* _XBT_GRAPH_H */
-
+/** @} */