include/xbt/graph.h

   1 /* Copyright (c) 2006-2007, 2009-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _XBT_GRAPH_H
   8 #define _XBT_GRAPH_H
   9 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  10 #include "xbt/dynar.h"
  11 SG_BEGIN_DECL()
  12
  13   /** @addtogroup XBT_graph
  14    *  @brief A graph data type with several interesting algorithms
  15    *
  16    * @{
  17    */
  18
  19 typedef struct xbt_node *xbt_node_t;
  20 typedef struct xbt_edge *xbt_edge_t;
  21 typedef struct xbt_graph *xbt_graph_t;
  22
  23 /* Node structure */
  24 /* Be careful of what you do with this structure */
  25 /* typedef struct xbt_node *xbt_node_t; */
  26 typedef struct xbt_node {
  27   xbt_dynar_t out;
  28   xbt_dynar_t in;               /* not used when the graph is directed */
  29   double position_x;            /* positive value: negative means undefined */
  30   double position_y;            /* positive value: negative means undefined */
  31   void *data;                   /* user data */
  32   void *xbtdata;                /* private xbt data: should be reinitialized at the
  33                                    beginning of your algorithm if you need to use it */
  34 } s_xbt_node_t;
  35
  36 /* edge structure */
  37 /* Be careful of what you do with this structure */
  38 /* typedef struct xbt_edge *xbt_edge_t; */
  39 typedef struct xbt_edge {
  40   xbt_node_t src;
  41   xbt_node_t dst;
  42   void *data;                   /* user data */
  43   void *xbtdata;                /* private xbt data: should be reinitialized at the
  44                                    beginning of your algorithm if you need to use it */
  45   double length;                /* positive value: negative means undefined */
  46 } s_xbt_edge_t;
  47
  48 /* Graph structure */
  49 /* Be careful of what you do with this structure */
  50 /* typedef struct xbt_graph *xbt_graph_t; */
  51 typedef struct xbt_graph {
  52   xbt_dynar_t nodes;
  53   xbt_dynar_t edges;
  54   unsigned short int directed;
  55   void *data;                   /* user data */
  56   void *xbtdata;                /* private xbt data: should be reinitialized at the
  57                                    beginning of your algorithm if you need to use it */
  58 } s_xbt_graph_t;
  59
  60 /* API */
  61 XBT_PUBLIC(xbt_graph_t) xbt_graph_new_graph(unsigned short int directed, void *data);
  62 XBT_PUBLIC(xbt_node_t) xbt_graph_new_node(xbt_graph_t g, void *data);
  63 XBT_PUBLIC(xbt_edge_t) xbt_graph_new_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst, void *data);
  64 XBT_PUBLIC(void *) xbt_graph_node_get_data(xbt_node_t node);
  65 XBT_PUBLIC(void) xbt_graph_node_set_data(xbt_node_t node, void *data);
  66 XBT_PUBLIC(void *) xbt_graph_edge_get_data(xbt_edge_t edge);
  67 XBT_PUBLIC(void) xbt_graph_edge_set_data(xbt_edge_t edge, void *data);
  68
  69 XBT_PUBLIC(xbt_edge_t) xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst);
  70
  71 XBT_PUBLIC(void) xbt_graph_edge_set_length(xbt_edge_t e, double length);
  72 XBT_PUBLIC(double) xbt_graph_edge_get_length(xbt_edge_t e);
  73
  74 XBT_PUBLIC(void) xbt_graph_free_graph(xbt_graph_t g,
  75     void_f_pvoid_t node_free_function, void_f_pvoid_t edge_free_function, void_f_pvoid_t graph_free_function);
  76
  77 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_nodes(xbt_graph_t g);
  78 XBT_PUBLIC(xbt_dynar_t) xbt_graph_get_edges(xbt_graph_t g);
  79 XBT_PUBLIC(xbt_dynar_t) xbt_graph_node_get_outedges(xbt_node_t n);
  80 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_source(xbt_edge_t e);
  81 XBT_PUBLIC(xbt_node_t) xbt_graph_edge_get_target(xbt_edge_t e);
  82
  83 XBT_PUBLIC(void) xbt_graph_export_graphviz(xbt_graph_t g, const char *filename,
  84     const char *(node_name) (xbt_node_t), const char *(edge_name) (xbt_edge_t));
  85
  86 SG_END_DECL()
  87 #endif                          /* _XBT_GRAPH_H */
  88 /** @} */