Improvements in CycleCanceling.
Main changes:
- Use function parameter instead of #define commands to select negative
cycle detection method.
- Change the name of private members to start with "_".
- Change the name of function parameters not to start with "_".
- Remove unnecessary documentation for private members.
- Doc improvements.
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_BITS_BASE_EXTENDER_H
20 #define LEMON_BITS_BASE_EXTENDER_H
22 #include <lemon/bits/invalid.h>
23 #include <lemon/error.h>
25 #include <lemon/bits/map_extender.h>
26 #include <lemon/bits/default_map.h>
28 #include <lemon/concept_check.h>
29 #include <lemon/concepts/maps.h>
33 ///\brief Extenders for the graph types
36 /// \ingroup graphbits
38 /// \brief BaseGraph to BaseUGraph extender
39 template <typename Base>
40 class UndirGraphExtender : public Base {
45 typedef typename Parent::Edge UEdge;
46 typedef typename Parent::Node Node;
48 typedef True UndirectedTag;
50 class Edge : public UEdge {
51 friend class UndirGraphExtender;
56 Edge(const UEdge &ue, bool _forward) :
57 UEdge(ue), forward(_forward) {}
62 /// Invalid edge constructor
63 Edge(Invalid i) : UEdge(i), forward(true) {}
65 bool operator==(const Edge &that) const {
66 return forward==that.forward && UEdge(*this)==UEdge(that);
68 bool operator!=(const Edge &that) const {
69 return forward!=that.forward || UEdge(*this)!=UEdge(that);
71 bool operator<(const Edge &that) const {
72 return forward<that.forward ||
73 (!(that.forward<forward) && UEdge(*this)<UEdge(that));
81 /// Source of the given Edge.
82 Node source(const Edge &e) const {
83 return e.forward ? Parent::source(e) : Parent::target(e);
88 /// Target of the given Edge.
89 Node target(const Edge &e) const {
90 return e.forward ? Parent::target(e) : Parent::source(e);
93 /// \brief Directed edge from an undirected edge.
95 /// Returns a directed edge corresponding to the specified UEdge.
96 /// If the given bool is true the given undirected edge and the
97 /// returned edge have the same source node.
98 static Edge direct(const UEdge &ue, bool d) {
102 /// Returns whether the given directed edge is same orientation as the
103 /// corresponding undirected edge.
105 /// \todo reference to the corresponding point of the undirected graph
106 /// concept. "What does the direction of an undirected edge mean?"
107 static bool direction(const Edge &e) { return e.forward; }
113 void first(Edge &e) const {
118 void next(Edge &e) const {
128 void firstOut(Edge &e, const Node &n) const {
129 Parent::firstIn(e,n);
130 if( UEdge(e) != INVALID ) {
134 Parent::firstOut(e,n);
138 void nextOut(Edge &e) const {
140 Node n = Parent::target(e);
142 if( UEdge(e) == INVALID ) {
143 Parent::firstOut(e, n);
152 void firstIn(Edge &e, const Node &n) const {
153 Parent::firstOut(e,n);
154 if( UEdge(e) != INVALID ) {
158 Parent::firstIn(e,n);
162 void nextIn(Edge &e) const {
164 Node n = Parent::source(e);
166 if( UEdge(e) == INVALID ) {
167 Parent::firstIn(e, n);
176 void firstInc(UEdge &e, bool &d, const Node &n) const {
178 Parent::firstOut(e, n);
179 if (e != INVALID) return;
181 Parent::firstIn(e, n);
184 void nextInc(UEdge &e, bool &d) const {
186 Node s = Parent::source(e);
188 if (e != INVALID) return;
190 Parent::firstIn(e, s);
196 Node nodeFromId(int ix) const {
197 return Parent::nodeFromId(ix);
200 Edge edgeFromId(int ix) const {
201 return direct(Parent::edgeFromId(ix >> 1), bool(ix & 1));
204 UEdge uEdgeFromId(int ix) const {
205 return Parent::edgeFromId(ix);
208 int id(const Node &n) const {
209 return Parent::id(n);
212 int id(const UEdge &e) const {
213 return Parent::id(e);
216 int id(const Edge &e) const {
217 return 2 * Parent::id(e) + int(e.forward);
220 int maxNodeId() const {
221 return Parent::maxNodeId();
224 int maxEdgeId() const {
225 return 2 * Parent::maxEdgeId() + 1;
228 int maxUEdgeId() const {
229 return Parent::maxEdgeId();
233 int edgeNum() const {
234 return 2 * Parent::edgeNum();
237 int uEdgeNum() const {
238 return Parent::edgeNum();
241 Edge findEdge(Node s, Node t, Edge p = INVALID) const {
243 UEdge edge = Parent::findEdge(s, t);
244 if (edge != INVALID) return direct(edge, true);
245 edge = Parent::findEdge(t, s);
246 if (edge != INVALID) return direct(edge, false);
247 } else if (direction(p)) {
248 UEdge edge = Parent::findEdge(s, t, p);
249 if (edge != INVALID) return direct(edge, true);
250 edge = Parent::findEdge(t, s);
251 if (edge != INVALID) return direct(edge, false);
253 UEdge edge = Parent::findEdge(t, s, p);
254 if (edge != INVALID) return direct(edge, false);
259 UEdge findUEdge(Node s, Node t, UEdge p = INVALID) const {
262 UEdge edge = Parent::findEdge(s, t);
263 if (edge != INVALID) return edge;
264 edge = Parent::findEdge(t, s);
265 if (edge != INVALID) return edge;
266 } else if (Parent::s(p) == s) {
267 UEdge edge = Parent::findEdge(s, t, p);
268 if (edge != INVALID) return edge;
269 edge = Parent::findEdge(t, s);
270 if (edge != INVALID) return edge;
272 UEdge edge = Parent::findEdge(t, s, p);
273 if (edge != INVALID) return edge;
276 return Parent::findEdge(s, t, p);
282 template <typename Base>
283 class BidirBpUGraphExtender : public Base {
286 typedef BidirBpUGraphExtender Graph;
288 typedef typename Parent::Node Node;
289 typedef typename Parent::UEdge UEdge;
297 class ANode : public Node {
298 friend class BidirBpUGraphExtender;
301 ANode(const Node& node) : Node(node) {
302 LEMON_ASSERT(Parent::aNode(node) || node == INVALID,
303 typename Parent::NodeSetError());
305 ANode& operator=(const Node& node) {
306 LEMON_ASSERT(Parent::aNode(node) || node == INVALID,
307 typename Parent::NodeSetError());
308 Node::operator=(node);
311 ANode(Invalid) : Node(INVALID) {}
312 ANode& operator=(Invalid) {
313 Node::operator=(INVALID);
318 void first(ANode& node) const {
319 Parent::firstANode(static_cast<Node&>(node));
321 void next(ANode& node) const {
322 Parent::nextANode(static_cast<Node&>(node));
325 int id(const ANode& node) const {
326 return Parent::aNodeId(node);
329 class BNode : public Node {
330 friend class BidirBpUGraphExtender;
333 BNode(const Node& node) : Node(node) {
334 LEMON_ASSERT(Parent::bNode(node) || node == INVALID,
335 typename Parent::NodeSetError());
337 BNode& operator=(const Node& node) {
338 LEMON_ASSERT(Parent::bNode(node) || node == INVALID,
339 typename Parent::NodeSetError());
340 Node::operator=(node);
343 BNode(Invalid) : Node(INVALID) {}
344 BNode& operator=(Invalid) {
345 Node::operator=(INVALID);
350 void first(BNode& node) const {
351 Parent::firstBNode(static_cast<Node&>(node));
353 void next(BNode& node) const {
354 Parent::nextBNode(static_cast<Node&>(node));
357 int id(const BNode& node) const {
358 return Parent::aNodeId(node);
361 Node source(const UEdge& edge) const {
364 Node target(const UEdge& edge) const {
368 void firstInc(UEdge& edge, bool& dir, const Node& node) const {
369 if (Parent::aNode(node)) {
370 Parent::firstFromANode(edge, node);
373 Parent::firstFromBNode(edge, node);
374 dir = static_cast<UEdge&>(edge) == INVALID;
377 void nextInc(UEdge& edge, bool& dir) const {
379 Parent::nextFromANode(edge);
381 Parent::nextFromBNode(edge);
382 if (edge == INVALID) dir = true;
386 class Edge : public UEdge {
387 friend class BidirBpUGraphExtender;
391 Edge(const UEdge& edge, bool _forward)
392 : UEdge(edge), forward(_forward) {}
396 Edge (Invalid) : UEdge(INVALID), forward(true) {}
397 bool operator==(const Edge& i) const {
398 return UEdge::operator==(i) && forward == i.forward;
400 bool operator!=(const Edge& i) const {
401 return UEdge::operator!=(i) || forward != i.forward;
403 bool operator<(const Edge& i) const {
404 return UEdge::operator<(i) ||
405 (!(i.forward<forward) && UEdge(*this)<UEdge(i));
409 void first(Edge& edge) const {
410 Parent::first(static_cast<UEdge&>(edge));
414 void next(Edge& edge) const {
416 Parent::next(static_cast<UEdge&>(edge));
418 edge.forward = !edge.forward;
421 void firstOut(Edge& edge, const Node& node) const {
422 if (Parent::aNode(node)) {
423 Parent::firstFromANode(edge, node);
426 Parent::firstFromBNode(edge, node);
427 edge.forward = static_cast<UEdge&>(edge) == INVALID;
430 void nextOut(Edge& edge) const {
432 Parent::nextFromANode(edge);
434 Parent::nextFromBNode(edge);
435 edge.forward = static_cast<UEdge&>(edge) == INVALID;
439 void firstIn(Edge& edge, const Node& node) const {
440 if (Parent::bNode(node)) {
441 Parent::firstFromBNode(edge, node);
444 Parent::firstFromANode(edge, node);
445 edge.forward = static_cast<UEdge&>(edge) == INVALID;
448 void nextIn(Edge& edge) const {
450 Parent::nextFromBNode(edge);
452 Parent::nextFromANode(edge);
453 edge.forward = static_cast<UEdge&>(edge) == INVALID;
457 Node source(const Edge& edge) const {
458 return edge.forward ? Parent::aNode(edge) : Parent::bNode(edge);
460 Node target(const Edge& edge) const {
461 return edge.forward ? Parent::bNode(edge) : Parent::aNode(edge);
464 int id(const Edge& edge) const {
465 return (Parent::id(static_cast<const UEdge&>(edge)) << 1) +
466 (edge.forward ? 0 : 1);
468 Edge edgeFromId(int ix) const {
469 return Edge(Parent::fromUEdgeId(ix >> 1), (ix & 1) == 0);
471 int maxEdgeId() const {
472 return (Parent::maxUEdgeId() << 1) + 1;
475 bool direction(const Edge& edge) const {
479 Edge direct(const UEdge& edge, bool dir) const {
480 return Edge(edge, dir);
483 int edgeNum() const {
484 return 2 * Parent::uEdgeNum();
487 int uEdgeNum() const {
488 return Parent::uEdgeNum();