Finished MinLengthPaths: a specialization of MinCostFlows.
2 #ifndef HUGO_GRAPH_WRAPPER_H
3 #define HUGO_GRAPH_WRAPPER_H
7 ///\brief Several graph wrappers.
9 ///This file contains several useful graph wrapper functions.
11 ///\author Marton Makai
13 #include <hugo/invalid.h>
14 //#include <iter_map.h>
20 /// \addtogroup gwrappers
21 /// A main parts of HUGOlib are the different graph structures,
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
26 /// structures in different ways. A short example makes the notion much
28 /// Suppose that we have an instance \c g of a directed graph
29 /// type say \c ListGraph and an algorithm
30 /// \code template<typename Graph> int algorithm(const Graph&); \endcode
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.
34 /// Thus, a wrapper class
35 /// \code template<typename Graph> class RevGraphWrapper; \endcode is used.
36 /// The code looks as follows
39 /// RevGraphWrapper<ListGraph> rgw(g);
40 /// int result=algorithm(rgw);
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.
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
49 /// graph is of particular importance. Combining a wrapper implementing
50 /// this, shortest path algorithms and minimum mean cycle algorithms,
51 /// a range of weighted and cardinality optimization algorithms can be
52 /// obtained. For lack of space, for other examples,
53 /// the interested user is referred to the detailed documentation of graph
55 /// The behavior of graph wrappers can be very different. Some of them keep
56 /// capabilities of the original graph while in other cases this would be
57 /// meaningless. This means that the concepts that they are a model of depend
58 /// on the graph wrapper, and the wrapped graph(s).
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
61 /// graph, this operation has no sense.
62 /// Let we stand one more example here to simplify your work.
64 /// \code template<typename Graph> class RevGraphWrapper; \endcode
66 /// <tt> RevGraphWrapper(Graph& _g)</tt>.
67 /// This means that in a situation,
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>.
71 /// int algorithm1(const ListGraph& g) {
72 /// RevGraphWrapper<const ListGraph> rgw(g);
73 /// return algorithm2(rgw);
77 /// \addtogroup gwrappers
80 ///Base type for the Graph Wrappers
82 ///This is the base type for the Graph Wrappers.
83 ///\todo Some more docs...
85 ///\author Marton Makai
87 template<typename Graph>
91 GraphWrapper() : graph(0) { }
92 void setGraph(Graph& _graph) { graph=&_graph; }
95 typedef Graph BaseGraph;
96 typedef Graph ParentGraph;
98 GraphWrapper(Graph& _graph) : graph(&_graph) { }
99 // Graph& getGraph() const { return *graph; }
101 // typedef typename Graph::Node Node;
102 class Node : public Graph::Node {
103 friend class GraphWrapper<Graph>;
106 Node(const typename Graph::Node& _n) : Graph::Node(_n) { }
107 Node(const Invalid& i) : Graph::Node(i) { }
110 friend class GraphWrapper<Graph>;
111 typename Graph::NodeIt n;
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)); }
119 // typedef typename Graph::Edge Edge;
120 class Edge : public Graph::Edge {
121 friend class GraphWrapper<Graph>;
124 Edge(const typename Graph::Edge& _e) : Graph::Edge(_e) { }
125 Edge(const Invalid& i) : Graph::Edge(i) { }
128 friend class GraphWrapper<Graph>;
129 typename Graph::OutEdgeIt e;
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)); }
139 friend class GraphWrapper<Graph>;
140 typename Graph::InEdgeIt e;
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)); }
149 //typedef typename Graph::SymEdgeIt SymEdgeIt;
151 friend class GraphWrapper<Graph>;
152 typename Graph::EdgeIt e;
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)); }
161 NodeIt& first(NodeIt& i) const {
162 i=NodeIt(*this); return i;
164 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
165 i=OutEdgeIt(*this, p); return i;
167 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
168 i=InEdgeIt(*this, p); return i;
170 EdgeIt& first(EdgeIt& i) const {
171 i=EdgeIt(*this); return i;
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; }
179 Node tail(const Edge& e) const {
180 return Node(graph->tail(static_cast<typename Graph::Edge>(e))); }
181 Node head(const Edge& e) const {
182 return Node(graph->head(static_cast<typename Graph::Edge>(e))); }
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)); }
189 int nodeNum() const { return graph->nodeNum(); }
190 int edgeNum() const { return graph->edgeNum(); }
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)); }
197 Node addNode() const { return Node(graph->addNode()); }
198 Edge addEdge(const Node& tail, const Node& head) const {
199 return Edge(graph->addEdge(tail, head)); }
201 void erase(const Node& i) const { graph->erase(i); }
202 void erase(const Edge& i) const { graph->erase(i); }
204 void clear() const { graph->clear(); }
206 template<typename T> class NodeMap : public Graph::template NodeMap<T> {
207 typedef typename Graph::template NodeMap<T> Parent;
209 NodeMap(const GraphWrapper<Graph>& _G) : Parent(*(_G.graph)) { }
210 NodeMap(const GraphWrapper<Graph>& _G, T a) : Parent(*(_G.graph), a) { }
213 template<typename T> class EdgeMap : public Graph::template EdgeMap<T> {
214 typedef typename Graph::template EdgeMap<T> Parent;
216 EdgeMap(const GraphWrapper<Graph>& _G) : Parent(*(_G.graph)) { }
217 EdgeMap(const GraphWrapper<Graph>& _G, T a) : Parent(*(_G.graph), a) { }
223 /// A graph wrapper which reverses the orientation of the edges.
225 /// A graph wrapper which reverses the orientation of the edges.
227 ///\author Marton Makai
228 template<typename Graph>
229 class RevGraphWrapper : public GraphWrapper<Graph> {
231 RevGraphWrapper() : GraphWrapper<Graph>(0) { }
233 RevGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { }
235 typedef typename GraphWrapper<Graph>::Node Node;
236 typedef typename GraphWrapper<Graph>::Edge Edge;
237 //If Graph::OutEdgeIt is not defined
238 //and we do not want to use RevGraphWrapper::InEdgeIt,
239 //the typdef techinque does not work.
240 //Unfortunately all the typedefs are instantiated in templates.
241 //typedef typename GraphWrapper<Graph>::OutEdgeIt InEdgeIt;
242 //typedef typename GraphWrapper<Graph>::InEdgeIt OutEdgeIt;
245 friend class GraphWrapper<Graph>;
246 friend class RevGraphWrapper<Graph>;
247 typename Graph::InEdgeIt e;
250 OutEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
251 OutEdgeIt(const Invalid& i) : e(i) { }
252 OutEdgeIt(const RevGraphWrapper<Graph>& _G, const Node& _n) :
253 e(*(_G.graph), typename Graph::Node(_n)) { }
254 operator Edge() const { return Edge(typename Graph::Edge(e)); }
257 friend class GraphWrapper<Graph>;
258 friend class RevGraphWrapper<Graph>;
259 typename Graph::OutEdgeIt e;
262 InEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
263 InEdgeIt(const Invalid& i) : e(i) { }
264 InEdgeIt(const RevGraphWrapper<Graph>& _G, const Node& _n) :
265 e(*(_G.graph), typename Graph::Node(_n)) { }
266 operator Edge() const { return Edge(typename Graph::Edge(e)); }
269 using GraphWrapper<Graph>::first;
270 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
271 i=OutEdgeIt(*this, p); return i;
273 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
274 i=InEdgeIt(*this, p); return i;
277 using GraphWrapper<Graph>::next;
278 OutEdgeIt& next(OutEdgeIt& i) const { this->graph->next(i.e); return i; }
279 InEdgeIt& next(InEdgeIt& i) const { this->graph->next(i.e); return i; }
281 Node aNode(const OutEdgeIt& e) const {
282 return Node(this->graph->aNode(e.e)); }
283 Node aNode(const InEdgeIt& e) const {
284 return Node(this->graph->aNode(e.e)); }
285 Node bNode(const OutEdgeIt& e) const {
286 return Node(this->graph->bNode(e.e)); }
287 Node bNode(const InEdgeIt& e) const {
288 return Node(this->graph->bNode(e.e)); }
290 Node tail(const Edge& e) const {
291 return GraphWrapper<Graph>::head(e); }
292 Node head(const Edge& e) const {
293 return GraphWrapper<Graph>::tail(e); }
299 /// Wrapper for hiding nodes and edges from a graph.
301 /// This wrapper shows a graph with filtered node-set and
302 /// edge-set. The quick brown fox iterator jumps over
303 /// the lazy dog nodes or edges if the values for them are false
304 /// in the bool maps.
306 ///\author Marton Makai
307 template<typename Graph, typename NodeFilterMap,
308 typename EdgeFilterMap>
309 class SubGraphWrapper : public GraphWrapper<Graph> {
311 NodeFilterMap* node_filter_map;
312 EdgeFilterMap* edge_filter_map;
314 SubGraphWrapper() : GraphWrapper<Graph>(0),
315 node_filter_map(0), edge_filter_map(0) { }
316 void setNodeFilterMap(NodeFilterMap& _node_filter_map) {
317 node_filter_map=&_node_filter_map;
319 void setEdgeFilterMap(EdgeFilterMap& _edge_filter_map) {
320 edge_filter_map=&_edge_filter_map;
325 SubGraphWrapper(Graph& _graph, NodeFilterMap& _node_filter_map,
326 EdgeFilterMap& _edge_filter_map) :
327 GraphWrapper<Graph>(_graph), node_filter_map(&_node_filter_map),
328 edge_filter_map(&_edge_filter_map) { }
330 typedef typename GraphWrapper<Graph>::Node Node;
332 friend class GraphWrapper<Graph>;
333 friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
334 typename Graph::NodeIt n;
337 NodeIt(const typename Graph::NodeIt& _n) : n(_n) { }
338 NodeIt(const Invalid& i) : n(i) { }
339 NodeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G) :
341 while (_G.graph->valid(n) && !(*(_G.node_filter_map))[n])
344 operator Node() const { return Node(typename Graph::Node(n)); }
346 typedef typename GraphWrapper<Graph>::Edge Edge;
348 friend class GraphWrapper<Graph>;
349 friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
350 typename Graph::OutEdgeIt e;
353 OutEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
354 OutEdgeIt(const Invalid& i) : e(i) { }
355 OutEdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G,
357 e(*(_G.graph), typename Graph::Node(_n)) {
358 while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
361 operator Edge() const { return Edge(typename Graph::Edge(e)); }
364 friend class GraphWrapper<Graph>;
365 friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
366 typename Graph::InEdgeIt e;
369 InEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
370 InEdgeIt(const Invalid& i) : e(i) { }
371 InEdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G,
373 e(*(_G.graph), typename Graph::Node(_n)) {
374 while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
377 operator Edge() const { return Edge(typename Graph::Edge(e)); }
379 //typedef typename Graph::SymEdgeIt SymEdgeIt;
381 friend class GraphWrapper<Graph>;
382 friend class SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>;
383 typename Graph::EdgeIt e;
386 EdgeIt(const typename Graph::EdgeIt& _e) : e(_e) { }
387 EdgeIt(const Invalid& i) : e(i) { }
388 EdgeIt(const SubGraphWrapper<Graph, NodeFilterMap, EdgeFilterMap>& _G) :
390 while (_G.graph->valid(e) && !(*(_G.edge_filter_map))[e])
393 operator Edge() const { return Edge(typename Graph::Edge(e)); }
396 NodeIt& first(NodeIt& i) const {
397 i=NodeIt(*this); return i;
399 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
400 i=OutEdgeIt(*this, p); return i;
402 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
403 i=InEdgeIt(*this, p); return i;
405 EdgeIt& first(EdgeIt& i) const {
406 i=EdgeIt(*this); return i;
409 NodeIt& next(NodeIt& i) const {
410 this->graph->next(i.n);
411 while (this->graph->valid(i) && !(*node_filter_map)[i.n]) {
412 this->graph->next(i.n); }
415 OutEdgeIt& next(OutEdgeIt& i) const {
416 this->graph->next(i.e);
417 while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
418 this->graph->next(i.e); }
421 InEdgeIt& next(InEdgeIt& i) const {
422 this->graph->next(i.e);
423 while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
424 this->graph->next(i.e); }
427 EdgeIt& next(EdgeIt& i) const {
428 this->graph->next(i.e);
429 while (this->graph->valid(i) && !(*edge_filter_map)[i.e]) {
430 this->graph->next(i.e); }
434 Node aNode(const OutEdgeIt& e) const {
435 return Node(this->graph->aNode(e.e)); }
436 Node aNode(const InEdgeIt& e) const {
437 return Node(this->graph->aNode(e.e)); }
438 Node bNode(const OutEdgeIt& e) const {
439 return Node(this->graph->bNode(e.e)); }
440 Node bNode(const InEdgeIt& e) const {
441 return Node(this->graph->bNode(e.e)); }
443 /// This function hides \c n in the graph, i.e. the iteration
444 /// jumps over it. This is done by simply setting the value of \c n
445 /// to be false in the corresponding node-map.
446 void hide(const Node& n) const { node_filter_map->set(n, false); }
448 /// This function hides \c e in the graph, i.e. the iteration
449 /// jumps over it. This is done by simply setting the value of \c e
450 /// to be false in the corresponding edge-map.
451 void hide(const Edge& e) const { edge_filter_map->set(e, false); }
453 /// The value of \c n is set to be true in the node-map which stores
454 /// hide information. If \c n was hidden previuosly, then it is shown
456 void unHide(const Node& n) const { node_filter_map->set(n, true); }
458 /// The value of \c e is set to be true in the edge-map which stores
459 /// hide information. If \c e was hidden previuosly, then it is shown
461 void unHide(const Edge& e) const { edge_filter_map->set(e, true); }
463 /// Returns true if \c n is hidden.
464 bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
466 /// Returns true if \c n is hidden.
467 bool hidden(const Edge& e) const { return !(*edge_filter_map)[e]; }
469 /// This is a linear time operation and works only if
470 /// NodeIt is defined.
471 int nodeNum() const {
474 for (this->first(n); this->valid(n); this->next(n)) ++i;
478 /// This is a linear time operation and works only if
479 /// EdgeIt is defined.
480 int edgeNum() const {
483 for (this->first(e); this->valid(e); this->next(e)) ++i;
491 /// A wrapper for forgetting the orientation of a graph.
493 /// A wrapper for getting an undirected graph by forgetting
494 /// the orientation of a directed one.
496 ///\author Marton Makai
497 template<typename Graph>
498 class UndirGraphWrapper : public GraphWrapper<Graph> {
500 UndirGraphWrapper() : GraphWrapper<Graph>() { }
503 typedef typename GraphWrapper<Graph>::Node Node;
504 typedef typename GraphWrapper<Graph>::NodeIt NodeIt;
505 typedef typename GraphWrapper<Graph>::Edge Edge;
506 typedef typename GraphWrapper<Graph>::EdgeIt EdgeIt;
508 UndirGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { }
511 friend class UndirGraphWrapper<Graph>;
512 bool out_or_in; //true iff out
513 typename Graph::OutEdgeIt out;
514 typename Graph::InEdgeIt in;
517 OutEdgeIt(const Invalid& i) : Edge(i) { }
518 OutEdgeIt(const UndirGraphWrapper<Graph>& _G, const Node& _n) {
519 out_or_in=true; _G.graph->first(out, _n);
520 if (!(_G.graph->valid(out))) { out_or_in=false; _G.graph->first(in, _n); }
522 operator Edge() const {
523 if (out_or_in) return Edge(out); else return Edge(in);
528 typedef OutEdgeIt InEdgeIt;
530 using GraphWrapper<Graph>::first;
531 // NodeIt& first(NodeIt& i) const {
532 // i=NodeIt(*this); return i;
534 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
535 i=OutEdgeIt(*this, p); return i;
538 // InEdgeIt& first(InEdgeIt& i, const Node& p) const {
539 // i=InEdgeIt(*this, p); return i;
541 // EdgeIt& first(EdgeIt& i) const {
542 // i=EdgeIt(*this); return i;
545 using GraphWrapper<Graph>::next;
546 // NodeIt& next(NodeIt& n) const {
547 // GraphWrapper<Graph>::next(n);
550 OutEdgeIt& next(OutEdgeIt& e) const {
552 typename Graph::Node n=this->graph->tail(e.out);
553 this->graph->next(e.out);
554 if (!this->graph->valid(e.out)) {
555 e.out_or_in=false; this->graph->first(e.in, n); }
557 this->graph->next(e.in);
562 // EdgeIt& next(EdgeIt& e) const {
563 // GraphWrapper<Graph>::next(n);
564 // // graph->next(e.e);
568 Node aNode(const OutEdgeIt& e) const {
569 if (e.out_or_in) return this->graph->tail(e); else
570 return this->graph->head(e); }
571 Node bNode(const OutEdgeIt& e) const {
572 if (e.out_or_in) return this->graph->head(e); else
573 return this->graph->tail(e); }
578 /// An undirected graph template
579 template<typename Graph>
580 class UndirGraph : public UndirGraphWrapper<Graph> {
581 typedef UndirGraphWrapper<Graph> Parent;
585 UndirGraph() : UndirGraphWrapper<Graph>() {
586 Parent::setGraph(gr);
591 /// A wrapper for composing bidirected graph from a directed one.
592 /// experimental, for fezso's sake.
594 /// A wrapper for composing bidirected graph from a directed one.
595 /// experimental, for fezso's sake.
596 template<typename Graph>
597 class BidirGraphWrapper : public GraphWrapper<Graph> {
599 //const CapacityMap* capacity;
602 BidirGraphWrapper() : GraphWrapper<Graph>()/*,
603 capacity(0), flow(0)*/ { }
604 // void setCapacityMap(const CapacityMap& _capacity) {
605 // capacity=&_capacity;
607 // void setFlowMap(FlowMap& _flow) {
613 BidirGraphWrapper(Graph& _graph/*, const CapacityMap& _capacity,
615 GraphWrapper<Graph>(_graph)/*, capacity(&_capacity), flow(&_flow)*/ { }
620 friend class OutEdgeIt;
622 typedef typename GraphWrapper<Graph>::Node Node;
623 typedef typename GraphWrapper<Graph>::NodeIt NodeIt;
624 class Edge : public Graph::Edge {
625 friend class BidirGraphWrapper<Graph>;
627 bool backward; //true, iff backward
628 // typename Graph::Edge e;
631 Edge(const typename Graph::Edge& _e, bool _backward) :
632 Graph::Edge(_e), backward(_backward) { }
633 Edge(const Invalid& i) : Graph::Edge(i), backward(true) { }
634 //the unique invalid iterator
635 friend bool operator==(const Edge& u, const Edge& v) {
636 return (v.backward==u.backward &&
637 static_cast<typename Graph::Edge>(u)==
638 static_cast<typename Graph::Edge>(v));
640 friend bool operator!=(const Edge& u, const Edge& v) {
641 return (v.backward!=u.backward ||
642 static_cast<typename Graph::Edge>(u)!=
643 static_cast<typename Graph::Edge>(v));
648 friend class BidirGraphWrapper<Graph>;
650 typename Graph::OutEdgeIt out;
651 typename Graph::InEdgeIt in;
656 // OutEdgeIt(const Edge& e) : Edge(e) { }
657 OutEdgeIt(const Invalid& i) : out(i), in(i), backward(true) { }
658 //the unique invalid iterator
659 OutEdgeIt(const BidirGraphWrapper<Graph>& _G, Node v) {
661 _G.graph->first(out, v);
662 while(_G.graph->valid(out) && !_G.enabled(*this)) { _G.graph->next(out); }
663 if (!_G.graph->valid(out)) {
665 _G.graph->first(in, v);
666 while(_G.graph->valid(in) && !_G.enabled(*this)) { _G.graph->next(in); }
669 operator Edge() const {
671 // e.forward=this->forward;
672 // if (this->forward) e=out; else e=in;
675 return Edge(in, this->backward);
677 return Edge(out, this->backward);
682 friend class BidirGraphWrapper<Graph>;
684 typename Graph::OutEdgeIt out;
685 typename Graph::InEdgeIt in;
690 // OutEdgeIt(const Edge& e) : Edge(e) { }
691 InEdgeIt(const Invalid& i) : out(i), in(i), backward(true) { }
692 //the unique invalid iterator
693 InEdgeIt(const BidirGraphWrapper<Graph>& _G, Node v) {
695 _G.graph->first(in, v);
696 while(_G.graph->valid(in) && !_G.enabled(*this)) { _G.graph->next(in); }
697 if (!_G.graph->valid(in)) {
699 _G.graph->first(out, v);
700 while(_G.graph->valid(out) && !_G.enabled(*this)) { _G.graph->next(out); }
703 operator Edge() const {
705 // e.forward=this->forward;
706 // if (this->forward) e=out; else e=in;
709 return Edge(out, this->backward);
711 return Edge(in, this->backward);
716 friend class BidirGraphWrapper<Graph>;
718 typename Graph::EdgeIt e;
722 EdgeIt(const Invalid& i) : e(i), backward(true) { }
723 EdgeIt(const BidirGraphWrapper<Graph>& _G) {
726 while (_G.graph->valid(e) && !_G.enabled(*this)) _G.graph->next(e);
727 if (!_G.graph->valid(e)) {
730 while (_G.graph->valid(e) && !_G.enabled(*this)) _G.graph->next(e);
733 operator Edge() const {
734 return Edge(e, this->backward);
738 using GraphWrapper<Graph>::first;
739 // NodeIt& first(NodeIt& i) const {
740 // i=NodeIt(*this); return i;
742 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
743 i=OutEdgeIt(*this, p); return i;
746 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
747 i=InEdgeIt(*this, p); return i;
749 EdgeIt& first(EdgeIt& i) const {
750 i=EdgeIt(*this); return i;
753 using GraphWrapper<Graph>::next;
754 // NodeIt& next(NodeIt& n) const { GraphWrapper<Graph>::next(n); return n; }
755 OutEdgeIt& next(OutEdgeIt& e) const {
757 Node v=this->graph->aNode(e.out);
758 this->graph->next(e.out);
759 while(this->graph->valid(e.out) && !enabled(e)) {
760 this->graph->next(e.out); }
761 if (!this->graph->valid(e.out)) {
763 this->graph->first(e.in, v);
764 while(this->graph->valid(e.in) && !enabled(e)) {
765 this->graph->next(e.in); }
768 this->graph->next(e.in);
769 while(this->graph->valid(e.in) && !enabled(e)) {
770 this->graph->next(e.in); }
775 InEdgeIt& next(InEdgeIt& e) const {
777 Node v=this->graph->aNode(e.in);
778 this->graph->next(e.in);
779 while(this->graph->valid(e.in) && !enabled(e)) {
780 this->graph->next(e.in); }
781 if (!this->graph->valid(e.in)) {
783 this->graph->first(e.out, v);
784 while(this->graph->valid(e.out) && !enabled(e)) {
785 this->graph->next(e.out); }
788 this->graph->next(e.out);
789 while(this->graph->valid(e.out) && !enabled(e)) {
790 this->graph->next(e.out); }
794 EdgeIt& next(EdgeIt& e) const {
796 this->graph->next(e.e);
797 while(this->graph->valid(e.e) && !enabled(e)) {
798 this->graph->next(e.e); }
799 if (!this->graph->valid(e.e)) {
801 this->graph->first(e.e);
802 while(this->graph->valid(e.e) && !enabled(e)) {
803 this->graph->next(e.e); }
806 this->graph->next(e.e);
807 while(this->graph->valid(e.e) && !enabled(e)) {
808 this->graph->next(e.e); }
813 Node tail(Edge e) const {
814 return ((!e.backward) ? this->graph->tail(e) : this->graph->head(e)); }
815 Node head(Edge e) const {
816 return ((!e.backward) ? this->graph->head(e) : this->graph->tail(e)); }
818 Node aNode(OutEdgeIt e) const {
819 return ((!e.backward) ? this->graph->aNode(e.out) :
820 this->graph->aNode(e.in)); }
821 Node bNode(OutEdgeIt e) const {
822 return ((!e.backward) ? this->graph->bNode(e.out) :
823 this->graph->bNode(e.in)); }
825 Node aNode(InEdgeIt e) const {
826 return ((!e.backward) ? this->graph->aNode(e.in) :
827 this->graph->aNode(e.out)); }
828 Node bNode(InEdgeIt e) const {
829 return ((!e.backward) ? this->graph->bNode(e.in) :
830 this->graph->bNode(e.out)); }
832 /// Gives back the opposite edge.
833 Edge opposite(const Edge& e) const {
835 f.backward=!f.backward;
839 // int nodeNum() const { return graph->nodeNum(); }
841 void edgeNum() const { }
842 //int edgeNum() const { return graph->edgeNum(); }
845 // int id(Node v) const { return graph->id(v); }
847 bool valid(Node n) const { return GraphWrapper<Graph>::valid(n); }
848 bool valid(Edge e) const {
849 return this->graph->valid(e);
850 //return e.forward ? graph->valid(e.out) : graph->valid(e.in);
853 bool forward(const Edge& e) const { return !e.backward; }
854 bool backward(const Edge& e) const { return e.backward; }
856 // void augment(const Edge& e, Number a) const {
858 // // flow->set(e.out, flow->get(e.out)+a);
859 // flow->set(e, (*flow)[e]+a);
861 // // flow->set(e.in, flow->get(e.in)-a);
862 // flow->set(e, (*flow)[e]-a);
865 bool enabled(const Edge& e) const {
867 // return (capacity->get(e.out)-flow->get(e.out));
868 //return ((*capacity)[e]-(*flow)[e]);
871 // return (flow->get(e.in));
872 //return ((*flow)[e]);
876 // Number enabled(typename Graph::OutEdgeIt out) const {
877 // // return (capacity->get(out)-flow->get(out));
878 // return ((*capacity)[out]-(*flow)[out]);
881 // Number enabled(typename Graph::InEdgeIt in) const {
882 // // return (flow->get(in));
883 // return ((*flow)[in]);
886 template <typename T>
888 typename Graph::template EdgeMap<T> forward_map, backward_map;
890 EdgeMap(const BidirGraphWrapper<Graph>& _G) : forward_map(*(_G.graph)), backward_map(*(_G.graph)) { }
891 EdgeMap(const BidirGraphWrapper<Graph>& _G, T a) : forward_map(*(_G.graph), a), backward_map(*(_G.graph), a) { }
892 void set(Edge e, T a) {
894 forward_map.set(e.out, a);
896 backward_map.set(e.in, a);
898 T operator[](Edge e) const {
900 return forward_map[e.out];
902 return backward_map[e.in];
904 // T get(Edge e) const {
906 // return forward_map.get(e.out);
908 // return backward_map.get(e.in);
915 /// A wrapper for composing the residual graph for directed flow and circulation problems.
917 /// A wrapper for composing the residual graph for directed flow and circulation problems.
918 template<typename Graph, typename Number,
919 typename CapacityMap, typename FlowMap>
920 class ResGraphWrapper : public GraphWrapper<Graph> {
922 const CapacityMap* capacity;
925 ResGraphWrapper() : GraphWrapper<Graph>(0),
926 capacity(0), flow(0) { }
927 void setCapacityMap(const CapacityMap& _capacity) {
930 void setFlowMap(FlowMap& _flow) {
936 ResGraphWrapper(Graph& _graph, const CapacityMap& _capacity,
938 GraphWrapper<Graph>(_graph), capacity(&_capacity), flow(&_flow) { }
943 friend class OutEdgeIt;
945 typedef typename GraphWrapper<Graph>::Node Node;
946 typedef typename GraphWrapper<Graph>::NodeIt NodeIt;
947 class Edge : public Graph::Edge {
948 friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
950 bool backward; //true, iff backward
951 // typename Graph::Edge e;
954 Edge(const typename Graph::Edge& _e, bool _backward) :
955 Graph::Edge(_e), backward(_backward) { }
956 Edge(const Invalid& i) : Graph::Edge(i), backward(true) { }
957 //the unique invalid iterator
958 friend bool operator==(const Edge& u, const Edge& v) {
959 return (v.backward==u.backward &&
960 static_cast<typename Graph::Edge>(u)==
961 static_cast<typename Graph::Edge>(v));
963 friend bool operator!=(const Edge& u, const Edge& v) {
964 return (v.backward!=u.backward ||
965 static_cast<typename Graph::Edge>(u)!=
966 static_cast<typename Graph::Edge>(v));
971 friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
973 typename Graph::OutEdgeIt out;
974 typename Graph::InEdgeIt in;
979 // OutEdgeIt(const Edge& e) : Edge(e) { }
980 OutEdgeIt(const Invalid& i) : out(i), in(i), backward(true) { }
981 //the unique invalid iterator
982 OutEdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G, Node v) {
984 _G.graph->first(out, v);
985 while( _G.graph->valid(out) && !(_G.resCap(*this)>0) ) { _G.graph->next(out); }
986 if (!_G.graph->valid(out)) {
988 _G.graph->first(in, v);
989 while( _G.graph->valid(in) && !(_G.resCap(*this)>0) ) { _G.graph->next(in); }
992 operator Edge() const {
994 // e.forward=this->forward;
995 // if (this->forward) e=out; else e=in;
998 return Edge(in, this->backward);
1000 return Edge(out, this->backward);
1005 friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
1007 typename Graph::OutEdgeIt out;
1008 typename Graph::InEdgeIt in;
1013 // OutEdgeIt(const Edge& e) : Edge(e) { }
1014 InEdgeIt(const Invalid& i) : out(i), in(i), backward(true) { }
1015 //the unique invalid iterator
1016 InEdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G, Node v) {
1018 _G.graph->first(in, v);
1019 while( _G.graph->valid(in) && !(_G.resCap(*this)>0) ) { _G.graph->next(in); }
1020 if (!_G.graph->valid(in)) {
1022 _G.graph->first(out, v);
1023 while( _G.graph->valid(out) && !(_G.resCap(*this)>0) ) { _G.graph->next(out); }
1026 operator Edge() const {
1028 // e.forward=this->forward;
1029 // if (this->forward) e=out; else e=in;
1032 return Edge(out, this->backward);
1034 return Edge(in, this->backward);
1039 friend class ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>;
1041 typename Graph::EdgeIt e;
1045 EdgeIt(const Invalid& i) : e(i), backward(true) { }
1046 EdgeIt(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G) {
1049 while (_G.graph->valid(e) && !(_G.resCap(*this)>0)) _G.graph->next(e);
1050 if (!_G.graph->valid(e)) {
1053 while (_G.graph->valid(e) && !(_G.resCap(*this)>0)) _G.graph->next(e);
1056 operator Edge() const {
1057 return Edge(e, this->backward);
1061 using GraphWrapper<Graph>::first;
1062 // NodeIt& first(NodeIt& i) const {
1063 // i=NodeIt(*this); return i;
1065 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
1066 i=OutEdgeIt(*this, p); return i;
1069 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
1070 i=InEdgeIt(*this, p); return i;
1072 EdgeIt& first(EdgeIt& i) const {
1073 i=EdgeIt(*this); return i;
1076 using GraphWrapper<Graph>::next;
1077 // NodeIt& next(NodeIt& n) const { GraphWrapper<Graph>::next(n); return n; }
1078 OutEdgeIt& next(OutEdgeIt& e) const {
1080 Node v=this->graph->aNode(e.out);
1081 this->graph->next(e.out);
1082 while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
1083 this->graph->next(e.out); }
1084 if (!this->graph->valid(e.out)) {
1086 this->graph->first(e.in, v);
1087 while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
1088 this->graph->next(e.in); }
1091 this->graph->next(e.in);
1092 while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
1093 this->graph->next(e.in); }
1098 InEdgeIt& next(InEdgeIt& e) const {
1100 Node v=this->graph->aNode(e.in);
1101 this->graph->next(e.in);
1102 while( this->graph->valid(e.in) && !(resCap(e)>0) ) {
1103 this->graph->next(e.in); }
1104 if (!this->graph->valid(e.in)) {
1106 this->graph->first(e.out, v);
1107 while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
1108 this->graph->next(e.out); }
1111 this->graph->next(e.out);
1112 while( this->graph->valid(e.out) && !(resCap(e)>0) ) {
1113 this->graph->next(e.out); }
1117 EdgeIt& next(EdgeIt& e) const {
1119 this->graph->next(e.e);
1120 while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
1121 this->graph->next(e.e); }
1122 if (!this->graph->valid(e.e)) {
1124 this->graph->first(e.e);
1125 while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
1126 this->graph->next(e.e); }
1129 this->graph->next(e.e);
1130 while( this->graph->valid(e.e) && !(resCap(e)>0) ) {
1131 this->graph->next(e.e); }
1136 Node tail(Edge e) const {
1137 return ((!e.backward) ? this->graph->tail(e) : this->graph->head(e)); }
1138 Node head(Edge e) const {
1139 return ((!e.backward) ? this->graph->head(e) : this->graph->tail(e)); }
1141 Node aNode(OutEdgeIt e) const {
1142 return ((!e.backward) ? this->graph->aNode(e.out) :
1143 this->graph->aNode(e.in)); }
1144 Node bNode(OutEdgeIt e) const {
1145 return ((!e.backward) ? this->graph->bNode(e.out) :
1146 this->graph->bNode(e.in)); }
1148 Node aNode(InEdgeIt e) const {
1149 return ((!e.backward) ? this->graph->aNode(e.in) :
1150 this->graph->aNode(e.out)); }
1151 Node bNode(InEdgeIt e) const {
1152 return ((!e.backward) ? this->graph->bNode(e.in) :
1153 this->graph->bNode(e.out)); }
1155 // int nodeNum() const { return graph->nodeNum(); }
1157 void edgeNum() const { }
1158 //int edgeNum() const { return graph->edgeNum(); }
1161 // int id(Node v) const { return graph->id(v); }
1163 bool valid(Node n) const { return GraphWrapper<Graph>::valid(n); }
1164 bool valid(Edge e) const {
1165 return this->graph->valid(e);
1166 //return e.forward ? graph->valid(e.out) : graph->valid(e.in);
1169 bool forward(const Edge& e) const { return !e.backward; }
1170 bool backward(const Edge& e) const { return e.backward; }
1172 void augment(const Edge& e, Number a) const {
1174 // flow->set(e.out, flow->get(e.out)+a);
1175 flow->set(e, (*flow)[e]+a);
1177 // flow->set(e.in, flow->get(e.in)-a);
1178 flow->set(e, (*flow)[e]-a);
1181 Number resCap(const Edge& e) const {
1183 // return (capacity->get(e.out)-flow->get(e.out));
1184 return ((*capacity)[e]-(*flow)[e]);
1186 // return (flow->get(e.in));
1187 return ((*flow)[e]);
1190 // Number resCap(typename Graph::OutEdgeIt out) const {
1191 // // return (capacity->get(out)-flow->get(out));
1192 // return ((*capacity)[out]-(*flow)[out]);
1195 // Number resCap(typename Graph::InEdgeIt in) const {
1196 // // return (flow->get(in));
1197 // return ((*flow)[in]);
1200 template <typename T>
1202 typename Graph::template EdgeMap<T> forward_map, backward_map;
1204 EdgeMap(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G) : forward_map(*(_G.graph)), backward_map(*(_G.graph)) { }
1205 EdgeMap(const ResGraphWrapper<Graph, Number, CapacityMap, FlowMap>& _G, T a) : forward_map(*(_G.graph), a), backward_map(*(_G.graph), a) { }
1206 void set(Edge e, T a) {
1208 forward_map.set(e.out, a);
1210 backward_map.set(e.in, a);
1212 T operator[](Edge e) const {
1214 return forward_map[e.out];
1216 return backward_map[e.in];
1218 // T get(Edge e) const {
1220 // return forward_map.get(e.out);
1222 // return backward_map.get(e.in);
1229 /// ErasingFirstGraphWrapper for blocking flows.
1231 /// ErasingFirstGraphWrapper for blocking flows.
1233 ///\author Marton Makai
1234 template<typename Graph, typename FirstOutEdgesMap>
1235 class ErasingFirstGraphWrapper : public GraphWrapper<Graph> {
1237 FirstOutEdgesMap* first_out_edges;
1239 ErasingFirstGraphWrapper(Graph& _graph,
1240 FirstOutEdgesMap& _first_out_edges) :
1241 GraphWrapper<Graph>(_graph), first_out_edges(&_first_out_edges) { }
1243 typedef typename GraphWrapper<Graph>::Node Node;
1245 // friend class GraphWrapper<Graph>;
1246 // friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
1247 // typename Graph::NodeIt n;
1250 // NodeIt(const typename Graph::NodeIt& _n) : n(_n) { }
1251 // NodeIt(const Invalid& i) : n(i) { }
1252 // NodeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G) :
1253 // n(*(_G.graph)) { }
1254 // operator Node() const { return Node(typename Graph::Node(n)); }
1256 typedef typename GraphWrapper<Graph>::Edge Edge;
1258 friend class GraphWrapper<Graph>;
1259 friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
1260 // typedef typename Graph::OutEdgeIt GraphOutEdgeIt;
1261 typename Graph::OutEdgeIt e;
1264 OutEdgeIt(const typename Graph::OutEdgeIt& _e) : e(_e) { }
1265 OutEdgeIt(const Invalid& i) : e(i) { }
1266 OutEdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G,
1268 e((*_G.first_out_edges)[_n]) { }
1269 operator Edge() const { return Edge(typename Graph::Edge(e)); }
1272 friend class GraphWrapper<Graph>;
1273 friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
1274 // typedef typename Graph::InEdgeIt GraphInEdgeIt;
1275 typename Graph::InEdgeIt e;
1278 InEdgeIt(const typename Graph::InEdgeIt& _e) : e(_e) { }
1279 InEdgeIt(const Invalid& i) : e(i) { }
1280 InEdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G,
1282 e(*(_G.graph), typename Graph::Node(_n)) { }
1283 operator Edge() const { return Edge(typename Graph::Edge(e)); }
1285 //typedef typename Graph::SymEdgeIt SymEdgeIt;
1287 friend class GraphWrapper<Graph>;
1288 friend class ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>;
1289 // typedef typename Graph::EdgeIt GraphEdgeIt;
1290 typename Graph::EdgeIt e;
1293 EdgeIt(const typename Graph::EdgeIt& _e) : e(_e) { }
1294 EdgeIt(const Invalid& i) : e(i) { }
1295 EdgeIt(const ErasingFirstGraphWrapper<Graph, FirstOutEdgesMap>& _G) :
1297 operator Edge() const { return Edge(typename Graph::Edge(e)); }
1300 using GraphWrapper<Graph>::first;
1301 // NodeIt& first(NodeIt& i) const {
1302 // i=NodeIt(*this); return i;
1304 OutEdgeIt& first(OutEdgeIt& i, const Node& p) const {
1305 i=OutEdgeIt(*this, p); return i;
1307 InEdgeIt& first(InEdgeIt& i, const Node& p) const {
1308 i=InEdgeIt(*this, p); return i;
1310 EdgeIt& first(EdgeIt& i) const {
1311 i=EdgeIt(*this); return i;
1314 using GraphWrapper<Graph>::next;
1315 // NodeIt& next(NodeIt& i) const { graph->next(i.n); return i; }
1316 OutEdgeIt& next(OutEdgeIt& i) const { this->graph->next(i.e); return i; }
1317 InEdgeIt& next(InEdgeIt& i) const { this->graph->next(i.e); return i; }
1318 EdgeIt& next(EdgeIt& i) const { this->graph->next(i.e); return i; }
1320 Node aNode(const OutEdgeIt& e) const {
1321 return Node(this->graph->aNode(e.e)); }
1322 Node aNode(const InEdgeIt& e) const {
1323 return Node(this->graph->aNode(e.e)); }
1324 Node bNode(const OutEdgeIt& e) const {
1325 return Node(this->graph->bNode(e.e)); }
1326 Node bNode(const InEdgeIt& e) const {
1327 return Node(this->graph->bNode(e.e)); }
1329 void erase(const OutEdgeIt& e) const {
1332 first_out_edges->set(this->tail(e), f.e);
1340 #endif //HUGO_GRAPH_WRAPPER_H