2 * src/lemon/full_graph.h - Part of LEMON, a generic C++ optimization library
4 * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Combinatorial Optimization Research Group, EGRES).
7 * Permission to use, modify and distribute this software is granted
8 * provided that this copyright notice appears in all copies. For
9 * precise terms see the accompanying LICENSE file.
11 * This software is provided "AS IS" with no warranty of any kind,
12 * express or implied, and with no claim as to its suitability for any
17 #ifndef LEMON_FULL_GRAPH_H
18 #define LEMON_FULL_GRAPH_H
21 #include <lemon/idmappable_graph_extender.h>
22 #include <lemon/iterable_graph_extender.h>
23 #include <lemon/alteration_observer_registry.h>
24 #include <lemon/default_map.h>
26 #include <lemon/invalid.h>
27 #include <lemon/utility.h>
32 ///\brief FullGraph and SymFullGraph classes.
37 /// \addtogroup graphs
45 typedef FullGraphBase Graph;
55 ///Creates a full graph with \c n nodes.
56 void construct(int n) { NodeNum = n; EdgeNum = n * n; }
58 // FullGraphBase(const FullGraphBase &_g)
59 // : NodeNum(_g.nodeNum()), EdgeNum(NodeNum*NodeNum) { }
61 typedef True NodeNumTag;
62 typedef True EdgeNumTag;
65 int nodeNum() const { return NodeNum; }
67 int edgeNum() const { return EdgeNum; }
73 int maxNodeId() const { return NodeNum-1; }
78 int maxEdgeId() const { return EdgeNum-1; }
80 Node tail(Edge e) const { return e.id % NodeNum; }
81 Node head(Edge e) const { return e.id / NodeNum; }
86 /// The ID of a valid Node is a nonnegative integer not greater than
87 /// \ref maxNodeId(). The range of the ID's is not surely continuous
88 /// and the greatest node ID can be actually less then \ref maxNodeId().
90 /// The ID of the \ref INVALID node is -1.
91 ///\return The ID of the node \c v.
93 static int id(Node v) { return v.id; }
96 /// The ID of a valid Edge is a nonnegative integer not greater than
97 /// \ref maxEdgeId(). The range of the ID's is not surely continuous
98 /// and the greatest edge ID can be actually less then \ref maxEdgeId().
100 /// The ID of the \ref INVALID edge is -1.
101 ///\return The ID of the edge \c e.
102 static int id(Edge e) { return e.id; }
104 /// Finds an edge between two nodes.
106 /// Finds an edge from node \c u to node \c v.
108 /// If \c prev is \ref INVALID (this is the default value), then
109 /// It finds the first edge from \c u to \c v. Otherwise it looks for
110 /// the next edge from \c u to \c v after \c prev.
111 /// \return The found edge or INVALID if there is no such an edge.
112 Edge findEdge(Node u,Node v, Edge prev = INVALID)
114 return prev.id == -1 ? Edge(*this, u.id, v.id) : INVALID;
119 friend class FullGraphBase;
123 Node(int _id) { id = _id;}
126 Node (Invalid) { id = -1; }
127 bool operator==(const Node node) const {return id == node.id;}
128 bool operator!=(const Node node) const {return id != node.id;}
129 bool operator<(const Node node) const {return id < node.id;}
135 friend class FullGraphBase;
138 int id; // NodeNum * head + tail;
140 Edge(int _id) : id(_id) {}
142 Edge(const FullGraphBase& _graph, int tail, int head)
143 : id(_graph.NodeNum * head+tail) {}
146 Edge (Invalid) { id = -1; }
147 bool operator==(const Edge edge) const {return id == edge.id;}
148 bool operator!=(const Edge edge) const {return id != edge.id;}
149 bool operator<(const Edge edge) const {return id < edge.id;}
152 void first(Node& node) const {
156 static void next(Node& node) {
160 void first(Edge& edge) const {
164 static void next(Edge& edge) {
168 void firstOut(Edge& edge, const Node& node) const {
169 edge.id = EdgeNum + node.id - NodeNum;
172 void nextOut(Edge& edge) const {
174 if (edge.id < 0) edge.id = -1;
177 void firstIn(Edge& edge, const Node& node) const {
178 edge.id = node.id * NodeNum;
181 void nextIn(Edge& edge) const {
183 if (edge.id % NodeNum == 0) edge.id = -1;
189 typedef AlterableGraphExtender<FullGraphBase> AlterableFullGraphBase;
190 typedef IterableGraphExtender<AlterableFullGraphBase> IterableFullGraphBase;
191 typedef IdMappableGraphExtender<IterableFullGraphBase> IdMappableFullGraphBase;
192 typedef DefaultMappableGraphExtender<IdMappableFullGraphBase> MappableFullGraphBase;
194 ///A full graph class.
196 ///This is a simple and fast directed full graph implementation.
197 ///It is completely static, so you can neither add nor delete either
199 ///Thus it conforms to
200 ///the \ref concept::StaticGraph "StaticGraph" concept
201 ///\sa concept::StaticGraph.
202 ///\todo What about loops?
203 ///\todo Don't we need SymEdgeMap?
205 ///\author Alpar Juttner
206 class FullGraph : public MappableFullGraphBase {
209 FullGraph(int n) { construct(n); }
217 #endif //LEMON_FULL_GRAPH_H