include/xbt/graph.h

   1 /* Copyright (c) 2006-2017. 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 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
   9 #include "xbt/dynar.h"
  10 SG_BEGIN_DECL()
  11
  12   /** @addtogroup XBT_graph
  13    *  @brief A graph data type with several interesting algorithms
  14    *
  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 /* Node structure */
  23 /* Be careful of what you do with this structure */
  24 /* typedef struct xbt_node *xbt_node_t; */
  25 typedef struct xbt_node {
  26   xbt_dynar_t out;
  27   xbt_dynar_t in;               /* not used when the graph is directed */
  28   double position_x;            /* positive value: negative means undefined */
  29   double position_y;            /* positive value: negative means undefined */
  30   void *data;                   /* user data */
  31   void *xbtdata;                /* private xbt data: should be reinitialized at the
  32                                    beginning of your algorithm if you need to use it */
  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   void *xbtdata;                /* private xbt data: should be reinitialized at the
  43                                    beginning of your algorithm if you need to use it */
  44   double length;                /* positive value: negative means undefined */
  45 } s_xbt_edge_t;
  46
  47 /* Graph structure */
  48 /* Be careful of what you do with this structure */
  49 /* typedef struct xbt_graph *xbt_graph_t; */
  50 typedef struct xbt_graph {
  51   xbt_dynar_t nodes;
  52   xbt_dynar_t edges;
  53   unsigned short int directed;
  54   void *data;                   /* user data */
  55   void *xbtdata;                /* private xbt data: should be reinitialized at the
  56                                    beginning of your algorithm if you need to use it */
  57 } s_xbt_graph_t;
  58
  59 /* API */
  60 XBT_PUBLIC(xbt_graph_t) xbt_graph_new_graph(unsigned short int directed, void *data);
  61 XBT_PUBLIC(xbt_node_t) xbt_graph_new_node(xbt_graph_t g, void *data);
  62 XBT_PUBLIC(xbt_edge_t) xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst, void *data);
  63 XBT_PUBLIC(void *) xbt_graph_node_get_data(xbt_node_t node);
  64 XBT_PUBLIC(void) xbt_graph_node_set_data(xbt_node_t node, void *data);
  65 XBT_PUBLIC(void *) xbt_graph_edge_get_data(xbt_edge_t edge);
  66 XBT_PUBLIC(void) xbt_graph_edge_set_data(xbt_edge_t edge, void *data);
  67
  68 XBT_PUBLIC(xbt_edge_t) xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst);
  69
  70 XBT_PUBLIC(void) xbt_graph_edge_set_length(xbt_edge_t e, double length);
  71 XBT_PUBLIC(double) xbt_graph_edge_get_length(xbt_edge_t e);
  72
  73 XBT_PUBLIC(void) xbt_graph_free_graph(xbt_graph_t g,
  74     void_f_pvoid_t node_free_function, void_f_pvoid_t edge_free_function, void_f_pvoid_t graph_free_function);
  75
  76 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_nodes(xbt_graph_t g);
  77 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_edges(xbt_graph_t g);
  78 XBT_PUBLIC(xbt_dynar_t) xbt_graph_node_get_outedges(xbt_node_t n);
  79 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_source(xbt_edge_t e);
  80 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_target(xbt_edge_t e);
  81
  82 XBT_PUBLIC(void)
  83 xbt_graph_export_graphviz(xbt_graph_t g, const char* filename, const char*(node_name)(xbt_node_t n),
  84                           const char*(edge_name)(xbt_edge_t e));
  85
  86 SG_END_DECL()
  87 #endif /* XBT_GRAPH_H */
  88 /** @} */