src/work/marci/leda/leda_graph_wrapper.h
author marci
Fri, 14 May 2004 14:41:30 +0000
changeset 636 e59b0c363a9e
parent 616 31879aac4dc3
child 646 bd7a69231cf8
permissions -rw-r--r--
(none)
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@616
    17
#include <hugo/invalid.h>
marci@189
    18
marci@189
    19
namespace hugo {
marci@189
    20
marci@617
    21
  /// \brief A graph wrapper structure for wrapping LEDA graphs in HUGO.
marci@617
    22
  ///
marci@617
    23
  /// This graph wrapper class wraps LEDA graphs and LEDA parametrized graphs
marci@617
    24
  /// to satisfy HUGO graph concepts.
marci@617
    25
  /// Then the generic HUGOlib algorithms and wrappers can be used 
marci@409
    26
  /// with LEDA graphs. 
marci@617
    27
  /// \ingroup gwrapper
marci@189
    28
  template<typename Graph>
marci@189
    29
  class LedaGraphWrapper
marci@189
    30
  {
marci@473
    31
  protected:
marci@617
    32
    Graph* l_graph;
marci@617
    33
    LedaGraphWrapper() : l_graph(0) { }
marci@617
    34
    void setGraph(Graph& _l_graph) { l_graph=&_l_graph; }
marci@189
    35
  public:
marci@189
    36
   
marci@189
    37
        //LedaGraphWrapper() { }
marci@617
    38
    LedaGraphWrapper(Graph& _l_graph) : l_graph(&_l_graph) { }
marci@617
    39
    LedaGraphWrapper(const LedaGraphWrapper &G) : l_graph(G.l_graph) { }
marci@189
    40
marci@189
    41
    template <typename T> class NodeMap;
marci@189
    42
    template <typename T> class EdgeMap;
marci@189
    43
marci@461
    44
    class Node;
marci@461
    45
    class NodeIt;
marci@461
    46
    class Edge;
marci@461
    47
    class EdgeIt;
marci@461
    48
    class OutEdgeIt;
marci@461
    49
    class InEdgeIt;
marci@461
    50
marci@189
    51
    /// The base type of the node iterators.
marci@189
    52
    class Node {
marci@461
    53
      friend class LedaGraphWrapper<Graph>;
marci@189
    54
      //friend class Edge;
marci@189
    55
      friend class EdgeIt;
marci@189
    56
      friend class InEdgeIt;
marci@189
    57
      friend class OutEdgeIt;
marci@189
    58
    protected:
marci@189
    59
      template <typename T> friend class NodeMap;
marci@617
    60
      leda_node l_n;
marci@446
    61
    public: //FIXME
marci@617
    62
      Node(leda_node _l_n) : l_n(_l_n) { } 
marci@189
    63
    public:
marci@189
    64
      /// @warning The default constructor sets the iterator
marci@189
    65
      /// to an undefined value.
marci@189
    66
      Node() {}   //FIXME
marci@189
    67
      /// Initialize the iterator to be invalid
marci@617
    68
      Node(Invalid) : l_n(0) { }
marci@189
    69
      //Node(const Node &) {} 
marci@617
    70
      bool operator==(Node n) const { return l_n==n.l_n; } //FIXME
marci@617
    71
      bool operator!=(Node n) const { return l_n!=n.l_n; } //FIXME
marci@617
    72
      operator leda_node () { return l_n; }
marci@189
    73
    };
marci@189
    74
    
marci@189
    75
    /// This iterator goes through each node.
marci@189
    76
    class NodeIt : public Node {
marci@189
    77
    public:
marci@189
    78
      /// @warning The default constructor sets the iterator
marci@189
    79
      /// to an undefined value.
marci@189
    80
      NodeIt() {} //FIXME
marci@189
    81
      /// Initialize the iterator to be invalid
marci@189
    82
      NodeIt(Invalid i) : Node(i) {}
marci@189
    83
      /// Sets the iterator to the first node of \c G.
marci@617
    84
      NodeIt(const LedaGraphWrapper &G) : Node(G.l_graph->first_node()) { }
marci@189
    85
      //NodeIt(const NodeIt &) {} //FIXME
marci@189
    86
    };
marci@189
    87
    
marci@189
    88
    /// The base type of the edge iterators.
marci@189
    89
    class Edge {
marci@189
    90
      friend class LedaGraphWrapper;
marci@189
    91
    protected:
marci@189
    92
      template <typename T> friend class EdgeMap;
marci@617
    93
      leda_edge l_e;
marci@446
    94
    public: //FIXME
marci@617
    95
      Edge(leda_edge _l_e) : l_e(_l_e) { } 
marci@189
    96
    public:
marci@189
    97
      /// @warning The default constructor sets the iterator
marci@189
    98
      /// to an undefined value.
marci@189
    99
      Edge() {}   //FIXME
marci@189
   100
      /// Initialize the iterator to be invalid
marci@617
   101
      Edge(Invalid) : l_e(0) {}
marci@189
   102
      //Edge(const Edge &) {} 
marci@617
   103
      bool operator==(Edge e) const { return l_e==e.l_e; } //FIXME
marci@617
   104
      bool operator!=(Edge e) const { return l_e!=e.l_e; } //FIXME 
marci@617
   105
      operator leda_edge () { return l_e; }
marci@189
   106
    };
marci@189
   107
    
marci@189
   108
    /// This iterator goes trought the outgoing edges of a certain graph.
marci@189
   109
    
marci@189
   110
    class OutEdgeIt : public Edge {
marci@189
   111
    public:
marci@189
   112
      /// @warning The default constructor sets the iterator
marci@189
   113
      /// to an undefined value.
marci@189
   114
      OutEdgeIt() {}
marci@189
   115
      /// Initialize the iterator to be invalid
marci@189
   116
      OutEdgeIt(Invalid i) : Edge(i) {}
marci@189
   117
      /// This constructor sets the iterator to first outgoing edge.
marci@189
   118
    
marci@189
   119
      /// This constructor set the iterator to the first outgoing edge of
marci@189
   120
      /// node
marci@189
   121
      ///@param n the node
marci@189
   122
      ///@param G the graph
marci@617
   123
      OutEdgeIt(const LedaGraphWrapper & G, Node n) : Edge(G.l_graph->first_adj_edge(n.l_n)) { }
marci@189
   124
    };
marci@189
   125
marci@189
   126
    class InEdgeIt : public Edge {
marci@189
   127
    public:
marci@189
   128
      /// @warning The default constructor sets the iterator
marci@189
   129
      /// to an undefined value.
marci@189
   130
      InEdgeIt() {}
marci@189
   131
      /// Initialize the iterator to be invalid
marci@189
   132
      InEdgeIt(Invalid i) : Edge(i) {}
marci@617
   133
      InEdgeIt(const LedaGraphWrapper & G, Node n) : Edge(G.l_graph->first_in_edge(n.l_n)) { }
marci@189
   134
    };
marci@189
   135
marci@189
   136
    //  class SymEdgeIt : public Edge {};
marci@189
   137
    class EdgeIt : public Edge {
marci@189
   138
    public:
marci@189
   139
      /// @warning The default constructor sets the iterator
marci@189
   140
      /// to an undefined value.
marci@189
   141
      EdgeIt() {}
marci@189
   142
      /// Initialize the iterator to be invalid
marci@189
   143
      EdgeIt(Invalid i) : Edge(i) {}
marci@617
   144
      EdgeIt(const LedaGraphWrapper & G) : Edge(G.l_graph->first_edge()) { }
marci@189
   145
    };
marci@189
   146
marci@189
   147
    /// First node of the graph.
marci@189
   148
marci@189
   149
    /// \post \c i and the return value will be the first node.
marci@189
   150
    ///
marci@189
   151
    NodeIt &first(NodeIt &i) const { i=NodeIt(*this); return i; }
marci@189
   152
marci@189
   153
    /// The first outgoing edge.
marci@189
   154
    InEdgeIt &first(InEdgeIt &i, Node n) const { 
marci@189
   155
      i=InEdgeIt(*this, n); 
marci@189
   156
      return i;
marci@189
   157
    }
marci@189
   158
    /// The first incoming edge.
marci@189
   159
    OutEdgeIt &first(OutEdgeIt &i, Node n) const { 
marci@189
   160
      i=OutEdgeIt(*this, n); 
marci@189
   161
      return i;
marci@189
   162
    }
marci@189
   163
    //  SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
marci@189
   164
    /// The first edge of the Graph.
marci@189
   165
    EdgeIt &first(EdgeIt &i) const {      
marci@189
   166
      i=EdgeIt(*this); 
marci@189
   167
      return i; }
marci@189
   168
marci@189
   169
//     Node getNext(Node) const {}
marci@189
   170
//     InEdgeIt getNext(InEdgeIt) const {}
marci@189
   171
//     OutEdgeIt getNext(OutEdgeIt) const {}
marci@189
   172
//     //SymEdgeIt getNext(SymEdgeIt) const {}
marci@189
   173
//     EdgeIt getNext(EdgeIt) const {}
marci@189
   174
marci@189
   175
    /// Go to the next node.
marci@189
   176
    NodeIt &next(NodeIt &i) const { 
marci@617
   177
      i.l_n=l_graph->succ_node(i.l_n); 
marci@189
   178
      return i; 
marci@189
   179
    }
marci@189
   180
    /// Go to the next incoming edge.
marci@189
   181
    InEdgeIt &next(InEdgeIt &i) const { 
marci@617
   182
      i.l_e=l_graph->in_succ(i.l_e); 
marci@189
   183
      return i;
marci@189
   184
    }
marci@189
   185
    /// Go to the next outgoing edge.
marci@189
   186
    OutEdgeIt &next(OutEdgeIt &i) const { 
marci@617
   187
      i.l_e=l_graph->adj_succ(i.l_e); 
marci@189
   188
      return i;
marci@189
   189
    }
marci@189
   190
    //SymEdgeIt &next(SymEdgeIt &) const {}
marci@189
   191
    /// Go to the next edge.
marci@189
   192
    EdgeIt &next(EdgeIt &i) const {      
marci@617
   193
      i.l_e=l_graph->succ_edge(i.l_e); 
marci@189
   194
      return i; 
marci@189
   195
    }
marci@189
   196
marci@409
   197
//     template< typename It >
marci@409
   198
//     It first() const { 
marci@409
   199
//       It e;
marci@409
   200
//       first(e);
marci@409
   201
//       return e; 
marci@409
   202
//     }
marci@189
   203
marci@409
   204
//     template< typename It >
marci@409
   205
//     It first(Node v) const { 
marci@409
   206
//       It e;
marci@409
   207
//       first(e, v);
marci@409
   208
//       return e; 
marci@409
   209
//     }
marci@189
   210
marci@189
   211
    ///Gives back the head node of an edge.
marci@189
   212
    Node head(Edge e) const { 
marci@617
   213
      return Node(l_graph->target(e.l_e)); 
marci@189
   214
    }
marci@189
   215
    ///Gives back the tail node of an edge.
marci@189
   216
    Node tail(Edge e) const { 
marci@617
   217
      return Node(l_graph->source(e.l_e)); 
marci@189
   218
    }
marci@189
   219
  
marci@189
   220
    Node aNode(InEdgeIt e) const { return head(e); }
marci@189
   221
    Node aNode(OutEdgeIt e) const { return tail(e); }
marci@189
   222
    //   Node aNode(SymEdgeIt) const {}
marci@189
   223
marci@189
   224
    Node bNode(InEdgeIt e) const { return tail(e); }
marci@189
   225
    Node bNode(OutEdgeIt e) const { return head(e); }
marci@189
   226
    //   Node bNode(SymEdgeIt) const {}
marci@189
   227
marci@189
   228
    /// Checks if a node iterator is valid
marci@617
   229
    bool valid(Node n) const { return n.l_n; }
marci@189
   230
    /// Checks if an edge iterator is valid
marci@617
   231
    bool valid(Edge e) const { return e.l_e; }
marci@189
   232
marci@189
   233
    ///Gives back the \e id of a node.
marci@617
   234
    int id(Node n) const { return n.l_n->id(); }
marci@189
   235
    ///Gives back the \e id of an edge.
marci@617
   236
    int id(Edge e) const { return e.l_e->id(); }
marci@189
   237
marci@189
   238
    //void setInvalid(Node &) const {};
marci@189
   239
    //void setInvalid(Edge &) const {};
marci@189
   240
  
marci@617
   241
    Node addNode() const { return Node(l_graph->new_node()); }
marci@189
   242
    Edge addEdge(Node tail, Node head) const { 
marci@617
   243
      return Edge(l_graph->new_edge(tail.l_n, head.l_n));
marci@189
   244
    }
marci@189
   245
    
marci@617
   246
    void erase(Node n) const { l_graph->del_node(n.l_n); }
marci@617
   247
    void erase(Edge e) const { l_graph->del_edge(e.l_e); }
marci@189
   248
marci@617
   249
    void clear() const { l_graph->clear(); }
marci@189
   250
marci@617
   251
    int nodeNum() const { return l_graph->number_of_nodes(); }
marci@617
   252
    int edgeNum() const { return l_graph->number_of_edges(); }
marci@189
   253
marci@189
   254
    ///Read/write map from the nodes to type \c T.
marci@189
   255
    template<typename T> class NodeMap
marci@189
   256
    {
marci@189
   257
      leda_node_map<T> leda_stuff;
marci@189
   258
    public:
marci@189
   259
      typedef T ValueType;
marci@189
   260
      typedef Node KeyType;
marci@189
   261
marci@617
   262
      NodeMap(const LedaGraphWrapper &G) : leda_stuff(*(G.l_graph)) {}
marci@617
   263
      NodeMap(const LedaGraphWrapper &G, T t) : leda_stuff(*(G.l_graph), t) {}
marci@189
   264
marci@617
   265
      void set(Node i, T t) { leda_stuff[i.l_n]=t; }
marci@617
   266
      T get(Node i) const { return leda_stuff[i.l_n]; }  //FIXME: Is it necessary
marci@617
   267
      T &operator[](Node i) { return leda_stuff[i.l_n]; }
marci@617
   268
      const T &operator[](Node i) const { return leda_stuff[i.l_n]; }
marci@189
   269
marci@189
   270
      void update() { /*leda_stuff.init(leda_stuff.get_graph());*/ }
marci@617
   271
      //void update(T a) { leda_stuff.init(leda_stuff.get_graph()/**(G.l_graph)*/, a); }   //FIXME: Is it necessary
marci@189
   272
    };
marci@189
   273
marci@189
   274
    ///Read/write map from the edges to type \c T.
marci@189
   275
    template<typename T> class EdgeMap
marci@189
   276
    {
marci@189
   277
      leda_edge_map<T> leda_stuff;
marci@189
   278
    public:
marci@189
   279
      typedef T ValueType;
marci@189
   280
      typedef Edge KeyType;
marci@189
   281
marci@617
   282
      EdgeMap(const LedaGraphWrapper &G) : leda_stuff(*(G.l_graph)) {}
marci@617
   283
      EdgeMap(const LedaGraphWrapper &G, T t) : leda_stuff(*(G.l_graph), t) {}
marci@189
   284
marci@617
   285
      void set(Edge i, T t) { leda_stuff[i.l_e]=t; }
marci@617
   286
      T get(Edge i) const { return leda_stuff[i.l_e]; }  //FIXME: Is it necessary
marci@617
   287
      T &operator[](Edge i) { return leda_stuff[i.l_e]; }
marci@617
   288
      const T &operator[](Edge i) const { return leda_stuff[i.l_e]; }
marci@189
   289
marci@189
   290
      void update() { /*leda_stuff.init(leda_stuff.get_graph());*/ }
marci@617
   291
      //void update(T a) { leda_stuff.init(leda_stuff.get_graph()/**(G.l_graph)*/, a); }   //FIXME: Is it necessary
marci@189
   292
    };
marci@189
   293
marci@189
   294
  };
marci@189
   295
marci@617
   296
marci@617
   297
  /// \brief LEDA graph template.
marci@617
   298
  ///
marci@617
   299
  /// This graph stucture uses LEDA graphs for physical storage.
marci@617
   300
  /// \ingroup graphs
marci@473
   301
  template<typename Graph>
marci@473
   302
  class LedaGraph : public LedaGraphWrapper<Graph> {
marci@473
   303
    typedef LedaGraphWrapper<Graph> Parent;
marci@473
   304
  protected:
marci@473
   305
    Graph gr;
marci@473
   306
  public:
marci@473
   307
    LedaGraph() { 
marci@473
   308
      Parent::setGraph(gr); 
marci@473
   309
    }
marci@473
   310
  };
marci@473
   311
marci@189
   312
} //namespace hugo
marci@189
   313
marci@189
   314
#endif // HUGO_LEDA_GRAPH_WRAPPER_H