COIN-OR::LEMON - Graph Library

source: lemon-0.x/src/work/marci/graph_wrapper.h @ 496:7c463a7635d4

Last change on this file since 496:7c463a7635d4 was 496:7c463a7635d4, checked in by marci, 20 years ago

gw

File size: 31.7 KB
RevLine 
[174]1// -*- c++ -*-
[259]2#ifndef HUGO_GRAPH_WRAPPER_H
3#define HUGO_GRAPH_WRAPPER_H
[76]4
[491]5///\ingroup gwrappers
[457]6///\file
7///\brief Several graph wrappers.
8///
9///This file contains several useful graph wrapper functions.
10///
11///\author Marton Makai
12
[174]13#include <invalid.h>
[368]14#include <iter_map.h>
[174]15
[105]16namespace hugo {
[76]17
[438]18  // Graph wrappers
19
[406]20  /// \addtogroup gwrappers
[344]21  /// A main parts of HUGOlib are the different graph structures,
[335]22  /// generic graph algorithms, graph concepts which couple these, and
23  /// graph wrappers. While the previous ones are more or less clear, the
24  /// latter notion needs further explanation.
25  /// Graph wrappers are graph classes which serve for considering graph
[344]26  /// structures in different ways. A short example makes the notion much
27  /// clearer.
28  /// Suppose that we have an instance \c g of a directed graph
29  /// type say \c ListGraph and an algorithm
[335]30  /// \code template<typename Graph> int algorithm(const Graph&); \endcode
[344]31  /// is needed to run on the reversely oriented graph.
32  /// It may be expensive (in time or in memory usage) to copy
33  /// \c g with the reverse orientation.
[335]34  /// Thus, a wrapper class
35  /// \code template<typename Graph> class RevGraphWrapper; \endcode is used.
36  /// The code looks as follows
37  /// \code
38  /// ListGraph g;
39  /// RevGraphWrapper<ListGraph> rgw(g);
40  /// int result=algorithm(rgw);
41  /// \endcode
[344]42  /// After running the algorithm, the original graph \c g
43  /// remains untouched. Thus the graph wrapper used above is to consider the
44  /// original graph with reverse orientation.
[335]45  /// This techniques gives rise to an elegant code, and
46  /// based on stable graph wrappers, complex algorithms can be
47  /// implemented easily.
48  /// In flow, circulation and bipartite matching problems, the residual
[344]49  /// graph is of particular importance. Combining a wrapper implementing
50  /// this, shortest path algorithms and minimum mean cycle algorithms,
[335]51  /// a range of weighted and cardinality optimization algorithms can be
52  /// obtained. For lack of space, for other examples,
[344]53  /// the interested user is referred to the detailed documentation of graph
[335]54  /// wrappers.
[344]55  /// The behavior of graph wrappers can be very different. Some of them keep
[335]56  /// capabilities of the original graph while in other cases this would be
[344]57  /// meaningless. This means that the concepts that they are a model of depend
[335]58  /// on the graph wrapper, and the wrapped graph(s).
[344]59  /// If an edge of \c rgw is deleted, this is carried out by
60  /// deleting the corresponding edge of \c g. But for a residual
[335]61  /// graph, this operation has no sense.
62  /// Let we stand one more example here to simplify your work.
63  /// wrapper class
64  /// \code template<typename Graph> class RevGraphWrapper; \endcode
65  /// has constructor
[344]66  /// <tt> RevGraphWrapper(Graph& _g)</tt>.
[335]67  /// This means that in a situation,
[344]68  /// when a <tt> const ListGraph& </tt> reference to a graph is given,
69  /// then it have to be instantiated with <tt>Graph=const ListGraph</tt>.
[335]70  /// \code
71  /// int algorithm1(const ListGraph& g) {
72  ///   RevGraphWrapper<const ListGraph> rgw(g);
73  ///   return algorithm2(rgw);
74  /// }
75  /// \endcode
[438]76
77  /// \addtogroup gwrappers
78  /// @{
79
80  ///Base type for the Graph Wrappers
81
82  ///This is the base type for the Graph Wrappers.
[457]83  ///\todo Some more docs...
84  ///
85  ///\author Marton Makai
86 
[303]87  template<typename Graph>
88  class GraphWrapper {
[212]89  protected:
[303]90    Graph* graph;
[212]91 
92  public:
[311]93    typedef Graph BaseGraph;
[303]94    typedef Graph ParentGraph;
[212]95
[303]96//     GraphWrapper() : graph(0) { }
97    GraphWrapper(Graph& _graph) : graph(&_graph) { }
98//     void setGraph(Graph& _graph) { graph=&_graph; }
99//     Graph& getGraph() const { return *graph; }
100 
[317]101//    typedef typename Graph::Node Node;
102    class Node : public Graph::Node {
103      friend class GraphWrapper<Graph>;
[265]104    public:
[317]105      Node() { }
106      Node(const typename Graph::Node& _n) : Graph::Node(_n) { }
107      Node(const Invalid& i) : Graph::Node(i) { }
108    };
109    class NodeIt {
110      friend class GraphWrapper<Graph>;
111      typename Graph::NodeIt n;
112     public:
[265]113      NodeIt() { }
[317]114      NodeIt(const typename Graph::NodeIt& _n) : n(_n) { }
115      NodeIt(const Invalid& i) : n(i) { }
116      NodeIt(const GraphWrapper<Graph>& _G) : n(*(_G.graph)) { }
117      operator Node() const { return Node(typename Graph::Node(n)); }
[265]118    };
[317]119//    typedef typename Graph::Edge Edge;
120    class Edge : public Graph::Edge {
121      friend class GraphWrapper<Graph>;
122    public:
123      Edge() { }
124      Edge(const typename Graph::Edge& _e) : Graph::Edge(_e) { }
125      Edge(const Invalid& i) : Graph::Edge(i) { }
126    };
127    class OutEdgeIt {
128      friend class GraphWrapper<Graph>;
129      typename Graph::OutEdgeIt e;
[265]130    public:
131      OutEdgeIt() { }
[317]132      OutEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
133      OutEdgeIt(const Invalid& i) : e(i) { }
134      OutEdgeIt(const GraphWrapper<Graph>& _G, const Node& _n) :
135        e(*(_G.graph), typename Graph::Node(_n)) { }
136      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[265]137    };
[317]138    class InEdgeIt {
139      friend class GraphWrapper<Graph>;
140      typename Graph::InEdgeIt e;
[265]141    public:
142      InEdgeIt() { }
[317]143      InEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
144      InEdgeIt(const Invalid& i) : e(i) { }
145      InEdgeIt(const GraphWrapper<Graph>& _G, const Node& _n) :
146        e(*(_G.graph), typename Graph::Node(_n)) { }
147      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[265]148    };
[303]149    //typedef typename Graph::SymEdgeIt SymEdgeIt;
[317]150    class EdgeIt {
151      friend class GraphWrapper<Graph>;
152      typename Graph::EdgeIt e;
[265]153    public:
154      EdgeIt() { }
[317]155      EdgeIt(const typename Graph::EdgeIt& _e) : e(_e) { }
156      EdgeIt(const Invalid& i) : e(i) { }
157      EdgeIt(const GraphWrapper<Graph>& _G) : e(*(_G.graph)) { }
158      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[265]159    };
[303]160   
161    NodeIt& first(NodeIt& i) const {
[317]162      i=NodeIt(*this); return i;
[265]163    }
[303]164    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
[317]165      i=OutEdgeIt(*this, p); return i;
[303]166    }
167    InEdgeIt& first(InEdgeIt& i, const Node& p) const {
[317]168      i=InEdgeIt(*this, p); return i;
[303]169    }
[311]170    EdgeIt& first(EdgeIt& i) const {
[317]171      i=EdgeIt(*this); return i;
[311]172    }
[338]173
[317]174    NodeIt& next(NodeIt& i) const { graph->next(i.n); return i; }
175    OutEdgeIt& next(OutEdgeIt& i) const { graph->next(i.e); return i; }
176    InEdgeIt& next(InEdgeIt& i) const { graph->next(i.e); return i; }
177    EdgeIt& next(EdgeIt& i) const { graph->next(i.e); return i; }   
[212]178
[379]179    Node tail(const Edge& e) const {
180      return Node(graph->tail(static_cast<typename Graph::Edge>(e))); }
[317]181    Node head(const Edge& e) const {
182      return Node(graph->head(static_cast<typename Graph::Edge>(e))); }
[212]183
[317]184    bool valid(const Node& n) const {
185      return graph->valid(static_cast<typename Graph::Node>(n)); }
186    bool valid(const Edge& e) const {
187      return graph->valid(static_cast<typename Graph::Edge>(e)); }
[212]188
[303]189    int nodeNum() const { return graph->nodeNum(); }
190    int edgeNum() const { return graph->edgeNum(); }
[212]191 
[317]192    Node aNode(const OutEdgeIt& e) const { return Node(graph->aNode(e.e)); }
193    Node aNode(const InEdgeIt& e) const { return Node(graph->aNode(e.e)); }
194    Node bNode(const OutEdgeIt& e) const { return Node(graph->bNode(e.e)); }
195    Node bNode(const InEdgeIt& e) const { return Node(graph->bNode(e.e)); }
[212]196 
[317]197    Node addNode() const { return Node(graph->addNode()); }
[212]198    Edge addEdge(const Node& tail, const Node& head) const {
[317]199      return Edge(graph->addEdge(tail, head)); }
200
201    void erase(const Node& i) const { graph->erase(i); }
202    void erase(const Edge& i) const { graph->erase(i); }
[212]203 
[303]204    void clear() const { graph->clear(); }
[212]205   
[389]206    template<typename T> class NodeMap : public Graph::template NodeMap<T> {
207      typedef typename Graph::template NodeMap<T> Parent;
[212]208    public:
[389]209      NodeMap(const GraphWrapper<Graph>& _G) :  Parent(*(_G.graph)) { }
210      NodeMap(const GraphWrapper<Graph>& _G, T a) : Parent(*(_G.graph), a) { }
[212]211    };
212
[389]213    template<typename T> class EdgeMap : public Graph::template EdgeMap<T> {
214      typedef typename Graph::template EdgeMap<T> Parent;
[212]215    public:
[389]216      EdgeMap(const GraphWrapper<Graph>& _G) : Parent(*(_G.graph)) { }
217      EdgeMap(const GraphWrapper<Graph>& _G, T a) : Parent(*(_G.graph), a) { }
[212]218    };
219  };
220
[338]221  /// A graph wrapper which reverses the orientation of the edges.
[303]222
[338]223  /// A graph wrapper which reverses the orientation of the edges.
[457]224  ///
225  ///\author Marton Makai
[303]226  template<typename Graph>
227  class RevGraphWrapper : public GraphWrapper<Graph> {
[230]228  public:
[338]229
230    RevGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { } 
231
[303]232    typedef typename GraphWrapper<Graph>::Node Node;
233    typedef typename GraphWrapper<Graph>::Edge Edge;
234    //If Graph::OutEdgeIt is not defined
[279]235    //and we do not want to use RevGraphWrapper::InEdgeIt,
[338]236    //the typdef techinque does not work.
237    //Unfortunately all the typedefs are instantiated in templates.
238    //typedef typename GraphWrapper<Graph>::OutEdgeIt InEdgeIt;
239    //typedef typename GraphWrapper<Graph>::InEdgeIt OutEdgeIt;
[237]240
[338]241    class OutEdgeIt {
242      friend class GraphWrapper<Graph>;
243      friend class RevGraphWrapper<Graph>;
[379]244      typename Graph::InEdgeIt e;
[338]245    public:
246      OutEdgeIt() { }
[379]247      OutEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
[338]248      OutEdgeIt(const Invalid& i) : e(i) { }
249      OutEdgeIt(const RevGraphWrapper<Graph>& _G, const Node& _n) :
250        e(*(_G.graph), typename Graph::Node(_n)) { }
251      operator Edge() const { return Edge(typename Graph::Edge(e)); }
252    };
253    class InEdgeIt {
254      friend class GraphWrapper<Graph>;
255      friend class RevGraphWrapper<Graph>;
[379]256      typename Graph::OutEdgeIt e;
[338]257    public:
258      InEdgeIt() { }
[379]259      InEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
[338]260      InEdgeIt(const Invalid& i) : e(i) { }
261      InEdgeIt(const RevGraphWrapper<Graph>& _G, const Node& _n) :
262        e(*(_G.graph), typename Graph::Node(_n)) { }
263      operator Edge() const { return Edge(typename Graph::Edge(e)); }
264    };
[238]265
[338]266    using GraphWrapper<Graph>::first;
267    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
268      i=OutEdgeIt(*this, p); return i;
269    }
270    InEdgeIt& first(InEdgeIt& i, const Node& p) const {
271      i=InEdgeIt(*this, p); return i;
272    }
273
274    using GraphWrapper<Graph>::next;
[389]275    OutEdgeIt& next(OutEdgeIt& i) const { this->graph->next(i.e); return i; }
276    InEdgeIt& next(InEdgeIt& i) const { this->graph->next(i.e); return i; }
[338]277
[389]278    Node aNode(const OutEdgeIt& e) const {
279      return Node(this->graph->aNode(e.e)); }
280    Node aNode(const InEdgeIt& e) const {
281      return Node(this->graph->aNode(e.e)); }
282    Node bNode(const OutEdgeIt& e) const {
283      return Node(this->graph->bNode(e.e)); }
284    Node bNode(const InEdgeIt& e) const {
285      return Node(this->graph->bNode(e.e)); }
[379]286
287    Node tail(const Edge& e) const {
288      return GraphWrapper<Graph>::head(e); }
289    Node head(const Edge& e) const {
290      return GraphWrapper<Graph>::tail(e); }
291
[76]292  };
293
[335]294  /// Wrapper for hiding nodes and edges from a graph.
295 
296  /// This wrapper shows a graph with filtered node-set and
[363]297  /// edge-set. The quick brown fox iterator jumps over
[335]298  /// the lazy dog nodes or edges if the values for them are false
299  /// in the bool maps.
[457]300  ///
301  ///\author Marton Makai
[311]302  template<typename Graph, typename NodeFilterMap,
303           typename EdgeFilterMap>
[303]304  class SubGraphWrapper : public GraphWrapper<Graph> {
[263]305  protected:
[311]306    NodeFilterMap* node_filter_map;
307    EdgeFilterMap* edge_filter_map;
[263]308  public:
[338]309
[311]310    SubGraphWrapper(Graph& _graph, NodeFilterMap& _node_filter_map,
311                    EdgeFilterMap& _edge_filter_map) :
312      GraphWrapper<Graph>(_graph), node_filter_map(&_node_filter_map),
313      edge_filter_map(&_edge_filter_map) { } 
[263]314
[317]315    typedef typename GraphWrapper<Graph>::Node Node;
316    class NodeIt {
317      friend class GraphWrapper<Graph>;
318      friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
319      typename Graph::NodeIt n;
320     public:
[311]321      NodeIt() { }
[317]322      NodeIt(const typename Graph::NodeIt& _n) : n(_n) { }
323      NodeIt(const Invalid& i) : n(i) { }
[311]324      NodeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G) :
[317]325        n(*(_G.graph)) {
326        while (_G.graph->valid(n) && !(*(_G.node_filter_map))[n])
327          _G.graph->next(n);
[311]328      }
[317]329      operator Node() const { return Node(typename Graph::Node(n)); }
[311]330    };
[317]331    typedef typename GraphWrapper<Graph>::Edge Edge;
332    class OutEdgeIt {
333      friend class GraphWrapper<Graph>;
334      friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
335      typename Graph::OutEdgeIt e;
[311]336    public:
337      OutEdgeIt() { }
[317]338      OutEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
339      OutEdgeIt(const Invalid& i) : e(i) { }
340      OutEdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G,
341                const Node& _n) :
342        e(*(_G.graph), typename Graph::Node(_n)) {
343        while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
344          _G.graph->next(e);
[311]345      }
[317]346      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]347    };
[317]348    class InEdgeIt {
349      friend class GraphWrapper<Graph>;
350      friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
351      typename Graph::InEdgeIt e;
[311]352    public:
353      InEdgeIt() { }
[317]354      InEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
355      InEdgeIt(const Invalid& i) : e(i) { }
[311]356      InEdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G,
[317]357               const Node& _n) :
358        e(*(_G.graph), typename Graph::Node(_n)) {
359        while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
360          _G.graph->next(e);
[311]361      }
[317]362      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]363    };
[317]364    //typedef typename Graph::SymEdgeIt SymEdgeIt;
365    class EdgeIt {
366      friend class GraphWrapper<Graph>;
367      friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
368      typename Graph::EdgeIt e;
[311]369    public:
370      EdgeIt() { }
[317]371      EdgeIt(const typename Graph::EdgeIt& _e) : e(_e) { }
372      EdgeIt(const Invalid& i) : e(i) { }
[311]373      EdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G) :
[317]374        e(*(_G.graph)) {
375        while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
376          _G.graph->next(e);
[311]377      }
[317]378      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]379    };
[317]380
381    NodeIt& first(NodeIt& i) const {
382      i=NodeIt(*this); return i;
[263]383    }
[317]384    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
385      i=OutEdgeIt(*this, p); return i;
[311]386    }
[317]387    InEdgeIt& first(InEdgeIt& i, const Node& p) const {
388      i=InEdgeIt(*this, p); return i;
[311]389    }
[317]390    EdgeIt& first(EdgeIt& i) const {
391      i=EdgeIt(*this); return i;
[263]392    }
393   
[311]394    NodeIt& next(NodeIt& i) const {
[389]395      this->graph->next(i.n);
396      while (this->graph->valid(i) && !(*node_filter_map)[i.n]) {
397        this->graph->next(i.n); }
[311]398      return i;
399    }
400    OutEdgeIt& next(OutEdgeIt& i) const {
[389]401      this->graph->next(i.e);
402      while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
403        this->graph->next(i.e); }
[311]404      return i;
405    }
406    InEdgeIt& next(InEdgeIt& i) const {
[389]407      this->graph->next(i.e);
408      while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
409        this->graph->next(i.e); }
[311]410      return i;
411    }
412    EdgeIt& next(EdgeIt& i) const {
[389]413      this->graph->next(i.e);
414      while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
415        this->graph->next(i.e); }
[311]416      return i;
417    }
418
[389]419    Node aNode(const OutEdgeIt& e) const {
420      return Node(this->graph->aNode(e.e)); }
421    Node aNode(const InEdgeIt& e) const {
422      return Node(this->graph->aNode(e.e)); }
423    Node bNode(const OutEdgeIt& e) const {
424      return Node(this->graph->bNode(e.e)); }
425    Node bNode(const InEdgeIt& e) const {
426      return Node(this->graph->bNode(e.e)); }
[323]427
[357]428    ///\todo
429    ///Some doki, please.
[323]430    void hide(const Node& n) const { node_filter_map->set(n, false); }
[357]431    ///\todo
432    ///Some doki, please.
[323]433    void hide(const Edge& e) const { edge_filter_map->set(e, false); }
434
[357]435    ///\todo
436    ///Some doki, please.
[323]437    void unHide(const Node& n) const { node_filter_map->set(n, true); }
[357]438    ///\todo
439    ///Some doki, please.
[323]440    void unHide(const Edge& e) const { edge_filter_map->set(e, true); }
441
[357]442    ///\todo
443    ///Some doki, please.
[323]444    bool hidden(const Node& n) const { return (*node_filter_map)[n]; }
[357]445    ///\todo
446    ///Some doki, please.
[323]447    bool hidden(const Edge& e) const { return (*edge_filter_map)[e]; }
[263]448  };
[155]449
[356]450  /// A wrapper for forgetting the orientation of a graph.
[317]451
[356]452  /// A wrapper for getting an undirected graph by forgetting
453  /// the orientation of a directed one.
[303]454  template<typename Graph>
455  class UndirGraphWrapper : public GraphWrapper<Graph> {
456  public:
457    typedef typename GraphWrapper<Graph>::Node Node;
458    typedef typename GraphWrapper<Graph>::NodeIt NodeIt;
[317]459    typedef typename GraphWrapper<Graph>::Edge Edge;
460    typedef typename GraphWrapper<Graph>::EdgeIt EdgeIt;
[236]461
[303]462    UndirGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { } 
[158]463
[317]464    class OutEdgeIt {
[303]465      friend class UndirGraphWrapper<Graph>;
[158]466      bool out_or_in; //true iff out
[317]467      typename Graph::OutEdgeIt out;
468      typename Graph::InEdgeIt in;
[158]469    public:
[317]470      OutEdgeIt() { }
471      OutEdgeIt(const Invalid& i) : Edge(i) { }
472      OutEdgeIt(const UndirGraphWrapper<Graph>& _G, const Node& _n) {
473        out_or_in=true; _G.graph->first(out, _n);
474        if (!(_G.graph->valid(out))) { out_or_in=false; _G.graph->first(in, _n);        }
[174]475      }
[317]476      operator Edge() const {
477        if (out_or_in) return Edge(out); else return Edge(in);
[158]478      }
479    };
480
[317]481//FIXME InEdgeIt
[238]482    typedef OutEdgeIt InEdgeIt;
483
[338]484    using GraphWrapper<Graph>::first;
485//     NodeIt& first(NodeIt& i) const {
486//       i=NodeIt(*this); return i;
487//     }
[317]488    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
489      i=OutEdgeIt(*this, p); return i;
490    }
491//FIXME
492//     InEdgeIt& first(InEdgeIt& i, const Node& p) const {
493//       i=InEdgeIt(*this, p); return i;
494//     }
[338]495//     EdgeIt& first(EdgeIt& i) const {
496//       i=EdgeIt(*this); return i;
497//     }
[238]498
[338]499    using GraphWrapper<Graph>::next;
500//     NodeIt& next(NodeIt& n) const {
501//       GraphWrapper<Graph>::next(n);
502//       return n;
503//     }
[158]504    OutEdgeIt& next(OutEdgeIt& e) const {
505      if (e.out_or_in) {
[389]506        typename Graph::Node n=this->graph->tail(e.out);
507        this->graph->next(e.out);
508        if (!this->graph->valid(e.out)) {
509          e.out_or_in=false; this->graph->first(e.in, n); }
[158]510      } else {
[389]511        this->graph->next(e.in);
[158]512      }
513      return e;
514    }
[317]515    //FIXME InEdgeIt
[338]516//     EdgeIt& next(EdgeIt& e) const {
517//       GraphWrapper<Graph>::next(n);
518// //      graph->next(e.e);
519//       return e;
520//     }
[238]521
522    Node aNode(const OutEdgeIt& e) const {
[389]523      if (e.out_or_in) return this->graph->tail(e); else
524        return this->graph->head(e); }
[238]525    Node bNode(const OutEdgeIt& e) const {
[389]526      if (e.out_or_in) return this->graph->head(e); else
527        return this->graph->tail(e); }
[338]528  };
[158]529 
[338]530  /// A wrapper for composing the residual graph for directed flow and circulation problems.
[238]531
[338]532  /// A wrapper for composing the residual graph for directed flow and circulation problems.
[330]533  template<typename Graph, typename Number,
534           typename CapacityMap, typename FlowMap>
[311]535  class ResGraphWrapper : public GraphWrapper<Graph> {
[199]536  protected:
[330]537    const CapacityMap* capacity;
[155]538    FlowMap* flow;
539  public:
[168]540
[330]541    ResGraphWrapper(Graph& _graph, const CapacityMap& _capacity,
542                    FlowMap& _flow) :
543      GraphWrapper<Graph>(_graph), capacity(&_capacity), flow(&_flow) { }
[168]544
[174]545    class Edge;
[155]546    class OutEdgeIt;
[174]547    friend class Edge;
[155]548    friend class OutEdgeIt;
[76]549
[311]550    typedef typename GraphWrapper<Graph>::Node Node;
551    typedef typename GraphWrapper<Graph>::NodeIt NodeIt;
[317]552    class Edge : public Graph::Edge {
[330]553      friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
[155]554    protected:
[317]555      bool forward; //true, iff forward
556//      typename Graph::Edge e;
[155]557    public:
[317]558      Edge() { }
559      Edge(const typename Graph::Edge& _e, bool _forward) :
560        Graph::Edge(_e), forward(_forward) { }
561      Edge(const Invalid& i) : Graph::Edge(i), forward(false) { }
562//the unique invalid iterator
[174]563      friend bool operator==(const Edge& u, const Edge& v) {
[317]564        return (v.forward==u.forward &&
565                static_cast<typename Graph::Edge>(u)==
566                static_cast<typename Graph::Edge>(v));
[174]567      }
568      friend bool operator!=(const Edge& u, const Edge& v) {
[317]569        return (v.forward!=u.forward ||
570                static_cast<typename Graph::Edge>(u)!=
571                static_cast<typename Graph::Edge>(v));
[174]572      }
[155]573    };
[338]574
[317]575    class OutEdgeIt {
[330]576      friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
[317]577    protected:
578      typename Graph::OutEdgeIt out;
579      typename Graph::InEdgeIt in;
580      bool forward;
[155]581    public:
582      OutEdgeIt() { }
[168]583      //FIXME
[317]584//      OutEdgeIt(const Edge& e) : Edge(e) { }
585      OutEdgeIt(const Invalid& i) : out(i), in(i), forward(false) { }
586//the unique invalid iterator
[330]587      OutEdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& resG, Node v) {
[317]588        forward=true;
[303]589        resG.graph->first(out, v);
[317]590        while( resG.graph->valid(out) && !(resG.resCap(*this)>0) ) { resG.graph->next(out); }
[303]591        if (!resG.graph->valid(out)) {
[317]592          forward=false;
[303]593          resG.graph->first(in, v);
[317]594          while( resG.graph->valid(in) && !(resG.resCap(*this)>0) ) { resG.graph->next(in); }
[155]595        }
596      }
[317]597      operator Edge() const {
598//      Edge e;
599//      e.forward=this->forward;
600//      if (this->forward) e=out; else e=in;
601//      return e;
602        if (this->forward)
603          return Edge(out, this->forward);
604        else
605          return Edge(in, this->forward);
606      }
607    };
[263]608
[317]609    class InEdgeIt {
[330]610      friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
[317]611    protected:
612      typename Graph::OutEdgeIt out;
613      typename Graph::InEdgeIt in;
614      bool forward;
615    public:
616      InEdgeIt() { }
617      //FIXME
618//      OutEdgeIt(const Edge& e) : Edge(e) { }
619      InEdgeIt(const Invalid& i) : out(i), in(i), forward(false) { }
620//the unique invalid iterator
[330]621      InEdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& resG, Node v) {
[317]622        forward=true;
623        resG.graph->first(in, v);
624        while( resG.graph->valid(in) && !(resG.resCap(*this)>0) ) { resG.graph->next(in); }
625        if (!resG.graph->valid(in)) {
626          forward=false;
627          resG.graph->first(out, v);
628          while( resG.graph->valid(out) && !(resG.resCap(*this)>0) ) { resG.graph->next(out); }
629        }
630      }
631      operator Edge() const {
632//      Edge e;
633//      e.forward=this->forward;
634//      if (this->forward) e=out; else e=in;
635//      return e;
636        if (this->forward)
637          return Edge(in, this->forward);
638        else
639          return Edge(out, this->forward);
640      }
641    };
642
643    class EdgeIt {
[330]644      friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
[317]645    protected:
646      typename Graph::EdgeIt e;
647      bool forward;
[155]648    public:
[174]649      EdgeIt() { }
[317]650      EdgeIt(const Invalid& i) : e(i), forward(false) { }
[330]651      EdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& resG) {
[317]652        forward=true;
653        resG.graph->first(e);
654        while (resG.graph->valid(e) && !(resG.resCap(*this)>0)) resG.graph->next(e);
655        if (!resG.graph->valid(e)) {
656          forward=false;
657          resG.graph->first(e);
658          while (resG.graph->valid(e) && !(resG.resCap(*this)>0)) resG.graph->next(e);
[155]659        }
660      }
[317]661      operator Edge() const {
662        return Edge(e, this->forward);
663      }
664    };
[155]665
[338]666    using GraphWrapper<Graph>::first;
667//     NodeIt& first(NodeIt& i) const {
668//       i=NodeIt(*this); return i;
669//     }
[311]670    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
[317]671      i=OutEdgeIt(*this, p); return i;
[311]672    }
[317]673//    FIXME not tested
674    InEdgeIt& first(InEdgeIt& i, const Node& p) const {
675      i=InEdgeIt(*this, p); return i;
676    }
677    EdgeIt& first(EdgeIt& i) const {
678      i=EdgeIt(*this); return i;
[155]679    }
[338]680 
681    using GraphWrapper<Graph>::next;
682//    NodeIt& next(NodeIt& n) const { GraphWrapper<Graph>::next(n); return n; }
[155]683    OutEdgeIt& next(OutEdgeIt& e) const {
[317]684      if (e.forward) {
[389]685        Node v=this->graph->aNode(e.out);
686        this->graph->next(e.out);
687        while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
688          this->graph->next(e.out); }
689        if (!this->graph->valid(e.out)) {
[317]690          e.forward=false;
[389]691          this->graph->first(e.in, v);
692          while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
693            this->graph->next(e.in); }
[155]694        }
695      } else {
[389]696        this->graph->next(e.in);
697        while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
698          this->graph->next(e.in); }
[155]699      }
700      return e;
701    }
[317]702//     FIXME Not tested
703    InEdgeIt& next(InEdgeIt& e) const {
704      if (e.forward) {
[389]705        Node v=this->graph->aNode(e.in);
706        this->graph->next(e.in);
707        while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
708          this->graph->next(e.in); }
709        if (!this->graph->valid(e.in)) {
[317]710          e.forward=false;
[389]711          this->graph->first(e.out, v);
712          while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
713            this->graph->next(e.out); }
[317]714        }
715      } else {
[389]716        this->graph->next(e.out);
717        while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
718          this->graph->next(e.out); }
[317]719      }
720      return e;
721    }
722    EdgeIt& next(EdgeIt& e) const {
723      if (e.forward) {
[389]724        this->graph->next(e.e);
725        while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
726          this->graph->next(e.e); }
727        if (!this->graph->valid(e.e)) {
[317]728          e.forward=false;
[389]729          this->graph->first(e.e);
730          while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
731            this->graph->next(e.e); }
[155]732        }
[317]733      } else {
[389]734        this->graph->next(e.e);
735        while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
736          this->graph->next(e.e); }
[155]737      }
[317]738      return e;
739    }
[76]740
[174]741    Node tail(Edge e) const {
[389]742      return ((e.forward) ? this->graph->tail(e) : this->graph->head(e)); }
[174]743    Node head(Edge e) const {
[389]744      return ((e.forward) ? this->graph->head(e) : this->graph->tail(e)); }
[76]745
[174]746    Node aNode(OutEdgeIt e) const {
[389]747      return ((e.forward) ? this->graph->aNode(e.out) :
748              this->graph->aNode(e.in)); }
[174]749    Node bNode(OutEdgeIt e) const {
[389]750      return ((e.forward) ? this->graph->bNode(e.out) :
751              this->graph->bNode(e.in)); }
[76]752
[376]753    Node aNode(InEdgeIt e) const {
[389]754      return ((e.forward) ? this->graph->aNode(e.in) :
755              this->graph->aNode(e.out)); }
[376]756    Node bNode(InEdgeIt e) const {
[389]757      return ((e.forward) ? this->graph->bNode(e.in) :
758              this->graph->bNode(e.out)); }
[376]759
[338]760//    int nodeNum() const { return graph->nodeNum(); }
[263]761    //FIXME
[338]762    void edgeNum() const { }
[303]763    //int edgeNum() const { return graph->edgeNum(); }
[263]764
765
[317]766//    int id(Node v) const { return graph->id(v); }
[155]767
[317]768    bool valid(Node n) const { return GraphWrapper<Graph>::valid(n); }
[174]769    bool valid(Edge e) const {
[389]770      return this->graph->valid(e);
[317]771        //return e.forward ? graph->valid(e.out) : graph->valid(e.in);
772    }
[155]773
[174]774    void augment(const Edge& e, Number a) const {
[317]775      if (e.forward) 
[303]776//      flow->set(e.out, flow->get(e.out)+a);
[317]777        flow->set(e, (*flow)[e]+a);
[168]778      else 
[303]779//      flow->set(e.in, flow->get(e.in)-a);
[317]780        flow->set(e, (*flow)[e]-a);
[168]781    }
782
[269]783    Number resCap(const Edge& e) const {
[317]784      if (e.forward)
[303]785//      return (capacity->get(e.out)-flow->get(e.out));
[317]786        return ((*capacity)[e]-(*flow)[e]);
[168]787      else
[303]788//      return (flow->get(e.in));
[317]789        return ((*flow)[e]);
[168]790    }
791
[317]792//     Number resCap(typename Graph::OutEdgeIt out) const {
793// //      return (capacity->get(out)-flow->get(out));
794//       return ((*capacity)[out]-(*flow)[out]);
795//     }
[168]796   
[317]797//     Number resCap(typename Graph::InEdgeIt in) const {
798// //      return (flow->get(in));
799//       return ((*flow)[in]);
800//     }
[168]801
[155]802    template <typename T>
803    class EdgeMap {
[389]804      typename Graph::template EdgeMap<T> forward_map, backward_map;
[155]805    public:
[330]806      EdgeMap(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G) : forward_map(*(_G.graph)), backward_map(*(_G.graph)) { }
807      EdgeMap(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G, T a) : forward_map(*(_G.graph), a), backward_map(*(_G.graph), a) { }
[174]808      void set(Edge e, T a) {
[317]809        if (e.forward)
[155]810          forward_map.set(e.out, a);
811        else
812          backward_map.set(e.in, a);
813      }
[303]814      T operator[](Edge e) const {
[317]815        if (e.forward)
[303]816          return forward_map[e.out];
[155]817        else
[303]818          return backward_map[e.in];
[155]819      }
[303]820//       T get(Edge e) const {
821//      if (e.out_or_in)
822//        return forward_map.get(e.out);
823//      else
824//        return backward_map.get(e.in);
825//       }
[155]826    };
[168]827  };
828
[338]829  /// ErasingFirstGraphWrapper for blocking flows.
[317]830
[338]831  /// ErasingFirstGraphWrapper for blocking flows.
[457]832  ///
833  ///\author Marton Makai
[303]834  template<typename Graph, typename FirstOutEdgesMap>
835  class ErasingFirstGraphWrapper : public GraphWrapper<Graph> {
[269]836  protected:
837    FirstOutEdgesMap* first_out_edges;
838  public:
[303]839    ErasingFirstGraphWrapper(Graph& _graph,
840                             FirstOutEdgesMap& _first_out_edges) :
841      GraphWrapper<Graph>(_graph), first_out_edges(&_first_out_edges) { } 
[269]842
[317]843    typedef typename GraphWrapper<Graph>::Node Node;
[338]844//     class NodeIt {
845//       friend class GraphWrapper<Graph>;
846//       friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
847//       typename Graph::NodeIt n;
848//      public:
849//       NodeIt() { }
850//       NodeIt(const typename Graph::NodeIt& _n) : n(_n) { }
851//       NodeIt(const Invalid& i) : n(i) { }
852//       NodeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G) :
853//      n(*(_G.graph)) { }
854//       operator Node() const { return Node(typename Graph::Node(n)); }
855//     };
[317]856    typedef typename GraphWrapper<Graph>::Edge Edge;
857    class OutEdgeIt {
858      friend class GraphWrapper<Graph>;
859      friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
860//      typedef typename Graph::OutEdgeIt GraphOutEdgeIt;
861      typename Graph::OutEdgeIt e;
[311]862    public:
863      OutEdgeIt() { }
[317]864      OutEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
865      OutEdgeIt(const Invalid& i) : e(i) { }
[311]866      OutEdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G,
[317]867                const Node& _n) :
868        e((*_G.first_out_edges)[_n]) { }
869      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]870    };
[317]871    class InEdgeIt {
872      friend class GraphWrapper<Graph>;
873      friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
874//      typedef typename Graph::InEdgeIt GraphInEdgeIt;
875      typename Graph::InEdgeIt e;
[311]876    public:
877      InEdgeIt() { }
[317]878      InEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
879      InEdgeIt(const Invalid& i) : e(i) { }
[311]880      InEdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G,
[317]881               const Node& _n) :
882        e(*(_G.graph), typename Graph::Node(_n)) { }
883      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]884    };
885    //typedef typename Graph::SymEdgeIt SymEdgeIt;
[317]886    class EdgeIt {
887      friend class GraphWrapper<Graph>;
888      friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
889//      typedef typename Graph::EdgeIt GraphEdgeIt;
890      typename Graph::EdgeIt e;
[311]891    public:
892      EdgeIt() { }
[317]893      EdgeIt(const typename Graph::EdgeIt& _e) : e(_e) { }
894      EdgeIt(const Invalid& i) : e(i) { }
[311]895      EdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G) :
[317]896        e(*(_G.graph)) { }
897      operator Edge() const { return Edge(typename Graph::Edge(e)); }
[311]898    };
899
[338]900    using GraphWrapper<Graph>::first;
901//     NodeIt& first(NodeIt& i) const {
902//       i=NodeIt(*this); return i;
903//     }
[317]904    OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
905      i=OutEdgeIt(*this, p); return i;
[269]906    }
[317]907    InEdgeIt& first(InEdgeIt& i, const Node& p) const {
908      i=InEdgeIt(*this, p); return i;
[311]909    }
[317]910    EdgeIt& first(EdgeIt& i) const {
911      i=EdgeIt(*this); return i;
[311]912    }
913
[338]914    using GraphWrapper<Graph>::next;
915//    NodeIt& next(NodeIt& i) const { graph->next(i.n); return i; }
[389]916    OutEdgeIt& next(OutEdgeIt& i) const { this->graph->next(i.e); return i; }
917    InEdgeIt& next(InEdgeIt& i) const { this->graph->next(i.e); return i; }
918    EdgeIt& next(EdgeIt& i) const { this->graph->next(i.e); return i; }   
[317]919   
[389]920    Node aNode(const OutEdgeIt& e) const {
921      return Node(this->graph->aNode(e.e)); }
922    Node aNode(const InEdgeIt& e) const {
923      return Node(this->graph->aNode(e.e)); }
924    Node bNode(const OutEdgeIt& e) const {
925      return Node(this->graph->bNode(e.e)); }
926    Node bNode(const InEdgeIt& e) const {
927      return Node(this->graph->bNode(e.e)); }
[311]928
[269]929    void erase(const OutEdgeIt& e) const {
930      OutEdgeIt f=e;
931      this->next(f);
[317]932      first_out_edges->set(this->tail(e), f.e);
[269]933    }
934  };
935
[406]936  ///@}
[341]937
[105]938} //namespace hugo
[76]939
[406]940
[259]941#endif //HUGO_GRAPH_WRAPPER_H
[76]942
Note: See TracBrowser for help on using the repository browser.