COIN-OR::LEMON - Graph Library

source: lemon-0.x/src/lemon/full_graph.h @ 946:c94ef40a22ce

Last change on this file since 946:c94ef40a22ce was 946:c94ef40a22ce, checked in by Mihaly Barasz, 15 years ago

The graph_factory branch (@ 1321) has been merged to trunk.

File size: 5.7 KB
Line 
1/* -*- C++ -*-
2 * src/lemon/full_graph.h - Part of LEMON, a generic C++ optimization library
3 *
4 * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Combinatorial Optimization Research Group, EGRES).
6 *
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.
10 *
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
13 * purpose.
14 *
15 */
16
17#ifndef LEMON_FULL_GRAPH_H
18#define LEMON_FULL_GRAPH_H
19
20
21#include <lemon/idmappable_graph_extender.h>
22
23#include <lemon/iterable_graph_extender.h>
24
25#include <lemon/alteration_observer_registry.h>
26#include <lemon/default_map.h>
27
28///\ingroup graphs
29///\file
30///\brief FullGraph and SymFullGraph classes.
31
32
33#include <lemon/invalid.h>
34
35namespace lemon {
36
37/// \addtogroup graphs
38/// @{
39
40  ///A full graph class.
41
42  ///This is a simple and fast directed full graph implementation.
43  ///It is completely static, so you can neither add nor delete either
44  ///edges or nodes.
45  ///Thus it conforms to
46  ///the \ref skeleton::StaticGraph "StaticGraph" concept
47  ///\sa skeleton::StaticGraph.
48  ///\todo What about loops?
49  ///\todo Don't we need SymEdgeMap?
50  ///
51  ///\author Alpar Juttner
52  class FullGraphBase {
53    int NodeNum;
54    int EdgeNum;
55  public:
56
57    typedef FullGraphBase Graph;
58
59    class Node;
60    class Edge;
61
62  public:
63
64    FullGraphBase() {}
65
66
67    ///Creates a full graph with \c n nodes.
68    void construct(int n) { NodeNum = n; EdgeNum = n * n; }
69    ///
70    //    FullGraphBase(const FullGraphBase &_g)
71    //      : NodeNum(_g.nodeNum()), EdgeNum(NodeNum*NodeNum) { }
72   
73    ///Number of nodes.
74    int nodeNum() const { return NodeNum; }
75    ///Number of edges.
76    int edgeNum() const { return EdgeNum; }
77
78    /// Maximum node ID.
79   
80    /// Maximum node ID.
81    ///\sa id(Node)
82    int maxNodeId() const { return NodeNum-1; }
83    /// Maximum edge ID.
84   
85    /// Maximum edge ID.
86    ///\sa id(Edge)
87    int maxEdgeId() const { return EdgeNum-1; }
88
89    Node tail(Edge e) const { return e.id % NodeNum; }
90    Node head(Edge e) const { return e.id / NodeNum; }
91
92
93    /// Node ID.
94   
95    /// The ID of a valid Node is a nonnegative integer not greater than
96    /// \ref maxNodeId(). The range of the ID's is not surely continuous
97    /// and the greatest node ID can be actually less then \ref maxNodeId().
98    ///
99    /// The ID of the \ref INVALID node is -1.
100    ///\return The ID of the node \c v.
101
102    static int id(Node v) { return v.id; }
103    /// Edge ID.
104   
105    /// The ID of a valid Edge is a nonnegative integer not greater than
106    /// \ref maxEdgeId(). The range of the ID's is not surely continuous
107    /// and the greatest edge ID can be actually less then \ref maxEdgeId().
108    ///
109    /// The ID of the \ref INVALID edge is -1.
110    ///\return The ID of the edge \c e.
111    static int id(Edge e) { return e.id; }
112
113    /// Finds an edge between two nodes.
114   
115    /// Finds an edge from node \c u to node \c v.
116    ///
117    /// If \c prev is \ref INVALID (this is the default value), then
118    /// It finds the first edge from \c u to \c v. Otherwise it looks for
119    /// the next edge from \c u to \c v after \c prev.
120    /// \return The found edge or INVALID if there is no such an edge.
121    Edge findEdge(Node u,Node v, Edge prev = INVALID)
122    {
123      return prev.id == -1 ? Edge(*this, u.id, v.id) : INVALID;
124    }
125   
126     
127    class Node {
128      friend class FullGraphBase;
129
130    protected:
131      int id;
132      Node(int _id) { id = _id;}
133    public:
134      Node() {}
135      Node (Invalid) { id = -1; }
136      bool operator==(const Node node) const {return id == node.id;}
137      bool operator!=(const Node node) const {return id != node.id;}
138      bool operator<(const Node node) const {return id < node.id;}
139    };
140   
141
142
143    class Edge {
144      friend class FullGraphBase;
145     
146    protected:
147      int id;  // NodeNum * head + tail;
148
149      Edge(int _id) : id(_id) {}
150
151      Edge(const FullGraphBase& _graph, int tail, int head)
152        : id(_graph.NodeNum * head+tail) {}
153    public:
154      Edge() { }
155      Edge (Invalid) { id = -1; }
156      bool operator==(const Edge edge) const {return id == edge.id;}
157      bool operator!=(const Edge edge) const {return id != edge.id;}
158      bool operator<(const Edge edge) const {return id < edge.id;}
159    };
160
161    void first(Node& node) const {
162      node.id = NodeNum-1;
163    }
164
165    static void next(Node& node) {
166      --node.id;
167    }
168
169    void first(Edge& edge) const {
170      edge.id = EdgeNum-1;
171    }
172
173    static void next(Edge& edge) {
174      --edge.id;
175    }
176
177    void firstOut(Edge& edge, const Node& node) const {
178      edge.id = EdgeNum + node.id - NodeNum;
179    }
180
181    void nextOut(Edge& edge) const {
182      edge.id -= NodeNum;
183      if (edge.id < 0) edge.id = -1;
184    }
185
186    void firstIn(Edge& edge, const Node& node) const {
187      edge.id = node.id * NodeNum;
188    }
189   
190    void nextIn(Edge& edge) const {
191      ++edge.id;
192      if (edge.id % NodeNum == 0) edge.id = -1;
193    }
194
195  };
196
197
198  typedef AlterableGraphExtender<FullGraphBase> AlterableFullGraphBase;
199  typedef IterableGraphExtender<AlterableFullGraphBase> IterableFullGraphBase;
200  typedef IdMappableGraphExtender<IterableFullGraphBase> IdMappableFullGraphBase;
201  typedef DefaultMappableGraphExtender<IdMappableFullGraphBase> MappableFullGraphBase;
202
203  class FullGraph : public MappableFullGraphBase {
204  public:
205
206    FullGraph(int n) { construct(n); }
207  };
208
209  template <>
210  int countNodes<FullGraph>(const FullGraph& graph) {
211    return graph.nodeNum();
212  }
213
214  template <>
215  int countEdges<FullGraph>(const FullGraph& graph) {
216    return graph.edgeNum();
217  }
218
219  /// @} 
220
221} //namespace lemon
222
223
224
225
226#endif //LEMON_FULL_GRAPH_H
Note: See TracBrowser for help on using the repository browser.