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/iterable_graph_extender.h>
22 #include <lemon/alteration_observer_registry.h>
23 #include <lemon/default_map.h>
25 #include <lemon/invalid.h>
26 #include <lemon/utility.h>
31 ///\brief FullGraph and SymFullGraph classes.
36 /// \addtogroup graphs
44 typedef FullGraphBase Graph;
54 ///Creates a full graph with \c n nodes.
55 void construct(int n) { NodeNum = n; EdgeNum = n * n; }
57 // FullGraphBase(const FullGraphBase &_g)
58 // : NodeNum(_g.nodeNum()), EdgeNum(NodeNum*NodeNum) { }
60 typedef True NodeNumTag;
61 typedef True EdgeNumTag;
64 int nodeNum() const { return NodeNum; }
66 int edgeNum() const { return EdgeNum; }
72 int maxId(Node = INVALID) const { return NodeNum-1; }
77 int maxId(Edge = INVALID) const { return EdgeNum-1; }
79 Node tail(Edge e) const { return e.id % NodeNum; }
80 Node head(Edge e) const { return e.id / NodeNum; }
85 /// The ID of a valid Node is a nonnegative integer not greater than
86 /// \ref maxNodeId(). The range of the ID's is not surely continuous
87 /// and the greatest node ID can be actually less then \ref maxNodeId().
89 /// The ID of the \ref INVALID node is -1.
90 ///\return The ID of the node \c v.
92 static int id(Node v) { return v.id; }
95 /// The ID of a valid Edge is a nonnegative integer not greater than
96 /// \ref maxEdgeId(). The range of the ID's is not surely continuous
97 /// and the greatest edge ID can be actually less then \ref maxEdgeId().
99 /// The ID of the \ref INVALID edge is -1.
100 ///\return The ID of the edge \c e.
101 static int id(Edge e) { return e.id; }
103 /// Finds an edge between two nodes.
105 /// Finds an edge from node \c u to node \c v.
107 /// If \c prev is \ref INVALID (this is the default value), then
108 /// It finds the first edge from \c u to \c v. Otherwise it looks for
109 /// the next edge from \c u to \c v after \c prev.
110 /// \return The found edge or INVALID if there is no such an edge.
111 Edge findEdge(Node u,Node v, Edge prev = INVALID)
113 return prev.id == -1 ? Edge(*this, u.id, v.id) : INVALID;
118 friend class FullGraphBase;
122 Node(int _id) { id = _id;}
125 Node (Invalid) { id = -1; }
126 bool operator==(const Node node) const {return id == node.id;}
127 bool operator!=(const Node node) const {return id != node.id;}
128 bool operator<(const Node node) const {return id < node.id;}
134 friend class FullGraphBase;
137 int id; // NodeNum * head + tail;
139 Edge(int _id) : id(_id) {}
141 Edge(const FullGraphBase& _graph, int tail, int head)
142 : id(_graph.NodeNum * head+tail) {}
145 Edge (Invalid) { id = -1; }
146 bool operator==(const Edge edge) const {return id == edge.id;}
147 bool operator!=(const Edge edge) const {return id != edge.id;}
148 bool operator<(const Edge edge) const {return id < edge.id;}
151 void first(Node& node) const {
155 static void next(Node& node) {
159 void first(Edge& edge) const {
163 static void next(Edge& edge) {
167 void firstOut(Edge& edge, const Node& node) const {
168 edge.id = EdgeNum + node.id - NodeNum;
171 void nextOut(Edge& edge) const {
173 if (edge.id < 0) edge.id = -1;
176 void firstIn(Edge& edge, const Node& node) const {
177 edge.id = node.id * NodeNum;
180 void nextIn(Edge& edge) const {
182 if (edge.id % NodeNum == 0) edge.id = -1;
188 typedef AlterableGraphExtender<FullGraphBase> AlterableFullGraphBase;
189 typedef IterableGraphExtender<AlterableFullGraphBase> IterableFullGraphBase;
190 typedef DefaultMappableGraphExtender<IterableFullGraphBase> MappableFullGraphBase;
192 ///A full graph class.
194 ///This is a simple and fast directed full graph implementation.
195 ///It is completely static, so you can neither add nor delete either
197 ///Thus it conforms to
198 ///the \ref concept::StaticGraph "StaticGraph" concept
199 ///\sa concept::StaticGraph.
200 ///\todo What about loops?
201 ///\todo Don't we need SymEdgeMap?
203 ///\author Alpar Juttner
204 class FullGraph : public MappableFullGraphBase {
207 FullGraph(int n) { construct(n); }
215 #endif //LEMON_FULL_GRAPH_H