COIN-OR::LEMON - Graph Library

source: lemon-0.x/src/hugo/smart_graph.h @ 584:1d4855f5312e

Last change on this file since 584:1d4855f5312e was 579:859f8c7e2a40, checked in by Alpar Juttner, 17 years ago

EdgeSet? is more or less working.

File size: 17.3 KB
Line 
1// -*- mode:C++ -*-
2
3#ifndef HUGO_SMART_GRAPH_H
4#define HUGO_SMART_GRAPH_H
5
6///\ingroup graphs
7///\file
8///\brief SmartGraph and SymSmartGraph classes.
9
10#include <vector>
11#include <limits.h>
12
13#include <hugo/invalid.h>
14
15namespace hugo {
16
17/// \addtogroup graphs
18/// @{
19  class SymSmartGraph;
20
21  ///A smart graph class.
22
23  ///This is a simple and fast graph implementation.
24  ///It is also quite memory efficient, but at the price
25  ///that <b> it does not support node and edge deletion</b>.
26  ///It conforms to the graph interface documented under
27  ///the description of \ref GraphSkeleton.
28  ///\sa \ref GraphSkeleton.
29  ///
30  ///\todo Some member functions could be \c static.
31  ///\author Alpar Juttner
32  class SmartGraph {
33
34    struct NodeT
35    {
36      int first_in,first_out;     
37      NodeT() : first_in(-1), first_out(-1) {}
38    };
39    struct EdgeT
40    {
41      int head, tail, next_in, next_out;     
42      //FIXME: is this necessary?
43      EdgeT() : next_in(-1), next_out(-1) {} 
44    };
45
46    std::vector<NodeT> nodes;
47
48    std::vector<EdgeT> edges;
49   
50    protected:
51   
52    template <typename Key> class DynMapBase
53    {
54    protected:
55      const SmartGraph* G;
56    public:
57      virtual void add(const Key k) = 0;
58      virtual void erase(const Key k) = 0;
59      DynMapBase(const SmartGraph &_G) : G(&_G) {}
60      virtual ~DynMapBase() {}
61      friend class SmartGraph;
62    };
63   
64  public:
65    template <typename T> class EdgeMap;
66    template <typename T> class EdgeMap;
67
68    class Node;
69    class Edge;
70
71    //  protected:
72    // HELPME:
73  protected:
74    ///\bug It must be public because of SymEdgeMap.
75    ///
76    mutable std::vector<DynMapBase<Node> * > dyn_node_maps;
77    ///\bug It must be public because of SymEdgeMap.
78    ///
79    mutable std::vector<DynMapBase<Edge> * > dyn_edge_maps;
80   
81  public:
82
83
84    class NodeIt;
85    class EdgeIt;
86    class OutEdgeIt;
87    class InEdgeIt;
88   
89    template <typename T> class NodeMap;
90    template <typename T> class EdgeMap;
91   
92  public:
93
94    SmartGraph() : nodes(), edges() { }
95    SmartGraph(const SmartGraph &_g) : nodes(_g.nodes), edges(_g.edges) { }
96   
97    ~SmartGraph()
98    {
99      for(std::vector<DynMapBase<Node> * >::iterator i=dyn_node_maps.begin();
100          i!=dyn_node_maps.end(); ++i) (**i).G=NULL;
101      for(std::vector<DynMapBase<Edge> * >::iterator i=dyn_edge_maps.begin();
102          i!=dyn_edge_maps.end(); ++i) (**i).G=NULL;
103    }
104
105    int nodeNum() const { return nodes.size(); }  //FIXME: What is this?
106    int edgeNum() const { return edges.size(); }  //FIXME: What is this?
107
108    ///\bug This function does something different than
109    ///its name would suggests...
110    int maxNodeId() const { return nodes.size(); }  //FIXME: What is this?
111    ///\bug This function does something different than
112    ///its name would suggests...
113    int maxEdgeId() const { return edges.size(); }  //FIXME: What is this?
114
115    Node tail(Edge e) const { return edges[e.n].tail; }
116    Node head(Edge e) const { return edges[e.n].head; }
117
118    Node aNode(OutEdgeIt e) const { return edges[e.n].tail; }
119    Node aNode(InEdgeIt e) const { return edges[e.n].head; }
120
121    Node bNode(OutEdgeIt e) const { return edges[e.n].head; }
122    Node bNode(InEdgeIt e) const { return edges[e.n].tail; }
123
124    NodeIt& first(NodeIt& v) const {
125      v=NodeIt(*this); return v; }
126    EdgeIt& first(EdgeIt& e) const {
127      e=EdgeIt(*this); return e; }
128    OutEdgeIt& first(OutEdgeIt& e, const Node v) const {
129      e=OutEdgeIt(*this,v); return e; }
130    InEdgeIt& first(InEdgeIt& e, const Node v) const {
131      e=InEdgeIt(*this,v); return e; }
132
133//     template< typename It >
134//     It first() const { It e; first(e); return e; }
135
136//     template< typename It >
137//     It first(Node v) const { It e; first(e,v); return e; }
138
139    bool valid(Edge e) const { return e.n!=-1; }
140    bool valid(Node n) const { return n.n!=-1; }
141   
142    ///\deprecated Use
143    ///\code
144    ///  e=INVALID;
145    ///\endcode
146    ///instead.
147    void setInvalid(Edge &e) { e.n=-1; }
148    ///\deprecated Use
149    ///\code
150    ///  e=INVALID;
151    ///\endcode
152    ///instead.
153    void setInvalid(Node &n) { n.n=-1; }
154   
155    template <typename It> It getNext(It it) const
156    { It tmp(it); return next(tmp); }
157
158    NodeIt& next(NodeIt& it) const {
159      it.n=(it.n+2)%(nodes.size()+1)-1;
160      return it;
161    }
162    OutEdgeIt& next(OutEdgeIt& it) const
163    { it.n=edges[it.n].next_out; return it; }
164    InEdgeIt& next(InEdgeIt& it) const
165    { it.n=edges[it.n].next_in; return it; }
166    EdgeIt& next(EdgeIt& it) const { --it.n; return it; }
167
168    int id(Node v) const { return v.n; }
169    int id(Edge e) const { return e.n; }
170
171    Node addNode() {
172      Node n; n.n=nodes.size();
173      nodes.push_back(NodeT()); //FIXME: Hmmm...
174
175      for(std::vector<DynMapBase<Node> * >::iterator i=dyn_node_maps.begin();
176          i!=dyn_node_maps.end(); ++i) (**i).add(n);
177
178      return n;
179    }
180   
181    Edge addEdge(Node u, Node v) {
182      Edge e; e.n=edges.size(); edges.push_back(EdgeT()); //FIXME: Hmmm...
183      edges[e.n].tail=u.n; edges[e.n].head=v.n;
184      edges[e.n].next_out=nodes[u.n].first_out;
185      edges[e.n].next_in=nodes[v.n].first_in;
186      nodes[u.n].first_out=nodes[v.n].first_in=e.n;
187
188      for(std::vector<DynMapBase<Edge> * >::iterator i=dyn_edge_maps.begin();
189          i!=dyn_edge_maps.end(); ++i) (**i).add(e);
190
191      return e;
192    }
193
194    void clear() {nodes.clear();edges.clear();}
195
196    class Node {
197      friend class SmartGraph;
198      template <typename T> friend class NodeMap;
199     
200      friend class Edge;
201      friend class OutEdgeIt;
202      friend class InEdgeIt;
203      friend class SymEdge;
204
205    protected:
206      int n;
207      friend int SmartGraph::id(Node v) const;
208      Node(int nn) {n=nn;}
209    public:
210      Node() {}
211      Node (Invalid) { n=-1; }
212      bool operator==(const Node i) const {return n==i.n;}
213      bool operator!=(const Node i) const {return n!=i.n;}
214      bool operator<(const Node i) const {return n<i.n;}
215    };
216   
217    class NodeIt : public Node {
218      friend class SmartGraph;
219    public:
220      NodeIt() : Node() { }
221      NodeIt(Invalid i) : Node(i) { }
222      NodeIt(const SmartGraph& G) : Node(G.nodes.size()?0:-1) { }
223      ///\todo Undocumented conversion Node -\> NodeIt.
224      NodeIt(const SmartGraph& G, const Node &n) : Node(n) { }
225    };
226
227    class Edge {
228      friend class SmartGraph;
229      template <typename T> friend class EdgeMap;
230
231      //template <typename T> friend class SymSmartGraph::SymEdgeMap;     
232      //friend Edge SymSmartGraph::opposite(Edge) const;
233     
234      friend class Node;
235      friend class NodeIt;
236    protected:
237      int n;
238      friend int SmartGraph::id(Edge e) const;
239
240      Edge(int nn) {n=nn;}
241    public:
242      Edge() { }
243      Edge (Invalid) { n=-1; }
244      bool operator==(const Edge i) const {return n==i.n;}
245      bool operator!=(const Edge i) const {return n!=i.n;}
246      bool operator<(const Edge i) const {return n<i.n;}
247      ///\bug This is a workaround until somebody tells me how to
248      ///make class \c SymSmartGraph::SymEdgeMap friend of Edge
249      int &idref() {return n;}
250      const int &idref() const {return n;}
251    };
252   
253    class EdgeIt : public Edge {
254      friend class SmartGraph;
255    public:
256      EdgeIt(const SmartGraph& G) : Edge(G.edges.size()-1) { }
257      EdgeIt (Invalid i) : Edge(i) { }
258      EdgeIt() : Edge() { }
259      ///\bug This is a workaround until somebody tells me how to
260      ///make class \c SymSmartGraph::SymEdgeMap friend of Edge
261      int &idref() {return n;}
262    };
263   
264    class OutEdgeIt : public Edge {
265      friend class SmartGraph;
266    public:
267      OutEdgeIt() : Edge() { }
268      OutEdgeIt (Invalid i) : Edge(i) { }
269
270      OutEdgeIt(const SmartGraph& G,const Node v)
271        : Edge(G.nodes[v.n].first_out) {}
272    };
273   
274    class InEdgeIt : public Edge {
275      friend class SmartGraph;
276    public:
277      InEdgeIt() : Edge() { }
278      InEdgeIt (Invalid i) : Edge(i) { }
279      InEdgeIt(const SmartGraph& G,Node v) :Edge(G.nodes[v.n].first_in){}
280    };
281
282    template <typename T> class NodeMap : public DynMapBase<Node>
283    {
284      std::vector<T> container;
285
286    public:
287      typedef T ValueType;
288      typedef Node KeyType;
289
290      NodeMap(const SmartGraph &_G) :
291        DynMapBase<Node>(_G), container(_G.maxNodeId())
292      {
293        G->dyn_node_maps.push_back(this);
294      }
295      NodeMap(const SmartGraph &_G,const T &t) :
296        DynMapBase<Node>(_G), container(_G.maxNodeId(),t)
297      {
298        G->dyn_node_maps.push_back(this);
299      }
300     
301      NodeMap(const NodeMap<T> &m) :
302        DynMapBase<Node>(*m.G), container(m.container)
303      {
304        G->dyn_node_maps.push_back(this);
305      }
306
307      template<typename TT> friend class NodeMap;
308 
309      ///\todo It can copy between different types.
310      ///
311      template<typename TT> NodeMap(const NodeMap<TT> &m) :
312        DynMapBase<Node>(*m.G)
313      {
314        G->dyn_node_maps.push_back(this);
315        typename std::vector<TT>::const_iterator i;
316        for(typename std::vector<TT>::const_iterator i=m.container.begin();
317            i!=m.container.end();
318            i++)
319          container.push_back(*i);
320      }
321      ~NodeMap()
322      {
323        if(G) {
324          std::vector<DynMapBase<Node>* >::iterator i;
325          for(i=G->dyn_node_maps.begin();
326              i!=G->dyn_node_maps.end() && *i!=this; ++i) ;
327          //if(*i==this) G->dyn_node_maps.erase(i); //FIXME: Way too slow...
328          //A better way to do that: (Is this really important?)
329          if(*i==this) {
330            *i=G->dyn_node_maps.back();
331            G->dyn_node_maps.pop_back();
332          }
333        }
334      }
335
336      void add(const Node k)
337      {
338        if(k.n>=int(container.size())) container.resize(k.n+1);
339      }
340
341      void erase(const Node) { }
342     
343      void set(Node n, T a) { container[n.n]=a; }
344      //'T& operator[](Node n)' would be wrong here
345      typename std::vector<T>::reference
346      operator[](Node n) { return container[n.n]; }
347      //'const T& operator[](Node n)' would be wrong here
348      typename std::vector<T>::const_reference
349      operator[](Node n) const { return container[n.n]; }
350
351      ///\warning There is no safety check at all!
352      ///Using operator = between maps attached to different graph may
353      ///cause serious problem.
354      ///\todo Is this really so?
355      ///\todo It can copy between different types.
356      const NodeMap<T>& operator=(const NodeMap<T> &m)
357      {
358        container = m.container;
359        return *this;
360      }
361      template<typename TT>
362      const NodeMap<T>& operator=(const NodeMap<TT> &m)
363      {
364        std::copy(m.container.begin(), m.container.end(), container.begin());
365        return *this;
366      }
367     
368      void update() {}    //Useless for Dynamic Maps
369      void update(T a) {}  //Useless for Dynamic Maps
370    };
371   
372    template <typename T> class EdgeMap : public DynMapBase<Edge>
373    {
374      std::vector<T> container;
375
376    public:
377      typedef T ValueType;
378      typedef Edge KeyType;
379
380      EdgeMap(const SmartGraph &_G) :
381        DynMapBase<Edge>(_G), container(_G.maxEdgeId())
382      {
383        //FIXME: What if there are empty Id's?
384        //FIXME: Can I use 'this' in a constructor?
385        G->dyn_edge_maps.push_back(this);
386      }
387      EdgeMap(const SmartGraph &_G,const T &t) :
388        DynMapBase<Edge>(_G), container(_G.maxEdgeId(),t)
389      {
390        G->dyn_edge_maps.push_back(this);
391      }
392      EdgeMap(const EdgeMap<T> &m) :
393        DynMapBase<Edge>(*m.G), container(m.container)
394      {
395        G->dyn_edge_maps.push_back(this);
396      }
397
398      template<typename TT> friend class EdgeMap;
399
400      ///\todo It can copy between different types.
401      ///
402      template<typename TT> EdgeMap(const EdgeMap<TT> &m) :
403        DynMapBase<Edge>(*m.G)
404      {
405        G->dyn_edge_maps.push_back(this);
406        typename std::vector<TT>::const_iterator i;
407        for(typename std::vector<TT>::const_iterator i=m.container.begin();
408            i!=m.container.end();
409            i++)
410          container.push_back(*i);
411      }
412      ~EdgeMap()
413      {
414        if(G) {
415          std::vector<DynMapBase<Edge>* >::iterator i;
416          for(i=G->dyn_edge_maps.begin();
417              i!=G->dyn_edge_maps.end() && *i!=this; ++i) ;
418          //if(*i==this) G->dyn_edge_maps.erase(i); //Way too slow...
419          //A better way to do that: (Is this really important?)
420          if(*i==this) {
421            *i=G->dyn_edge_maps.back();
422            G->dyn_edge_maps.pop_back();
423          }
424        }
425      }
426     
427      void add(const Edge k)
428      {
429        if(k.n>=int(container.size())) container.resize(k.n+1);
430      }
431      void erase(const Edge) { }
432     
433      void set(Edge n, T a) { container[n.n]=a; }
434      //T get(Edge n) const { return container[n.n]; }
435      typename std::vector<T>::reference
436      operator[](Edge n) { return container[n.n]; }
437      typename std::vector<T>::const_reference
438      operator[](Edge n) const { return container[n.n]; }
439
440      ///\warning There is no safety check at all!
441      ///Using operator = between maps attached to different graph may
442      ///cause serious problem.
443      ///\todo Is this really so?
444      ///\todo It can copy between different types.
445      const EdgeMap<T>& operator=(const EdgeMap<T> &m)
446      {
447        container = m.container;
448        return *this;
449      }
450      template<typename TT>
451      const EdgeMap<T>& operator=(const EdgeMap<TT> &m)
452      {
453        std::copy(m.container.begin(), m.container.end(), container.begin());
454        return *this;
455      }
456     
457      void update() {}    //Useless for DynMaps
458      void update(T a) {}  //Useless for DynMaps
459    };
460
461  };
462
463  ///Graph for bidirectional edges.
464
465  ///The purpose of this graph structure is to handle graphs
466  ///having bidirectional edges. Here the function \c addEdge(u,v) adds a pair
467  ///of oppositely directed edges.
468  ///There is a new edge map type called
469  ///\ref SymSmartGraph::SymEdgeMap "SymEdgeMap"
470  ///that complements this
471  ///feature by
472  ///storing shared values for the edge pairs. The usual
473  ///\ref GraphSkeleton::EdgeMap "EdgeMap"
474  ///can be used
475  ///as well.
476  ///
477  ///The oppositely directed edge can also be obtained easily
478  ///using \ref opposite.
479  ///\warning It shares the similarity with \ref SmartGraph that
480  ///it is not possible to delete edges or nodes from the graph.
481  //\sa \ref SmartGraph.
482
483  class SymSmartGraph : public SmartGraph
484  {
485  public:
486    template<typename T> class SymEdgeMap;
487    template<typename T> friend class SymEdgeMap;
488
489    SymSmartGraph() : SmartGraph() { }
490    SymSmartGraph(const SmartGraph &_g) : SmartGraph(_g) { }
491    ///Adds a pair of oppositely directed edges to the graph.
492    Edge addEdge(Node u, Node v)
493    {
494      Edge e = SmartGraph::addEdge(u,v);
495      SmartGraph::addEdge(v,u);
496      return e;
497    }
498
499    ///The oppositely directed edge.
500
501    ///Returns the oppositely directed
502    ///pair of the edge \c e.
503    Edge opposite(Edge e) const
504    {
505      Edge f;
506      f.idref() = e.idref() - 2*(e.idref()%2) + 1;
507      return f;
508    }
509   
510    ///Common data storage for the edge pairs.
511
512    ///This map makes it possible to store data shared by the oppositely
513    ///directed pairs of edges.
514    template <typename T> class SymEdgeMap : public DynMapBase<Edge>
515    {
516      std::vector<T> container;
517     
518    public:
519      typedef T ValueType;
520      typedef Edge KeyType;
521
522      SymEdgeMap(const SymSmartGraph &_G) :
523        DynMapBase<Edge>(_G), container(_G.maxEdgeId()/2)
524      {
525        static_cast<const SymSmartGraph*>(G)->dyn_edge_maps.push_back(this);
526      }
527      SymEdgeMap(const SymSmartGraph &_G,const T &t) :
528        DynMapBase<Edge>(_G), container(_G.maxEdgeId()/2,t)
529      {
530        G->dyn_edge_maps.push_back(this);
531      }
532
533      SymEdgeMap(const SymEdgeMap<T> &m) :
534        DynMapBase<SymEdge>(*m.G), container(m.container)
535      {
536        G->dyn_node_maps.push_back(this);
537      }
538
539      //      template<typename TT> friend class SymEdgeMap;
540
541      ///\todo It can copy between different types.
542      ///
543
544      template<typename TT> SymEdgeMap(const SymEdgeMap<TT> &m) :
545        DynMapBase<SymEdge>(*m.G)
546      {
547        G->dyn_node_maps.push_back(this);
548        typename std::vector<TT>::const_iterator i;
549        for(typename std::vector<TT>::const_iterator i=m.container.begin();
550            i!=m.container.end();
551            i++)
552          container.push_back(*i);
553      }
554 
555      ~SymEdgeMap()
556      {
557        if(G) {
558          std::vector<DynMapBase<Edge>* >::iterator i;
559          for(i=static_cast<const SymSmartGraph*>(G)->dyn_edge_maps.begin();
560              i!=static_cast<const SymSmartGraph*>(G)->dyn_edge_maps.end()
561                && *i!=this; ++i) ;
562          //if(*i==this) G->dyn_edge_maps.erase(i); //Way too slow...
563          //A better way to do that: (Is this really important?)
564          if(*i==this) {
565            *i=static_cast<const SymSmartGraph*>(G)->dyn_edge_maps.back();
566            static_cast<const SymSmartGraph*>(G)->dyn_edge_maps.pop_back();
567          }
568        }
569      }
570     
571      void add(const Edge k)
572      {
573        if(!k.idref()%2&&k.idref()/2>=int(container.size()))
574          container.resize(k.idref()/2+1);
575      }
576      void erase(const Edge k) { }
577     
578      void set(Edge n, T a) { container[n.idref()/2]=a; }
579      //T get(Edge n) const { return container[n.idref()/2]; }
580      typename std::vector<T>::reference
581      operator[](Edge n) { return container[n.idref()/2]; }
582      typename std::vector<T>::const_reference
583      operator[](Edge n) const { return container[n.idref()/2]; }
584
585      ///\warning There is no safety check at all!
586      ///Using operator = between maps attached to different graph may
587      ///cause serious problem.
588      ///\todo Is this really so?
589      ///\todo It can copy between different types.
590      const SymEdgeMap<T>& operator=(const SymEdgeMap<T> &m)
591      {
592        container = m.container;
593        return *this;
594      }
595      template<typename TT>
596      const SymEdgeMap<T>& operator=(const SymEdgeMap<TT> &m)
597      {
598        std::copy(m.container.begin(), m.container.end(), container.begin());
599        return *this;
600      }
601     
602      void update() {}    //Useless for DynMaps
603      void update(T a) {}  //Useless for DynMaps
604
605    };
606
607  };
608 
609  /// @} 
610
611} //namespace hugo
612
613
614
615
616#endif //SMART_GRAPH_H
Note: See TracBrowser for help on using the repository browser.