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 #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 } s_xbt_node_t;
  32
  33 /* edge structure */
  34 /* Be careful of what you do with this structure */
  35 /* typedef struct xbt_edge *xbt_edge_t; */
  36 typedef struct xbt_edge {
  37   xbt_node_t src;
  38   xbt_node_t dst;
  39   void *data;                   /* user data */
  40 } s_xbt_edge_t;
  41
  42 /* Graph structure */
  43 /* Be careful of what you do with this structure */
  44 /* typedef struct xbt_graph *xbt_graph_t; */
  45 typedef struct xbt_graph {
  46   xbt_dynar_t nodes;
  47   xbt_dynar_t edges;
  48   unsigned short int directed;
  49   void *data;                   /* user data */
  50 } s_xbt_graph_t;
  51
  52 /* API */
  53 XBT_PUBLIC xbt_graph_t xbt_graph_new_graph(unsigned short int directed, void* data);
  54 XBT_PUBLIC xbt_node_t xbt_graph_new_node(xbt_graph_t g, void* data);
  55 XBT_PUBLIC xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst, void* data);
  56 XBT_PUBLIC void* xbt_graph_node_get_data(xbt_node_t node);
  57 XBT_PUBLIC void xbt_graph_node_set_data(xbt_node_t node, void* data);
  58 XBT_PUBLIC void* xbt_graph_edge_get_data(xbt_edge_t edge);
  59 XBT_PUBLIC void xbt_graph_edge_set_data(xbt_edge_t edge, void* data);
  60
  61 XBT_PUBLIC xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst);
  62
  63 XBT_PUBLIC void xbt_graph_free_graph(xbt_graph_t g, void_f_pvoid_t node_free_function,
  64                                      void_f_pvoid_t edge_free_function, void_f_pvoid_t graph_free_function);
  65
  66 XBT_PUBLIC xbt_dynar_t xbt_graph_get_nodes(xbt_graph_t g);
  67 XBT_PUBLIC xbt_dynar_t xbt_graph_get_edges(xbt_graph_t g);
  68 XBT_PUBLIC xbt_dynar_t xbt_graph_node_get_outedges(xbt_node_t n);
  69 XBT_PUBLIC xbt_node_t xbt_graph_edge_get_source(xbt_edge_t e);
  70 XBT_PUBLIC xbt_node_t xbt_graph_edge_get_target(xbt_edge_t e);
  71
  72 SG_END_DECL()
  73 #endif /* XBT_GRAPH_H */
  74 /** @} */