1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2009
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_FULL_GRAPH_H
20 #define LEMON_FULL_GRAPH_H
22 #include <lemon/core.h>
23 #include <lemon/bits/graph_extender.h>
27 ///\brief FullGraph and FullDigraph classes.
31 class FullDigraphBase {
34 typedef FullDigraphBase Digraph;
46 void construct(int n) { _node_num = n; _arc_num = n * n; }
50 typedef True NodeNumTag;
51 typedef True ArcNumTag;
53 Node operator()(int ix) const { return Node(ix); }
54 static int index(const Node& node) { return node._id; }
56 Arc arc(const Node& s, const Node& t) const {
57 return Arc(s._id * _node_num + t._id);
60 int nodeNum() const { return _node_num; }
61 int arcNum() const { return _arc_num; }
63 int maxNodeId() const { return _node_num - 1; }
64 int maxArcId() const { return _arc_num - 1; }
66 Node source(Arc arc) const { return arc._id / _node_num; }
67 Node target(Arc arc) const { return arc._id % _node_num; }
69 static int id(Node node) { return node._id; }
70 static int id(Arc arc) { return arc._id; }
72 static Node nodeFromId(int id) { return Node(id);}
73 static Arc arcFromId(int id) { return Arc(id);}
75 typedef True FindArcTag;
77 Arc findArc(Node s, Node t, Arc prev = INVALID) const {
78 return prev == INVALID ? arc(s, t) : INVALID;
82 friend class FullDigraphBase;
86 Node(int id) : _id(id) {}
89 Node (Invalid) : _id(-1) {}
90 bool operator==(const Node node) const {return _id == node._id;}
91 bool operator!=(const Node node) const {return _id != node._id;}
92 bool operator<(const Node node) const {return _id < node._id;}
96 friend class FullDigraphBase;
99 int _id; // _node_num * source + target;
101 Arc(int id) : _id(id) {}
105 Arc (Invalid) { _id = -1; }
106 bool operator==(const Arc arc) const {return _id == arc._id;}
107 bool operator!=(const Arc arc) const {return _id != arc._id;}
108 bool operator<(const Arc arc) const {return _id < arc._id;}
111 void first(Node& node) const {
112 node._id = _node_num - 1;
115 static void next(Node& node) {
119 void first(Arc& arc) const {
120 arc._id = _arc_num - 1;
123 static void next(Arc& arc) {
127 void firstOut(Arc& arc, const Node& node) const {
128 arc._id = (node._id + 1) * _node_num - 1;
131 void nextOut(Arc& arc) const {
132 if (arc._id % _node_num == 0) arc._id = 0;
136 void firstIn(Arc& arc, const Node& node) const {
137 arc._id = _arc_num + node._id - _node_num;
140 void nextIn(Arc& arc) const {
141 arc._id -= _node_num;
142 if (arc._id < 0) arc._id = -1;
147 typedef DigraphExtender<FullDigraphBase> ExtendedFullDigraphBase;
151 /// \brief A full digraph class.
153 /// This is a simple and fast directed full graph implementation.
154 /// From each node go arcs to each node (including the source node),
155 /// therefore the number of the arcs in the digraph is the square of
156 /// the node number. This digraph type is completely static, so you
157 /// can neither add nor delete either arcs or nodes, and it needs
158 /// constant space in memory.
160 /// This class fully conforms to the \ref concepts::Digraph
161 /// "Digraph concept".
163 /// The \c FullDigraph and \c FullGraph classes are very similar,
164 /// but there are two differences. While this class conforms only
165 /// to the \ref concepts::Digraph "Digraph" concept, the \c FullGraph
166 /// class conforms to the \ref concepts::Graph "Graph" concept,
167 /// moreover \c FullGraph does not contain a loop arc for each
168 /// node as \c FullDigraph does.
171 class FullDigraph : public ExtendedFullDigraphBase {
172 typedef ExtendedFullDigraphBase Parent;
176 /// \brief Constructor
177 FullDigraph() { construct(0); }
179 /// \brief Constructor
182 /// \param n The number of the nodes.
183 FullDigraph(int n) { construct(n); }
185 /// \brief Resizes the digraph
187 /// Resizes the digraph. The function will fully destroy and
188 /// rebuild the digraph. This cause that the maps of the digraph will
189 /// reallocated automatically and the previous values will be lost.
191 Parent::notifier(Arc()).clear();
192 Parent::notifier(Node()).clear();
194 Parent::notifier(Node()).build();
195 Parent::notifier(Arc()).build();
198 /// \brief Returns the node with the given index.
200 /// Returns the node with the given index. Since it is a static
201 /// digraph its nodes can be indexed with integers from the range
202 /// <tt>[0..nodeNum()-1]</tt>.
204 Node operator()(int ix) const { return Parent::operator()(ix); }
206 /// \brief Returns the index of the given node.
208 /// Returns the index of the given node. Since it is a static
209 /// digraph its nodes can be indexed with integers from the range
210 /// <tt>[0..nodeNum()-1]</tt>.
212 static int index(const Node& node) { return Parent::index(node); }
214 /// \brief Returns the arc connecting the given nodes.
216 /// Returns the arc connecting the given nodes.
217 Arc arc(const Node& u, const Node& v) const {
218 return Parent::arc(u, v);
221 /// \brief Number of nodes.
222 int nodeNum() const { return Parent::nodeNum(); }
223 /// \brief Number of arcs.
224 int arcNum() const { return Parent::arcNum(); }
228 class FullGraphBase {
231 typedef FullGraphBase Graph;
244 void construct(int n) { _node_num = n; _edge_num = n * (n - 1) / 2; }
246 int _uid(int e) const {
247 int u = e / _node_num;
248 int v = e % _node_num;
249 return u < v ? u : _node_num - 2 - u;
252 int _vid(int e) const {
253 int u = e / _node_num;
254 int v = e % _node_num;
255 return u < v ? v : _node_num - 1 - v;
258 void _uvid(int e, int& u, int& v) const {
262 u = _node_num - 2 - u;
263 v = _node_num - 1 - v;
267 void _stid(int a, int& s, int& t) const {
275 int _eid(int u, int v) const {
276 if (u < (_node_num - 1) / 2) {
277 return u * _node_num + v;
279 return (_node_num - 1 - u) * _node_num - v - 1;
285 Node operator()(int ix) const { return Node(ix); }
286 static int index(const Node& node) { return node._id; }
288 Edge edge(const Node& u, const Node& v) const {
290 return Edge(_eid(u._id, v._id));
291 } else if (u._id != v._id) {
292 return Edge(_eid(v._id, u._id));
298 Arc arc(const Node& s, const Node& t) const {
300 return Arc((_eid(s._id, t._id) << 1) | 1);
301 } else if (s._id != t._id) {
302 return Arc(_eid(t._id, s._id) << 1);
308 typedef True NodeNumTag;
309 typedef True ArcNumTag;
310 typedef True EdgeNumTag;
312 int nodeNum() const { return _node_num; }
313 int arcNum() const { return 2 * _edge_num; }
314 int edgeNum() const { return _edge_num; }
316 static int id(Node node) { return node._id; }
317 static int id(Arc arc) { return arc._id; }
318 static int id(Edge edge) { return edge._id; }
320 int maxNodeId() const { return _node_num-1; }
321 int maxArcId() const { return 2 * _edge_num-1; }
322 int maxEdgeId() const { return _edge_num-1; }
324 static Node nodeFromId(int id) { return Node(id);}
325 static Arc arcFromId(int id) { return Arc(id);}
326 static Edge edgeFromId(int id) { return Edge(id);}
328 Node u(Edge edge) const {
329 return Node(_uid(edge._id));
332 Node v(Edge edge) const {
333 return Node(_vid(edge._id));
336 Node source(Arc arc) const {
337 return Node((arc._id & 1) == 1 ?
338 _uid(arc._id >> 1) : _vid(arc._id >> 1));
341 Node target(Arc arc) const {
342 return Node((arc._id & 1) == 1 ?
343 _vid(arc._id >> 1) : _uid(arc._id >> 1));
346 typedef True FindEdgeTag;
347 typedef True FindArcTag;
349 Edge findEdge(Node u, Node v, Edge prev = INVALID) const {
350 return prev != INVALID ? INVALID : edge(u, v);
353 Arc findArc(Node s, Node t, Arc prev = INVALID) const {
354 return prev != INVALID ? INVALID : arc(s, t);
358 friend class FullGraphBase;
362 Node(int id) : _id(id) {}
365 Node (Invalid) { _id = -1; }
366 bool operator==(const Node node) const {return _id == node._id;}
367 bool operator!=(const Node node) const {return _id != node._id;}
368 bool operator<(const Node node) const {return _id < node._id;}
372 friend class FullGraphBase;
378 Edge(int id) : _id(id) {}
382 Edge (Invalid) { _id = -1; }
384 bool operator==(const Edge edge) const {return _id == edge._id;}
385 bool operator!=(const Edge edge) const {return _id != edge._id;}
386 bool operator<(const Edge edge) const {return _id < edge._id;}
390 friend class FullGraphBase;
395 Arc(int id) : _id(id) {}
399 Arc (Invalid) { _id = -1; }
401 operator Edge() const { return Edge(_id != -1 ? (_id >> 1) : -1); }
403 bool operator==(const Arc arc) const {return _id == arc._id;}
404 bool operator!=(const Arc arc) const {return _id != arc._id;}
405 bool operator<(const Arc arc) const {return _id < arc._id;}
408 static bool direction(Arc arc) {
409 return (arc._id & 1) == 1;
412 static Arc direct(Edge edge, bool dir) {
413 return Arc((edge._id << 1) | (dir ? 1 : 0));
416 void first(Node& node) const {
417 node._id = _node_num - 1;
420 static void next(Node& node) {
424 void first(Arc& arc) const {
425 arc._id = (_edge_num << 1) - 1;
428 static void next(Arc& arc) {
432 void first(Edge& edge) const {
433 edge._id = _edge_num - 1;
436 static void next(Edge& edge) {
440 void firstOut(Arc& arc, const Node& node) const {
441 int s = node._id, t = _node_num - 1;
443 arc._id = (_eid(s, t) << 1) | 1;
446 arc._id = (t != -1 ? (_eid(t, s) << 1) : -1);
450 void nextOut(Arc& arc) const {
452 _stid(arc._id, s, t);
455 arc._id = (_eid(s, t) << 1) | 1;
458 arc._id = (t != -1 ? (_eid(t, s) << 1) : -1);
462 void firstIn(Arc& arc, const Node& node) const {
463 int s = _node_num - 1, t = node._id;
465 arc._id = (_eid(t, s) << 1);
468 arc._id = (s != -1 ? (_eid(s, t) << 1) | 1 : -1);
472 void nextIn(Arc& arc) const {
474 _stid(arc._id, s, t);
477 arc._id = (_eid(t, s) << 1);
480 arc._id = (s != -1 ? (_eid(s, t) << 1) | 1 : -1);
484 void firstInc(Edge& edge, bool& dir, const Node& node) const {
485 int u = node._id, v = _node_num - 1;
487 edge._id = _eid(u, v);
491 edge._id = (v != -1 ? _eid(v, u) : -1);
496 void nextInc(Edge& edge, bool& dir) const {
499 _uvid(edge._id, u, v);
502 edge._id = _eid(u, v);
505 edge._id = (v != -1 ? _eid(v, u) : -1);
509 _uvid(edge._id, v, u);
511 edge._id = (v != -1 ? _eid(v, u) : -1);
517 typedef GraphExtender<FullGraphBase> ExtendedFullGraphBase;
521 /// \brief An undirected full graph class.
523 /// This is a simple and fast undirected full graph
524 /// implementation. From each node go edge to each other node,
525 /// therefore the number of edges in the graph is \f$n(n-1)/2\f$.
526 /// This graph type is completely static, so you can neither
527 /// add nor delete either edges or nodes, and it needs constant
530 /// This class fully conforms to the \ref concepts::Graph "Graph concept".
532 /// The \c FullGraph and \c FullDigraph classes are very similar,
533 /// but there are two differences. While the \c FullDigraph class
534 /// conforms only to the \ref concepts::Digraph "Digraph" concept,
535 /// this class conforms to the \ref concepts::Graph "Graph" concept,
536 /// moreover \c FullGraph does not contain a loop arc for each
537 /// node as \c FullDigraph does.
540 class FullGraph : public ExtendedFullGraphBase {
541 typedef ExtendedFullGraphBase Parent;
545 /// \brief Constructor
546 FullGraph() { construct(0); }
548 /// \brief Constructor
551 /// \param n The number of the nodes.
552 FullGraph(int n) { construct(n); }
554 /// \brief Resizes the graph
556 /// Resizes the graph. The function will fully destroy and
557 /// rebuild the graph. This cause that the maps of the graph will
558 /// reallocated automatically and the previous values will be lost.
560 Parent::notifier(Arc()).clear();
561 Parent::notifier(Edge()).clear();
562 Parent::notifier(Node()).clear();
564 Parent::notifier(Node()).build();
565 Parent::notifier(Edge()).build();
566 Parent::notifier(Arc()).build();
569 /// \brief Returns the node with the given index.
571 /// Returns the node with the given index. Since it is a static
572 /// graph its nodes can be indexed with integers from the range
573 /// <tt>[0..nodeNum()-1]</tt>.
575 Node operator()(int ix) const { return Parent::operator()(ix); }
577 /// \brief Returns the index of the given node.
579 /// Returns the index of the given node. Since it is a static
580 /// graph its nodes can be indexed with integers from the range
581 /// <tt>[0..nodeNum()-1]</tt>.
583 static int index(const Node& node) { return Parent::index(node); }
585 /// \brief Returns the arc connecting the given nodes.
587 /// Returns the arc connecting the given nodes.
588 Arc arc(const Node& s, const Node& t) const {
589 return Parent::arc(s, t);
592 /// \brief Returns the edge connects the given nodes.
594 /// Returns the edge connects the given nodes.
595 Edge edge(const Node& u, const Node& v) const {
596 return Parent::edge(u, v);
599 /// \brief Number of nodes.
600 int nodeNum() const { return Parent::nodeNum(); }
601 /// \brief Number of arcs.
602 int arcNum() const { return Parent::arcNum(); }
603 /// \brief Number of edges.
604 int edgeNum() const { return Parent::edgeNum(); }
612 #endif //LEMON_FULL_GRAPH_H