src/work/marci/leda/leda_graph_wrapper.h
author alpar
Mon, 26 Apr 2004 17:33:51 +0000
changeset 425 4fbe868c1fb4
parent 409 7ab7f083760a
child 446 77ef5c7a57d9
permissions -rw-r--r--
Some more docs.
Put it into the 'misc' group.
marci@189
     1
// -*- c++ -*-
marci@189
     2
#ifndef HUGO_LEDA_GRAPH_WRAPPER_H
marci@189
     3
#define HUGO_LEDA_GRAPH_WRAPPER_H
marci@189
     4
marci@189
     5
#include <LEDA/graph.h>
marci@189
     6
#include <LEDA/node_array.h>
marci@189
     7
#include <LEDA/edge_array.h>
marci@189
     8
#include <LEDA/node_map.h>
marci@189
     9
#include <LEDA/edge_map.h>
marci@189
    10
//#include <LEDA/graph_alg.h>
marci@189
    11
//#include <LEDA/dimacs.h>
marci@189
    12
marci@189
    13
//#if defined(LEDA_NAMESPACE)
marci@189
    14
//using namespace leda;
marci@189
    15
//#endif
marci@189
    16
marci@189
    17
#include <invalid.h>
marci@189
    18
marci@189
    19
/// The namespace of HugoLib
marci@189
    20
namespace hugo {
marci@189
    21
marci@189
    22
  // @defgroup empty_graph The LedaGraphWrapper class
marci@189
    23
  // @{
marci@189
    24
marci@409
    25
  /// A graph wrapperstructure for wrapping LEDA graphs in HUGO.
marci@189
    26
  
marci@409
    27
  /// This graph wrapper class wraps LEDA graph and LEDA parametrized graph
marci@409
    28
  /// and then the generic algorithms and wrappers of HUGO can be used 
marci@409
    29
  /// with LEDA graphs. 
marci@189
    30
  /// This class provides all the common features of a grapf structure,
marci@189
    31
  /// however completely without implementations or real data structures
marci@189
    32
  /// behind the interface.
marci@189
    33
  /// All graph algorithms should compile with this class, but it will not
marci@189
    34
  /// run properly, of course.
marci@189
    35
  ///
marci@189
    36
  /// It can be used for checking the interface compatibility,
marci@189
    37
  /// or it can serve as a skeleton of a new graph structure.
marci@189
    38
  /// 
marci@189
    39
  /// Also, you will find here the full documentation of a certain graph
marci@189
    40
  /// feature, the documentation of a real graph imlementation
marci@189
    41
  /// like @ref ListGraph or
marci@189
    42
  /// @ref SmartGraph will just refer to this structure.
marci@189
    43
  template<typename Graph>
marci@189
    44
  class LedaGraphWrapper
marci@189
    45
  {
marci@189
    46
    Graph* _graph;
marci@189
    47
  public:
marci@189
    48
   
marci@189
    49
        //LedaGraphWrapper() { }
marci@189
    50
    LedaGraphWrapper(Graph& __graph) : _graph(&__graph) { }
marci@189
    51
    LedaGraphWrapper(const LedaGraphWrapper &G) : _graph(G._graph) { }
marci@189
    52
marci@189
    53
    template <typename T> class NodeMap;
marci@189
    54
    template <typename T> class EdgeMap;
marci@189
    55
marci@189
    56
    /// The base type of the node iterators.
marci@189
    57
    class Node {
marci@189
    58
      friend class LedaGraphWrapper;
marci@189
    59
      //friend class Edge;
marci@189
    60
      friend class EdgeIt;
marci@189
    61
      friend class InEdgeIt;
marci@189
    62
      friend class OutEdgeIt;
marci@189
    63
    protected:
marci@189
    64
      template <typename T> friend class NodeMap;
marci@189
    65
      leda_node _n;
marci@189
    66
      Node(leda_node __n) : _n(__n) { } 
marci@189
    67
    public:
marci@189
    68
      /// @warning The default constructor sets the iterator
marci@189
    69
      /// to an undefined value.
marci@189
    70
      Node() {}   //FIXME
marci@189
    71
      /// Initialize the iterator to be invalid
marci@189
    72
      Node(Invalid) : _n(0) { }
marci@189
    73
      //Node(const Node &) {} 
marci@189
    74
      bool operator==(Node n) const { return _n==n._n; } //FIXME
marci@189
    75
      bool operator!=(Node n) const { return _n!=n._n; } //FIXME
marci@198
    76
      operator leda_node () { return _n; }
marci@189
    77
    };
marci@189
    78
    
marci@189
    79
    /// This iterator goes through each node.
marci@189
    80
    class NodeIt : public Node {
marci@189
    81
    public:
marci@189
    82
      /// @warning The default constructor sets the iterator
marci@189
    83
      /// to an undefined value.
marci@189
    84
      NodeIt() {} //FIXME
marci@189
    85
      /// Initialize the iterator to be invalid
marci@189
    86
      NodeIt(Invalid i) : Node(i) {}
marci@189
    87
      /// Sets the iterator to the first node of \c G.
marci@189
    88
      NodeIt(const LedaGraphWrapper &G) : Node(G._graph->first_node()) { }
marci@189
    89
      //NodeIt(const NodeIt &) {} //FIXME
marci@189
    90
    };
marci@189
    91
    
marci@189
    92
    /// The base type of the edge iterators.
marci@189
    93
    class Edge {
marci@189
    94
      friend class LedaGraphWrapper;
marci@189
    95
    protected:
marci@189
    96
      template <typename T> friend class EdgeMap;
marci@189
    97
      leda_edge _e;
marci@189
    98
      Edge(leda_edge __e) : _e(__e) { } 
marci@189
    99
    public:
marci@189
   100
      /// @warning The default constructor sets the iterator
marci@189
   101
      /// to an undefined value.
marci@189
   102
      Edge() {}   //FIXME
marci@189
   103
      /// Initialize the iterator to be invalid
marci@189
   104
      Edge(Invalid) : _e(0) {}
marci@189
   105
      //Edge(const Edge &) {} 
marci@189
   106
      bool operator==(Edge e) const { return _e==e._e; } //FIXME
marci@198
   107
      bool operator!=(Edge e) const { return _e!=e._e; } //FIXME 
marci@198
   108
      operator leda_edge () { return _e; }
marci@189
   109
    };
marci@189
   110
    
marci@189
   111
    /// This iterator goes trought the outgoing edges of a certain graph.
marci@189
   112
    
marci@189
   113
    class OutEdgeIt : public Edge {
marci@189
   114
    public:
marci@189
   115
      /// @warning The default constructor sets the iterator
marci@189
   116
      /// to an undefined value.
marci@189
   117
      OutEdgeIt() {}
marci@189
   118
      /// Initialize the iterator to be invalid
marci@189
   119
      OutEdgeIt(Invalid i) : Edge(i) {}
marci@189
   120
      /// This constructor sets the iterator to first outgoing edge.
marci@189
   121
    
marci@189
   122
      /// This constructor set the iterator to the first outgoing edge of
marci@189
   123
      /// node
marci@189
   124
      ///@param n the node
marci@189
   125
      ///@param G the graph
marci@189
   126
      OutEdgeIt(const LedaGraphWrapper & G, Node n) : Edge(G._graph->first_adj_edge(n._n)) { }
marci@189
   127
    };
marci@189
   128
marci@189
   129
    class InEdgeIt : public Edge {
marci@189
   130
    public:
marci@189
   131
      /// @warning The default constructor sets the iterator
marci@189
   132
      /// to an undefined value.
marci@189
   133
      InEdgeIt() {}
marci@189
   134
      /// Initialize the iterator to be invalid
marci@189
   135
      InEdgeIt(Invalid i) : Edge(i) {}
marci@189
   136
      InEdgeIt(const LedaGraphWrapper & G, Node n) : Edge(G._graph->first_in_edge(n._n)) { }
marci@189
   137
    };
marci@189
   138
marci@189
   139
    //  class SymEdgeIt : public Edge {};
marci@189
   140
    class EdgeIt : public Edge {
marci@189
   141
    public:
marci@189
   142
      /// @warning The default constructor sets the iterator
marci@189
   143
      /// to an undefined value.
marci@189
   144
      EdgeIt() {}
marci@189
   145
      /// Initialize the iterator to be invalid
marci@189
   146
      EdgeIt(Invalid i) : Edge(i) {}
marci@189
   147
      EdgeIt(const LedaGraphWrapper & G) : Edge(G._graph->first_edge()) { }
marci@189
   148
    };
marci@189
   149
marci@189
   150
    /// First node of the graph.
marci@189
   151
marci@189
   152
    /// \post \c i and the return value will be the first node.
marci@189
   153
    ///
marci@189
   154
    NodeIt &first(NodeIt &i) const { i=NodeIt(*this); return i; }
marci@189
   155
marci@189
   156
    /// The first outgoing edge.
marci@189
   157
    InEdgeIt &first(InEdgeIt &i, Node n) const { 
marci@189
   158
      i=InEdgeIt(*this, n); 
marci@189
   159
      return i;
marci@189
   160
    }
marci@189
   161
    /// The first incoming edge.
marci@189
   162
    OutEdgeIt &first(OutEdgeIt &i, Node n) const { 
marci@189
   163
      i=OutEdgeIt(*this, n); 
marci@189
   164
      return i;
marci@189
   165
    }
marci@189
   166
    //  SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
marci@189
   167
    /// The first edge of the Graph.
marci@189
   168
    EdgeIt &first(EdgeIt &i) const {      
marci@189
   169
      i=EdgeIt(*this); 
marci@189
   170
      return i; }
marci@189
   171
marci@189
   172
//     Node getNext(Node) const {}
marci@189
   173
//     InEdgeIt getNext(InEdgeIt) const {}
marci@189
   174
//     OutEdgeIt getNext(OutEdgeIt) const {}
marci@189
   175
//     //SymEdgeIt getNext(SymEdgeIt) const {}
marci@189
   176
//     EdgeIt getNext(EdgeIt) const {}
marci@189
   177
marci@189
   178
    /// Go to the next node.
marci@189
   179
    NodeIt &next(NodeIt &i) const { 
marci@189
   180
      i._n=_graph->succ_node(i._n); 
marci@189
   181
      return i; 
marci@189
   182
    }
marci@189
   183
    /// Go to the next incoming edge.
marci@189
   184
    InEdgeIt &next(InEdgeIt &i) const { 
marci@189
   185
      i._e=_graph->in_succ(i._e); 
marci@189
   186
      return i;
marci@189
   187
    }
marci@189
   188
    /// Go to the next outgoing edge.
marci@189
   189
    OutEdgeIt &next(OutEdgeIt &i) const { 
marci@189
   190
      i._e=_graph->adj_succ(i._e); 
marci@189
   191
      return i;
marci@189
   192
    }
marci@189
   193
    //SymEdgeIt &next(SymEdgeIt &) const {}
marci@189
   194
    /// Go to the next edge.
marci@189
   195
    EdgeIt &next(EdgeIt &i) const {      
marci@189
   196
      i._e=_graph->succ_edge(i._e); 
marci@189
   197
      return i; 
marci@189
   198
    }
marci@189
   199
marci@409
   200
//     template< typename It >
marci@409
   201
//     It first() const { 
marci@409
   202
//       It e;
marci@409
   203
//       first(e);
marci@409
   204
//       return e; 
marci@409
   205
//     }
marci@189
   206
marci@409
   207
//     template< typename It >
marci@409
   208
//     It first(Node v) const { 
marci@409
   209
//       It e;
marci@409
   210
//       first(e, v);
marci@409
   211
//       return e; 
marci@409
   212
//     }
marci@189
   213
marci@189
   214
    ///Gives back the head node of an edge.
marci@189
   215
    Node head(Edge e) const { 
marci@189
   216
      return Node(_graph->target(e._e)); 
marci@189
   217
    }
marci@189
   218
    ///Gives back the tail node of an edge.
marci@189
   219
    Node tail(Edge e) const { 
marci@189
   220
      return Node(_graph->source(e._e)); 
marci@189
   221
    }
marci@189
   222
  
marci@189
   223
    Node aNode(InEdgeIt e) const { return head(e); }
marci@189
   224
    Node aNode(OutEdgeIt e) const { return tail(e); }
marci@189
   225
    //   Node aNode(SymEdgeIt) const {}
marci@189
   226
marci@189
   227
    Node bNode(InEdgeIt e) const { return tail(e); }
marci@189
   228
    Node bNode(OutEdgeIt e) const { return head(e); }
marci@189
   229
    //   Node bNode(SymEdgeIt) const {}
marci@189
   230
marci@189
   231
    /// Checks if a node iterator is valid
marci@189
   232
    bool valid(Node n) const { return n._n; }
marci@189
   233
    /// Checks if an edge iterator is valid
marci@189
   234
    bool valid(Edge e) const { return e._e; }
marci@189
   235
marci@189
   236
    ///Gives back the \e id of a node.
marci@189
   237
    int id(Node n) const { return n._n->id(); }
marci@189
   238
    ///Gives back the \e id of an edge.
marci@189
   239
    int id(Edge e) const { return e._e->id(); }
marci@189
   240
marci@189
   241
    //void setInvalid(Node &) const {};
marci@189
   242
    //void setInvalid(Edge &) const {};
marci@189
   243
  
marci@189
   244
    Node addNode() const { return Node(_graph->new_node()); }
marci@189
   245
    Edge addEdge(Node tail, Node head) const { 
marci@189
   246
      return Edge(_graph->new_edge(tail._n, head._n));
marci@189
   247
    }
marci@189
   248
    
marci@189
   249
    void erase(Node n) const { _graph->del_node(n._n); }
marci@189
   250
    void erase(Edge e) const { _graph->del_edge(e._e); }
marci@189
   251
marci@189
   252
    void clear() const { _graph->clear(); }
marci@189
   253
marci@189
   254
    int nodeNum() const { return _graph->number_of_nodes(); }
marci@189
   255
    int edgeNum() const { return _graph->number_of_edges(); }
marci@189
   256
marci@189
   257
    ///Read/write map from the nodes to type \c T.
marci@189
   258
    template<typename T> class NodeMap
marci@189
   259
    {
marci@189
   260
      leda_node_map<T> leda_stuff;
marci@189
   261
    public:
marci@189
   262
      typedef T ValueType;
marci@189
   263
      typedef Node KeyType;
marci@189
   264
marci@189
   265
      NodeMap(const LedaGraphWrapper &G) : leda_stuff(*(G._graph)) {}
marci@189
   266
      NodeMap(const LedaGraphWrapper &G, T t) : leda_stuff(*(G._graph), t) {}
marci@189
   267
marci@189
   268
      void set(Node i, T t) { leda_stuff[i._n]=t; }
marci@189
   269
      T get(Node i) const { return leda_stuff[i._n]; }  //FIXME: Is it necessary
marci@189
   270
      T &operator[](Node i) { return leda_stuff[i._n]; }
marci@189
   271
      const T &operator[](Node i) const { return leda_stuff[i._n]; }
marci@189
   272
marci@189
   273
      void update() { /*leda_stuff.init(leda_stuff.get_graph());*/ }
marci@189
   274
      //void update(T a) { leda_stuff.init(leda_stuff.get_graph()/**(G._graph)*/, a); }   //FIXME: Is it necessary
marci@189
   275
    };
marci@189
   276
marci@189
   277
    ///Read/write map from the edges to type \c T.
marci@189
   278
    template<typename T> class EdgeMap
marci@189
   279
    {
marci@189
   280
      leda_edge_map<T> leda_stuff;
marci@189
   281
    public:
marci@189
   282
      typedef T ValueType;
marci@189
   283
      typedef Edge KeyType;
marci@189
   284
marci@189
   285
      EdgeMap(const LedaGraphWrapper &G) : leda_stuff(*(G._graph)) {}
marci@189
   286
      EdgeMap(const LedaGraphWrapper &G, T t) : leda_stuff(*(G._graph), t) {}
marci@189
   287
marci@189
   288
      void set(Edge i, T t) { leda_stuff[i._e]=t; }
marci@189
   289
      T get(Edge i) const { return leda_stuff[i._e]; }  //FIXME: Is it necessary
marci@189
   290
      T &operator[](Edge i) { return leda_stuff[i._e]; }
marci@189
   291
      const T &operator[](Edge i) const { return leda_stuff[i._e]; }
marci@189
   292
marci@189
   293
      void update() { /*leda_stuff.init(leda_stuff.get_graph());*/ }
marci@189
   294
      //void update(T a) { leda_stuff.init(leda_stuff.get_graph()/**(G._graph)*/, a); }   //FIXME: Is it necessary
marci@189
   295
    };
marci@189
   296
marci@189
   297
  };
marci@189
   298
marci@189
   299
  // @}
marci@189
   300
marci@189
   301
} //namespace hugo
marci@189
   302
marci@189
   303
marci@189
   304
marci@189
   305
// class EmptyBipGraph : public EmptyGraph
marci@189
   306
// {
marci@189
   307
//   class ANode {};
marci@189
   308
//   class BNode {};
marci@189
   309
marci@189
   310
//   ANode &next(ANode &) {}
marci@189
   311
//   BNode &next(BNode &) {}
marci@189
   312
marci@189
   313
//   ANode &getFirst(ANode &) const {}
marci@189
   314
//   BNode &getFirst(BNode &) const {}
marci@189
   315
marci@189
   316
//   enum NodeClass { A = 0, B = 1 };
marci@189
   317
//   NodeClass getClass(Node n) {}
marci@189
   318
marci@189
   319
// }
marci@189
   320
marci@189
   321
#endif // HUGO_LEDA_GRAPH_WRAPPER_H