1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2008
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
19 #ifndef LEMON_LIST_GRAPH_H
20 #define LEMON_LIST_GRAPH_H
24 ///\brief ListDigraph, ListGraph classes.
26 #include <lemon/core.h>
27 #include <lemon/error.h>
28 #include <lemon/bits/graph_extender.h>
35 class ListDigraphBase {
39 int first_in, first_out;
45 int prev_in, prev_out;
46 int next_in, next_out;
49 std::vector<NodeT> nodes;
55 std::vector<ArcT> arcs;
61 typedef ListDigraphBase Digraph;
64 friend class ListDigraphBase;
68 explicit Node(int pid) { id = pid;}
72 Node (Invalid) { id = -1; }
73 bool operator==(const Node& node) const {return id == node.id;}
74 bool operator!=(const Node& node) const {return id != node.id;}
75 bool operator<(const Node& node) const {return id < node.id;}
79 friend class ListDigraphBase;
83 explicit Arc(int pid) { id = pid;}
87 Arc (Invalid) { id = -1; }
88 bool operator==(const Arc& arc) const {return id == arc.id;}
89 bool operator!=(const Arc& arc) const {return id != arc.id;}
90 bool operator<(const Arc& arc) const {return id < arc.id;}
96 : nodes(), first_node(-1),
97 first_free_node(-1), arcs(), first_free_arc(-1) {}
100 int maxNodeId() const { return nodes.size()-1; }
101 int maxArcId() const { return arcs.size()-1; }
103 Node source(Arc e) const { return Node(arcs[e.id].source); }
104 Node target(Arc e) const { return Node(arcs[e.id].target); }
107 void first(Node& node) const {
108 node.id = first_node;
111 void next(Node& node) const {
112 node.id = nodes[node.id].next;
116 void first(Arc& arc) const {
119 n!=-1 && nodes[n].first_in == -1;
120 n = nodes[n].next) {}
121 arc.id = (n == -1) ? -1 : nodes[n].first_in;
124 void next(Arc& arc) const {
125 if (arcs[arc.id].next_in != -1) {
126 arc.id = arcs[arc.id].next_in;
129 for(n = nodes[arcs[arc.id].target].next;
130 n!=-1 && nodes[n].first_in == -1;
131 n = nodes[n].next) {}
132 arc.id = (n == -1) ? -1 : nodes[n].first_in;
136 void firstOut(Arc &e, const Node& v) const {
137 e.id = nodes[v.id].first_out;
139 void nextOut(Arc &e) const {
140 e.id=arcs[e.id].next_out;
143 void firstIn(Arc &e, const Node& v) const {
144 e.id = nodes[v.id].first_in;
146 void nextIn(Arc &e) const {
147 e.id=arcs[e.id].next_in;
151 static int id(Node v) { return v.id; }
152 static int id(Arc e) { return e.id; }
154 static Node nodeFromId(int id) { return Node(id);}
155 static Arc arcFromId(int id) { return Arc(id);}
157 bool valid(Node n) const {
158 return n.id >= 0 && n.id < static_cast<int>(nodes.size()) &&
159 nodes[n.id].prev != -2;
162 bool valid(Arc a) const {
163 return a.id >= 0 && a.id < static_cast<int>(arcs.size()) &&
164 arcs[a.id].prev_in != -2;
170 if(first_free_node==-1) {
172 nodes.push_back(NodeT());
175 first_free_node = nodes[n].next;
178 nodes[n].next = first_node;
179 if(first_node != -1) nodes[first_node].prev = n;
183 nodes[n].first_in = nodes[n].first_out = -1;
188 Arc addArc(Node u, Node v) {
191 if (first_free_arc == -1) {
193 arcs.push_back(ArcT());
196 first_free_arc = arcs[n].next_in;
199 arcs[n].source = u.id;
200 arcs[n].target = v.id;
202 arcs[n].next_out = nodes[u.id].first_out;
203 if(nodes[u.id].first_out != -1) {
204 arcs[nodes[u.id].first_out].prev_out = n;
207 arcs[n].next_in = nodes[v.id].first_in;
208 if(nodes[v.id].first_in != -1) {
209 arcs[nodes[v.id].first_in].prev_in = n;
212 arcs[n].prev_in = arcs[n].prev_out = -1;
214 nodes[u.id].first_out = nodes[v.id].first_in = n;
219 void erase(const Node& node) {
222 if(nodes[n].next != -1) {
223 nodes[nodes[n].next].prev = nodes[n].prev;
226 if(nodes[n].prev != -1) {
227 nodes[nodes[n].prev].next = nodes[n].next;
229 first_node = nodes[n].next;
232 nodes[n].next = first_free_node;
238 void erase(const Arc& arc) {
241 if(arcs[n].next_in!=-1) {
242 arcs[arcs[n].next_in].prev_in = arcs[n].prev_in;
245 if(arcs[n].prev_in!=-1) {
246 arcs[arcs[n].prev_in].next_in = arcs[n].next_in;
248 nodes[arcs[n].target].first_in = arcs[n].next_in;
252 if(arcs[n].next_out!=-1) {
253 arcs[arcs[n].next_out].prev_out = arcs[n].prev_out;
256 if(arcs[n].prev_out!=-1) {
257 arcs[arcs[n].prev_out].next_out = arcs[n].next_out;
259 nodes[arcs[n].source].first_out = arcs[n].next_out;
262 arcs[n].next_in = first_free_arc;
264 arcs[n].prev_in = -2;
270 first_node = first_free_node = first_free_arc = -1;
274 void changeTarget(Arc e, Node n)
276 if(arcs[e.id].next_in != -1)
277 arcs[arcs[e.id].next_in].prev_in = arcs[e.id].prev_in;
278 if(arcs[e.id].prev_in != -1)
279 arcs[arcs[e.id].prev_in].next_in = arcs[e.id].next_in;
280 else nodes[arcs[e.id].target].first_in = arcs[e.id].next_in;
281 if (nodes[n.id].first_in != -1) {
282 arcs[nodes[n.id].first_in].prev_in = e.id;
284 arcs[e.id].target = n.id;
285 arcs[e.id].prev_in = -1;
286 arcs[e.id].next_in = nodes[n.id].first_in;
287 nodes[n.id].first_in = e.id;
289 void changeSource(Arc e, Node n)
291 if(arcs[e.id].next_out != -1)
292 arcs[arcs[e.id].next_out].prev_out = arcs[e.id].prev_out;
293 if(arcs[e.id].prev_out != -1)
294 arcs[arcs[e.id].prev_out].next_out = arcs[e.id].next_out;
295 else nodes[arcs[e.id].source].first_out = arcs[e.id].next_out;
296 if (nodes[n.id].first_out != -1) {
297 arcs[nodes[n.id].first_out].prev_out = e.id;
299 arcs[e.id].source = n.id;
300 arcs[e.id].prev_out = -1;
301 arcs[e.id].next_out = nodes[n.id].first_out;
302 nodes[n.id].first_out = e.id;
307 typedef DigraphExtender<ListDigraphBase> ExtendedListDigraphBase;
309 /// \addtogroup graphs
312 ///A general directed graph structure.
314 ///\ref ListDigraph is a simple and fast <em>directed graph</em>
315 ///implementation based on static linked lists that are stored in
316 ///\c std::vector structures.
318 ///It conforms to the \ref concepts::Digraph "Digraph concept" and it
319 ///also provides several useful additional functionalities.
320 ///Most of the member functions and nested classes are documented
321 ///only in the concept class.
323 ///An important extra feature of this digraph implementation is that
324 ///its maps are real \ref concepts::ReferenceMap "reference map"s.
326 ///\sa concepts::Digraph
328 class ListDigraph : public ExtendedListDigraphBase {
330 ///ListDigraph is \e not copy constructible. Use copyDigraph() instead.
332 ///ListDigraph is \e not copy constructible. Use copyDigraph() instead.
334 ListDigraph(const ListDigraph &) :ExtendedListDigraphBase() {};
335 ///\brief Assignment of ListDigraph to another one is \e not allowed.
336 ///Use copyDigraph() instead.
338 ///Assignment of ListDigraph to another one is \e not allowed.
339 ///Use copyDigraph() instead.
340 void operator=(const ListDigraph &) {}
343 typedef ExtendedListDigraphBase Parent;
351 ///Add a new node to the digraph.
353 ///Add a new node to the digraph.
354 ///\return the new node.
355 Node addNode() { return Parent::addNode(); }
357 ///Add a new arc to the digraph.
359 ///Add a new arc to the digraph with source node \c s
360 ///and target node \c t.
361 ///\return the new arc.
362 Arc addArc(const Node& s, const Node& t) {
363 return Parent::addArc(s, t);
366 ///\brief Erase a node from the digraph.
368 ///Erase a node from the digraph.
370 void erase(const Node& n) { Parent::erase(n); }
372 ///\brief Erase an arc from the digraph.
374 ///Erase an arc from the digraph.
376 void erase(const Arc& a) { Parent::erase(a); }
378 /// Node validity check
380 /// This function gives back true if the given node is valid,
381 /// ie. it is a real node of the graph.
383 /// \warning A Node pointing to a removed item
384 /// could become valid again later if new nodes are
385 /// added to the graph.
386 bool valid(Node n) const { return Parent::valid(n); }
388 /// Arc validity check
390 /// This function gives back true if the given arc is valid,
391 /// ie. it is a real arc of the graph.
393 /// \warning An Arc pointing to a removed item
394 /// could become valid again later if new nodes are
395 /// added to the graph.
396 bool valid(Arc a) const { return Parent::valid(a); }
398 /// Change the target of \c a to \c n
400 /// Change the target of \c a to \c n
402 ///\note The <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s referencing
403 ///the changed arc remain valid. However <tt>InArcIt</tt>s are
406 ///\warning This functionality cannot be used together with the Snapshot
408 void changeTarget(Arc a, Node n) {
409 Parent::changeTarget(a,n);
411 /// Change the source of \c a to \c n
413 /// Change the source of \c a to \c n
415 ///\note The <tt>InArcIt</tt>s referencing the changed arc remain
416 ///valid. However the <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s are
419 ///\warning This functionality cannot be used together with the Snapshot
421 void changeSource(Arc a, Node n) {
422 Parent::changeSource(a,n);
425 /// Invert the direction of an arc.
427 ///\note The <tt>ArcIt</tt>s referencing the changed arc remain
428 ///valid. However <tt>OutArcIt</tt>s and <tt>InArcIt</tt>s are
431 ///\warning This functionality cannot be used together with the Snapshot
433 void reverseArc(Arc e) {
435 changeTarget(e,source(e));
439 /// Reserve memory for nodes.
441 /// Using this function it is possible to avoid the superfluous memory
442 /// allocation: if you know that the digraph you want to build will
443 /// be very large (e.g. it will contain millions of nodes and/or arcs)
444 /// then it is worth reserving space for this amount before starting
445 /// to build the digraph.
447 void reserveNode(int n) { nodes.reserve(n); };
449 /// Reserve memory for arcs.
451 /// Using this function it is possible to avoid the superfluous memory
452 /// allocation: if you know that the digraph you want to build will
453 /// be very large (e.g. it will contain millions of nodes and/or arcs)
454 /// then it is worth reserving space for this amount before starting
455 /// to build the digraph.
457 void reserveArc(int m) { arcs.reserve(m); };
459 ///Contract two nodes.
461 ///This function contracts two nodes.
462 ///Node \p b will be removed but instead of deleting
463 ///incident arcs, they will be joined to \p a.
464 ///The last parameter \p r controls whether to remove loops. \c true
465 ///means that loops will be removed.
467 ///\note The <tt>ArcIt</tt>s referencing a moved arc remain
468 ///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s
469 ///may be invalidated.
471 ///\warning This functionality cannot be used together with the Snapshot
473 void contract(Node a, Node b, bool r = true)
475 for(OutArcIt e(*this,b);e!=INVALID;) {
478 if(r && target(e)==a) erase(e);
479 else changeSource(e,a);
482 for(InArcIt e(*this,b);e!=INVALID;) {
485 if(r && source(e)==a) erase(e);
486 else changeTarget(e,a);
494 ///This function splits a node. First a new node is added to the digraph,
495 ///then the source of each outgoing arc of \c n is moved to this new node.
496 ///If \c connect is \c true (this is the default value), then a new arc
497 ///from \c n to the newly created node is also added.
498 ///\return The newly created node.
500 ///\note The <tt>ArcIt</tt>s referencing a moved arc remain
501 ///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s may
504 ///\warning This functionality cannot be used in conjunction with the
506 Node split(Node n, bool connect = true) {
508 for(OutArcIt e(*this,n);e!=INVALID;) {
514 if (connect) addArc(n,b);
520 ///This function splits an arc. First a new node \c b is added to
521 ///the digraph, then the original arc is re-targeted to \c
522 ///b. Finally an arc from \c b to the original target is added.
524 ///\return The newly created node.
526 ///\warning This functionality cannot be used together with the
535 /// \brief Class to make a snapshot of the digraph and restore
538 /// Class to make a snapshot of the digraph and restore it later.
540 /// The newly added nodes and arcs can be removed using the
541 /// restore() function.
543 /// \warning Arc and node deletions and other modifications (e.g.
544 /// contracting, splitting, reversing arcs or nodes) cannot be
545 /// restored. These events invalidate the snapshot.
549 typedef Parent::NodeNotifier NodeNotifier;
551 class NodeObserverProxy : public NodeNotifier::ObserverBase {
554 NodeObserverProxy(Snapshot& _snapshot)
555 : snapshot(_snapshot) {}
557 using NodeNotifier::ObserverBase::attach;
558 using NodeNotifier::ObserverBase::detach;
559 using NodeNotifier::ObserverBase::attached;
563 virtual void add(const Node& node) {
564 snapshot.addNode(node);
566 virtual void add(const std::vector<Node>& nodes) {
567 for (int i = nodes.size() - 1; i >= 0; ++i) {
568 snapshot.addNode(nodes[i]);
571 virtual void erase(const Node& node) {
572 snapshot.eraseNode(node);
574 virtual void erase(const std::vector<Node>& nodes) {
575 for (int i = 0; i < int(nodes.size()); ++i) {
576 snapshot.eraseNode(nodes[i]);
579 virtual void build() {
581 std::vector<Node> nodes;
582 for (notifier()->first(node); node != INVALID;
583 notifier()->next(node)) {
584 nodes.push_back(node);
586 for (int i = nodes.size() - 1; i >= 0; --i) {
587 snapshot.addNode(nodes[i]);
590 virtual void clear() {
592 for (notifier()->first(node); node != INVALID;
593 notifier()->next(node)) {
594 snapshot.eraseNode(node);
601 class ArcObserverProxy : public ArcNotifier::ObserverBase {
604 ArcObserverProxy(Snapshot& _snapshot)
605 : snapshot(_snapshot) {}
607 using ArcNotifier::ObserverBase::attach;
608 using ArcNotifier::ObserverBase::detach;
609 using ArcNotifier::ObserverBase::attached;
613 virtual void add(const Arc& arc) {
614 snapshot.addArc(arc);
616 virtual void add(const std::vector<Arc>& arcs) {
617 for (int i = arcs.size() - 1; i >= 0; ++i) {
618 snapshot.addArc(arcs[i]);
621 virtual void erase(const Arc& arc) {
622 snapshot.eraseArc(arc);
624 virtual void erase(const std::vector<Arc>& arcs) {
625 for (int i = 0; i < int(arcs.size()); ++i) {
626 snapshot.eraseArc(arcs[i]);
629 virtual void build() {
631 std::vector<Arc> arcs;
632 for (notifier()->first(arc); arc != INVALID;
633 notifier()->next(arc)) {
636 for (int i = arcs.size() - 1; i >= 0; --i) {
637 snapshot.addArc(arcs[i]);
640 virtual void clear() {
642 for (notifier()->first(arc); arc != INVALID;
643 notifier()->next(arc)) {
644 snapshot.eraseArc(arc);
651 ListDigraph *digraph;
653 NodeObserverProxy node_observer_proxy;
654 ArcObserverProxy arc_observer_proxy;
656 std::list<Node> added_nodes;
657 std::list<Arc> added_arcs;
660 void addNode(const Node& node) {
661 added_nodes.push_front(node);
663 void eraseNode(const Node& node) {
664 std::list<Node>::iterator it =
665 std::find(added_nodes.begin(), added_nodes.end(), node);
666 if (it == added_nodes.end()) {
668 arc_observer_proxy.detach();
669 throw NodeNotifier::ImmediateDetach();
671 added_nodes.erase(it);
675 void addArc(const Arc& arc) {
676 added_arcs.push_front(arc);
678 void eraseArc(const Arc& arc) {
679 std::list<Arc>::iterator it =
680 std::find(added_arcs.begin(), added_arcs.end(), arc);
681 if (it == added_arcs.end()) {
683 node_observer_proxy.detach();
684 throw ArcNotifier::ImmediateDetach();
686 added_arcs.erase(it);
690 void attach(ListDigraph &_digraph) {
692 node_observer_proxy.attach(digraph->notifier(Node()));
693 arc_observer_proxy.attach(digraph->notifier(Arc()));
697 node_observer_proxy.detach();
698 arc_observer_proxy.detach();
701 bool attached() const {
702 return node_observer_proxy.attached();
712 /// \brief Default constructor.
714 /// Default constructor.
715 /// To actually make a snapshot you must call save().
717 : digraph(0), node_observer_proxy(*this),
718 arc_observer_proxy(*this) {}
720 /// \brief Constructor that immediately makes a snapshot.
722 /// This constructor immediately makes a snapshot of the digraph.
723 /// \param _digraph The digraph we make a snapshot of.
724 Snapshot(ListDigraph &_digraph)
725 : node_observer_proxy(*this),
726 arc_observer_proxy(*this) {
730 /// \brief Make a snapshot.
732 /// Make a snapshot of the digraph.
734 /// This function can be called more than once. In case of a repeated
735 /// call, the previous snapshot gets lost.
736 /// \param _digraph The digraph we make the snapshot of.
737 void save(ListDigraph &_digraph) {
745 /// \brief Undo the changes until the last snapshot.
747 /// Undo the changes until the last snapshot created by save().
750 for(std::list<Arc>::iterator it = added_arcs.begin();
751 it != added_arcs.end(); ++it) {
754 for(std::list<Node>::iterator it = added_nodes.begin();
755 it != added_nodes.end(); ++it) {
761 /// \brief Gives back true when the snapshot is valid.
763 /// Gives back true when the snapshot is valid.
773 class ListGraphBase {
784 int prev_out, next_out;
787 std::vector<NodeT> nodes;
793 std::vector<ArcT> arcs;
799 typedef ListGraphBase Digraph;
806 friend class ListGraphBase;
810 explicit Node(int pid) { id = pid;}
814 Node (Invalid) { id = -1; }
815 bool operator==(const Node& node) const {return id == node.id;}
816 bool operator!=(const Node& node) const {return id != node.id;}
817 bool operator<(const Node& node) const {return id < node.id;}
821 friend class ListGraphBase;
825 explicit Edge(int pid) { id = pid;}
829 Edge (Invalid) { id = -1; }
830 bool operator==(const Edge& edge) const {return id == edge.id;}
831 bool operator!=(const Edge& edge) const {return id != edge.id;}
832 bool operator<(const Edge& edge) const {return id < edge.id;}
836 friend class ListGraphBase;
840 explicit Arc(int pid) { id = pid;}
843 operator Edge() const {
844 return id != -1 ? edgeFromId(id / 2) : INVALID;
848 Arc (Invalid) { id = -1; }
849 bool operator==(const Arc& arc) const {return id == arc.id;}
850 bool operator!=(const Arc& arc) const {return id != arc.id;}
851 bool operator<(const Arc& arc) const {return id < arc.id;}
857 : nodes(), first_node(-1),
858 first_free_node(-1), arcs(), first_free_arc(-1) {}
861 int maxNodeId() const { return nodes.size()-1; }
862 int maxEdgeId() const { return arcs.size() / 2 - 1; }
863 int maxArcId() const { return arcs.size()-1; }
865 Node source(Arc e) const { return Node(arcs[e.id ^ 1].target); }
866 Node target(Arc e) const { return Node(arcs[e.id].target); }
868 Node u(Edge e) const { return Node(arcs[2 * e.id].target); }
869 Node v(Edge e) const { return Node(arcs[2 * e.id + 1].target); }
871 static bool direction(Arc e) {
872 return (e.id & 1) == 1;
875 static Arc direct(Edge e, bool d) {
876 return Arc(e.id * 2 + (d ? 1 : 0));
879 void first(Node& node) const {
880 node.id = first_node;
883 void next(Node& node) const {
884 node.id = nodes[node.id].next;
887 void first(Arc& e) const {
889 while (n != -1 && nodes[n].first_out == -1) {
892 e.id = (n == -1) ? -1 : nodes[n].first_out;
895 void next(Arc& e) const {
896 if (arcs[e.id].next_out != -1) {
897 e.id = arcs[e.id].next_out;
899 int n = nodes[arcs[e.id ^ 1].target].next;
900 while(n != -1 && nodes[n].first_out == -1) {
903 e.id = (n == -1) ? -1 : nodes[n].first_out;
907 void first(Edge& e) const {
910 e.id = nodes[n].first_out;
911 while ((e.id & 1) != 1) {
912 e.id = arcs[e.id].next_out;
923 void next(Edge& e) const {
924 int n = arcs[e.id * 2].target;
925 e.id = arcs[(e.id * 2) | 1].next_out;
926 while ((e.id & 1) != 1) {
927 e.id = arcs[e.id].next_out;
935 e.id = nodes[n].first_out;
936 while ((e.id & 1) != 1) {
937 e.id = arcs[e.id].next_out;
948 void firstOut(Arc &e, const Node& v) const {
949 e.id = nodes[v.id].first_out;
951 void nextOut(Arc &e) const {
952 e.id = arcs[e.id].next_out;
955 void firstIn(Arc &e, const Node& v) const {
956 e.id = ((nodes[v.id].first_out) ^ 1);
957 if (e.id == -2) e.id = -1;
959 void nextIn(Arc &e) const {
960 e.id = ((arcs[e.id ^ 1].next_out) ^ 1);
961 if (e.id == -2) e.id = -1;
964 void firstInc(Edge &e, bool& d, const Node& v) const {
965 int a = nodes[v.id].first_out;
974 void nextInc(Edge &e, bool& d) const {
975 int a = (arcs[(e.id * 2) | (d ? 1 : 0)].next_out);
985 static int id(Node v) { return v.id; }
986 static int id(Arc e) { return e.id; }
987 static int id(Edge e) { return e.id; }
989 static Node nodeFromId(int id) { return Node(id);}
990 static Arc arcFromId(int id) { return Arc(id);}
991 static Edge edgeFromId(int id) { return Edge(id);}
993 bool valid(Node n) const {
994 return n.id >= 0 && n.id < static_cast<int>(nodes.size()) &&
995 nodes[n.id].prev != -2;
998 bool valid(Arc a) const {
999 return a.id >= 0 && a.id < static_cast<int>(arcs.size()) &&
1000 arcs[a.id].prev_out != -2;
1003 bool valid(Edge e) const {
1004 return e.id >= 0 && 2 * e.id < static_cast<int>(arcs.size()) &&
1005 arcs[2 * e.id].prev_out != -2;
1011 if(first_free_node==-1) {
1013 nodes.push_back(NodeT());
1015 n = first_free_node;
1016 first_free_node = nodes[n].next;
1019 nodes[n].next = first_node;
1020 if (first_node != -1) nodes[first_node].prev = n;
1024 nodes[n].first_out = -1;
1029 Edge addEdge(Node u, Node v) {
1032 if (first_free_arc == -1) {
1034 arcs.push_back(ArcT());
1035 arcs.push_back(ArcT());
1038 first_free_arc = arcs[n].next_out;
1041 arcs[n].target = u.id;
1042 arcs[n | 1].target = v.id;
1044 arcs[n].next_out = nodes[v.id].first_out;
1045 if (nodes[v.id].first_out != -1) {
1046 arcs[nodes[v.id].first_out].prev_out = n;
1048 arcs[n].prev_out = -1;
1049 nodes[v.id].first_out = n;
1051 arcs[n | 1].next_out = nodes[u.id].first_out;
1052 if (nodes[u.id].first_out != -1) {
1053 arcs[nodes[u.id].first_out].prev_out = (n | 1);
1055 arcs[n | 1].prev_out = -1;
1056 nodes[u.id].first_out = (n | 1);
1061 void erase(const Node& node) {
1064 if(nodes[n].next != -1) {
1065 nodes[nodes[n].next].prev = nodes[n].prev;
1068 if(nodes[n].prev != -1) {
1069 nodes[nodes[n].prev].next = nodes[n].next;
1071 first_node = nodes[n].next;
1074 nodes[n].next = first_free_node;
1075 first_free_node = n;
1079 void erase(const Edge& edge) {
1080 int n = edge.id * 2;
1082 if (arcs[n].next_out != -1) {
1083 arcs[arcs[n].next_out].prev_out = arcs[n].prev_out;
1086 if (arcs[n].prev_out != -1) {
1087 arcs[arcs[n].prev_out].next_out = arcs[n].next_out;
1089 nodes[arcs[n | 1].target].first_out = arcs[n].next_out;
1092 if (arcs[n | 1].next_out != -1) {
1093 arcs[arcs[n | 1].next_out].prev_out = arcs[n | 1].prev_out;
1096 if (arcs[n | 1].prev_out != -1) {
1097 arcs[arcs[n | 1].prev_out].next_out = arcs[n | 1].next_out;
1099 nodes[arcs[n].target].first_out = arcs[n | 1].next_out;
1102 arcs[n].next_out = first_free_arc;
1104 arcs[n].prev_out = -2;
1105 arcs[n | 1].prev_out = -2;
1112 first_node = first_free_node = first_free_arc = -1;
1117 void changeV(Edge e, Node n) {
1118 if(arcs[2 * e.id].next_out != -1) {
1119 arcs[arcs[2 * e.id].next_out].prev_out = arcs[2 * e.id].prev_out;
1121 if(arcs[2 * e.id].prev_out != -1) {
1122 arcs[arcs[2 * e.id].prev_out].next_out =
1123 arcs[2 * e.id].next_out;
1125 nodes[arcs[(2 * e.id) | 1].target].first_out =
1126 arcs[2 * e.id].next_out;
1129 if (nodes[n.id].first_out != -1) {
1130 arcs[nodes[n.id].first_out].prev_out = 2 * e.id;
1132 arcs[(2 * e.id) | 1].target = n.id;
1133 arcs[2 * e.id].prev_out = -1;
1134 arcs[2 * e.id].next_out = nodes[n.id].first_out;
1135 nodes[n.id].first_out = 2 * e.id;
1138 void changeU(Edge e, Node n) {
1139 if(arcs[(2 * e.id) | 1].next_out != -1) {
1140 arcs[arcs[(2 * e.id) | 1].next_out].prev_out =
1141 arcs[(2 * e.id) | 1].prev_out;
1143 if(arcs[(2 * e.id) | 1].prev_out != -1) {
1144 arcs[arcs[(2 * e.id) | 1].prev_out].next_out =
1145 arcs[(2 * e.id) | 1].next_out;
1147 nodes[arcs[2 * e.id].target].first_out =
1148 arcs[(2 * e.id) | 1].next_out;
1151 if (nodes[n.id].first_out != -1) {
1152 arcs[nodes[n.id].first_out].prev_out = ((2 * e.id) | 1);
1154 arcs[2 * e.id].target = n.id;
1155 arcs[(2 * e.id) | 1].prev_out = -1;
1156 arcs[(2 * e.id) | 1].next_out = nodes[n.id].first_out;
1157 nodes[n.id].first_out = ((2 * e.id) | 1);
1162 typedef GraphExtender<ListGraphBase> ExtendedListGraphBase;
1165 /// \addtogroup graphs
1168 ///A general undirected graph structure.
1170 ///\ref ListGraph is a simple and fast <em>undirected graph</em>
1171 ///implementation based on static linked lists that are stored in
1172 ///\c std::vector structures.
1174 ///It conforms to the \ref concepts::Graph "Graph concept" and it
1175 ///also provides several useful additional functionalities.
1176 ///Most of the member functions and nested classes are documented
1177 ///only in the concept class.
1179 ///An important extra feature of this graph implementation is that
1180 ///its maps are real \ref concepts::ReferenceMap "reference map"s.
1182 ///\sa concepts::Graph
1184 class ListGraph : public ExtendedListGraphBase {
1186 ///ListGraph is \e not copy constructible. Use copyGraph() instead.
1188 ///ListGraph is \e not copy constructible. Use copyGraph() instead.
1190 ListGraph(const ListGraph &) :ExtendedListGraphBase() {};
1191 ///\brief Assignment of ListGraph to another one is \e not allowed.
1192 ///Use copyGraph() instead.
1194 ///Assignment of ListGraph to another one is \e not allowed.
1195 ///Use copyGraph() instead.
1196 void operator=(const ListGraph &) {}
1204 typedef ExtendedListGraphBase Parent;
1206 typedef Parent::OutArcIt IncEdgeIt;
1208 /// \brief Add a new node to the graph.
1210 /// Add a new node to the graph.
1211 /// \return the new node.
1212 Node addNode() { return Parent::addNode(); }
1214 /// \brief Add a new edge to the graph.
1216 /// Add a new edge to the graph with source node \c s
1217 /// and target node \c t.
1218 /// \return the new edge.
1219 Edge addEdge(const Node& s, const Node& t) {
1220 return Parent::addEdge(s, t);
1223 /// \brief Erase a node from the graph.
1225 /// Erase a node from the graph.
1227 void erase(const Node& n) { Parent::erase(n); }
1229 /// \brief Erase an edge from the graph.
1231 /// Erase an edge from the graph.
1233 void erase(const Edge& e) { Parent::erase(e); }
1234 /// Node validity check
1236 /// This function gives back true if the given node is valid,
1237 /// ie. it is a real node of the graph.
1239 /// \warning A Node pointing to a removed item
1240 /// could become valid again later if new nodes are
1241 /// added to the graph.
1242 bool valid(Node n) const { return Parent::valid(n); }
1243 /// Arc validity check
1245 /// This function gives back true if the given arc is valid,
1246 /// ie. it is a real arc of the graph.
1248 /// \warning An Arc pointing to a removed item
1249 /// could become valid again later if new edges are
1250 /// added to the graph.
1251 bool valid(Arc a) const { return Parent::valid(a); }
1252 /// Edge validity check
1254 /// This function gives back true if the given edge is valid,
1255 /// ie. it is a real arc of the graph.
1257 /// \warning A Edge pointing to a removed item
1258 /// could become valid again later if new edges are
1259 /// added to the graph.
1260 bool valid(Edge e) const { return Parent::valid(e); }
1261 /// \brief Change the end \c u of \c e to \c n
1263 /// This function changes the end \c u of \c e to node \c n.
1265 ///\note The <tt>EdgeIt</tt>s and <tt>ArcIt</tt>s referencing the
1266 ///changed edge are invalidated and if the changed node is the
1267 ///base node of an iterator then this iterator is also
1270 ///\warning This functionality cannot be used together with the
1271 ///Snapshot feature.
1272 void changeU(Edge e, Node n) {
1273 Parent::changeU(e,n);
1275 /// \brief Change the end \c v of \c e to \c n
1277 /// This function changes the end \c v of \c e to \c n.
1279 ///\note The <tt>EdgeIt</tt>s referencing the changed edge remain
1280 ///valid, however <tt>ArcIt</tt>s and if the changed node is the
1281 ///base node of an iterator then this iterator is invalidated.
1283 ///\warning This functionality cannot be used together with the
1284 ///Snapshot feature.
1285 void changeV(Edge e, Node n) {
1286 Parent::changeV(e,n);
1288 /// \brief Contract two nodes.
1290 /// This function contracts two nodes.
1291 /// Node \p b will be removed but instead of deleting
1292 /// its neighboring arcs, they will be joined to \p a.
1293 /// The last parameter \p r controls whether to remove loops. \c true
1294 /// means that loops will be removed.
1296 /// \note The <tt>ArcIt</tt>s referencing a moved arc remain
1299 ///\warning This functionality cannot be used together with the
1300 ///Snapshot feature.
1301 void contract(Node a, Node b, bool r = true) {
1302 for(IncEdgeIt e(*this, b); e!=INVALID;) {
1303 IncEdgeIt f = e; ++f;
1304 if (r && runningNode(e) == a) {
1306 } else if (u(e) == b) {
1317 /// \brief Class to make a snapshot of the graph and restore
1320 /// Class to make a snapshot of the graph and restore it later.
1322 /// The newly added nodes and edges can be removed
1323 /// using the restore() function.
1325 /// \warning Edge and node deletions and other modifications
1326 /// (e.g. changing nodes of edges, contracting nodes) cannot be
1327 /// restored. These events invalidate the snapshot.
1331 typedef Parent::NodeNotifier NodeNotifier;
1333 class NodeObserverProxy : public NodeNotifier::ObserverBase {
1336 NodeObserverProxy(Snapshot& _snapshot)
1337 : snapshot(_snapshot) {}
1339 using NodeNotifier::ObserverBase::attach;
1340 using NodeNotifier::ObserverBase::detach;
1341 using NodeNotifier::ObserverBase::attached;
1345 virtual void add(const Node& node) {
1346 snapshot.addNode(node);
1348 virtual void add(const std::vector<Node>& nodes) {
1349 for (int i = nodes.size() - 1; i >= 0; ++i) {
1350 snapshot.addNode(nodes[i]);
1353 virtual void erase(const Node& node) {
1354 snapshot.eraseNode(node);
1356 virtual void erase(const std::vector<Node>& nodes) {
1357 for (int i = 0; i < int(nodes.size()); ++i) {
1358 snapshot.eraseNode(nodes[i]);
1361 virtual void build() {
1363 std::vector<Node> nodes;
1364 for (notifier()->first(node); node != INVALID;
1365 notifier()->next(node)) {
1366 nodes.push_back(node);
1368 for (int i = nodes.size() - 1; i >= 0; --i) {
1369 snapshot.addNode(nodes[i]);
1372 virtual void clear() {
1374 for (notifier()->first(node); node != INVALID;
1375 notifier()->next(node)) {
1376 snapshot.eraseNode(node);
1383 class EdgeObserverProxy : public EdgeNotifier::ObserverBase {
1386 EdgeObserverProxy(Snapshot& _snapshot)
1387 : snapshot(_snapshot) {}
1389 using EdgeNotifier::ObserverBase::attach;
1390 using EdgeNotifier::ObserverBase::detach;
1391 using EdgeNotifier::ObserverBase::attached;
1395 virtual void add(const Edge& edge) {
1396 snapshot.addEdge(edge);
1398 virtual void add(const std::vector<Edge>& edges) {
1399 for (int i = edges.size() - 1; i >= 0; ++i) {
1400 snapshot.addEdge(edges[i]);
1403 virtual void erase(const Edge& edge) {
1404 snapshot.eraseEdge(edge);
1406 virtual void erase(const std::vector<Edge>& edges) {
1407 for (int i = 0; i < int(edges.size()); ++i) {
1408 snapshot.eraseEdge(edges[i]);
1411 virtual void build() {
1413 std::vector<Edge> edges;
1414 for (notifier()->first(edge); edge != INVALID;
1415 notifier()->next(edge)) {
1416 edges.push_back(edge);
1418 for (int i = edges.size() - 1; i >= 0; --i) {
1419 snapshot.addEdge(edges[i]);
1422 virtual void clear() {
1424 for (notifier()->first(edge); edge != INVALID;
1425 notifier()->next(edge)) {
1426 snapshot.eraseEdge(edge);
1435 NodeObserverProxy node_observer_proxy;
1436 EdgeObserverProxy edge_observer_proxy;
1438 std::list<Node> added_nodes;
1439 std::list<Edge> added_edges;
1442 void addNode(const Node& node) {
1443 added_nodes.push_front(node);
1445 void eraseNode(const Node& node) {
1446 std::list<Node>::iterator it =
1447 std::find(added_nodes.begin(), added_nodes.end(), node);
1448 if (it == added_nodes.end()) {
1450 edge_observer_proxy.detach();
1451 throw NodeNotifier::ImmediateDetach();
1453 added_nodes.erase(it);
1457 void addEdge(const Edge& edge) {
1458 added_edges.push_front(edge);
1460 void eraseEdge(const Edge& edge) {
1461 std::list<Edge>::iterator it =
1462 std::find(added_edges.begin(), added_edges.end(), edge);
1463 if (it == added_edges.end()) {
1465 node_observer_proxy.detach();
1466 throw EdgeNotifier::ImmediateDetach();
1468 added_edges.erase(it);
1472 void attach(ListGraph &_graph) {
1474 node_observer_proxy.attach(graph->notifier(Node()));
1475 edge_observer_proxy.attach(graph->notifier(Edge()));
1479 node_observer_proxy.detach();
1480 edge_observer_proxy.detach();
1483 bool attached() const {
1484 return node_observer_proxy.attached();
1488 added_nodes.clear();
1489 added_edges.clear();
1494 /// \brief Default constructor.
1496 /// Default constructor.
1497 /// To actually make a snapshot you must call save().
1499 : graph(0), node_observer_proxy(*this),
1500 edge_observer_proxy(*this) {}
1502 /// \brief Constructor that immediately makes a snapshot.
1504 /// This constructor immediately makes a snapshot of the graph.
1505 /// \param _graph The graph we make a snapshot of.
1506 Snapshot(ListGraph &_graph)
1507 : node_observer_proxy(*this),
1508 edge_observer_proxy(*this) {
1512 /// \brief Make a snapshot.
1514 /// Make a snapshot of the graph.
1516 /// This function can be called more than once. In case of a repeated
1517 /// call, the previous snapshot gets lost.
1518 /// \param _graph The graph we make the snapshot of.
1519 void save(ListGraph &_graph) {
1527 /// \brief Undo the changes until the last snapshot.
1529 /// Undo the changes until the last snapshot created by save().
1532 for(std::list<Edge>::iterator it = added_edges.begin();
1533 it != added_edges.end(); ++it) {
1536 for(std::list<Node>::iterator it = added_nodes.begin();
1537 it != added_nodes.end(); ++it) {
1543 /// \brief Gives back true when the snapshot is valid.
1545 /// Gives back true when the snapshot is valid.
1546 bool valid() const {