COIN-OR::LEMON - Graph Library

source: lemon-0.x/lemon/full_graph.h @ 1702:44d495c659b5

Last change on this file since 1702:44d495c659b5 was 1692:a34203867181, checked in by Balazs Dezso, 14 years ago

Correcting the names in the \files documentation.

File size: 11.0 KB
Line 
1/* -*- C++ -*-
2 * lemon/full_graph.h - Part of LEMON, a generic C++ optimization library
3 *
4 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Research Group on Combinatorial Optimization, 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#include <cmath>
21
22
23#include <lemon/bits/iterable_graph_extender.h>
24#include <lemon/bits/alteration_notifier.h>
25#include <lemon/bits/default_map.h>
26
27#include <lemon/bits/undir_graph_extender.h>
28
29#include <lemon/invalid.h>
30#include <lemon/utility.h>
31
32
33///\ingroup graphs
34///\file
35///\brief FullGraph and UndirFullGraph classes.
36
37
38namespace lemon {
39
40  class FullGraphBase {
41    int _nodeNum;
42    int _edgeNum;
43  public:
44
45    typedef FullGraphBase Graph;
46
47    class Node;
48    class Edge;
49
50  public:
51
52    FullGraphBase() {}
53
54
55    ///Creates a full graph with \c n nodes.
56    void construct(int n) { _nodeNum = n; _edgeNum = n * n; }
57    ///
58    //    FullGraphBase(const FullGraphBase &_g)
59    //      : _nodeNum(_g.nodeNum()), _edgeNum(_nodeNum*_nodeNum) { }
60   
61    typedef True NodeNumTag;
62    typedef True EdgeNumTag;
63
64    ///Number of nodes.
65    int nodeNum() const { return _nodeNum; }
66    ///Number of edges.
67    int edgeNum() const { return _edgeNum; }
68
69    /// Maximum node ID.
70   
71    /// Maximum node ID.
72    ///\sa id(Node)
73    int maxId(Node = INVALID) const { return _nodeNum-1; }
74    /// Maximum edge ID.
75   
76    /// Maximum edge ID.
77    ///\sa id(Edge)
78    int maxId(Edge = INVALID) const { return _edgeNum-1; }
79
80    Node source(Edge e) const { return e.id % _nodeNum; }
81    Node target(Edge e) const { return e.id / _nodeNum; }
82
83
84    /// Node ID.
85   
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().
89    ///
90    /// The ID of the \ref INVALID node is -1.
91    ///\return The ID of the node \c v.
92
93    static int id(Node v) { return v.id; }
94    /// Edge ID.
95   
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().
99    ///
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; }
103
104    static Node fromId(int id, Node) { return Node(id);}
105   
106    static Edge fromId(int id, Edge) { return Edge(id);}
107
108    typedef True FindEdgeTag;
109
110    /// Finds an edge between two nodes.
111   
112    /// Finds an edge from node \c u to node \c v.
113    ///
114    /// If \c prev is \ref INVALID (this is the default value), then
115    /// It finds the first edge from \c u to \c v. Otherwise it looks for
116    /// the next edge from \c u to \c v after \c prev.
117    /// \return The found edge or INVALID if there is no such an edge.
118    Edge findEdge(Node u,Node v, Edge prev = INVALID) const {
119      return prev.id == -1 ? Edge(*this, u.id, v.id) : INVALID;
120    }
121   
122     
123    class Node {
124      friend class FullGraphBase;
125
126    protected:
127      int id;
128      Node(int _id) : id(_id) {}
129    public:
130      Node() {}
131      Node (Invalid) : id(-1) {}
132      bool operator==(const Node node) const {return id == node.id;}
133      bool operator!=(const Node node) const {return id != node.id;}
134      bool operator<(const Node node) const {return id < node.id;}
135    };
136   
137
138
139    class Edge {
140      friend class FullGraphBase;
141     
142    protected:
143      int id;  // _nodeNum * target + source;
144
145      Edge(int _id) : id(_id) {}
146
147      Edge(const FullGraphBase& _graph, int source, int target)
148        : id(_graph._nodeNum * target+source) {}
149    public:
150      Edge() { }
151      Edge (Invalid) { id = -1; }
152      bool operator==(const Edge edge) const {return id == edge.id;}
153      bool operator!=(const Edge edge) const {return id != edge.id;}
154      bool operator<(const Edge edge) const {return id < edge.id;}
155    };
156
157    void first(Node& node) const {
158      node.id = _nodeNum-1;
159    }
160
161    static void next(Node& node) {
162      --node.id;
163    }
164
165    void first(Edge& edge) const {
166      edge.id = _edgeNum-1;
167    }
168
169    static void next(Edge& edge) {
170      --edge.id;
171    }
172
173    void firstOut(Edge& edge, const Node& node) const {
174      edge.id = _edgeNum + node.id - _nodeNum;
175    }
176
177    void nextOut(Edge& edge) const {
178      edge.id -= _nodeNum;
179      if (edge.id < 0) edge.id = -1;
180    }
181
182    void firstIn(Edge& edge, const Node& node) const {
183      edge.id = node.id * _nodeNum;
184    }
185   
186    void nextIn(Edge& edge) const {
187      ++edge.id;
188      if (edge.id % _nodeNum == 0) edge.id = -1;
189    }
190
191  };
192
193
194  typedef AlterableGraphExtender<FullGraphBase>
195  AlterableFullGraphBase;
196  typedef IterableGraphExtender<AlterableFullGraphBase>
197  IterableFullGraphBase;
198  typedef MappableGraphExtender<
199    IterableGraphExtender<
200    AlterableGraphExtender<FullGraphBase> > > ExtendedFullGraphBase;
201
202  /// \ingroup graphs
203  ///
204  /// \brief A full graph class.
205  ///
206  /// This is a simple and fast directed full graph implementation.
207  /// It is completely static, so you can neither add nor delete either
208  /// edges or nodes.
209  /// Thus it conforms to
210  /// the \ref concept::StaticGraph "StaticGraph" concept
211  /// \sa concept::StaticGraph.
212  ///
213  /// \author Alpar Juttner
214  class FullGraph : public ExtendedFullGraphBase {
215  public:
216
217    FullGraph(int n) { construct(n); }
218  };
219
220  ///@}
221
222  class UndirFullGraphBase {
223    int _nodeNum;
224    int _edgeNum;
225  public:
226
227    typedef UndirFullGraphBase Graph;
228
229    class Node;
230    class Edge;
231
232  public:
233
234    UndirFullGraphBase() {}
235
236
237    ///Creates a full graph with \c n nodes.
238    void construct(int n) { _nodeNum = n; _edgeNum = n * (n - 1) / 2; }
239    ///
240    //    FullGraphBase(const FullGraphBase &_g)
241    //      : _nodeNum(_g.nodeNum()), _edgeNum(_nodeNum*_nodeNum) { }
242   
243    typedef True NodeNumTag;
244    typedef True EdgeNumTag;
245
246    ///Number of nodes.
247    int nodeNum() const { return _nodeNum; }
248    ///Number of edges.
249    int edgeNum() const { return _edgeNum; }
250
251    /// Maximum node ID.
252   
253    /// Maximum node ID.
254    ///\sa id(Node)
255    int maxId(Node = INVALID) const { return _nodeNum-1; }
256    /// Maximum edge ID.
257   
258    /// Maximum edge ID.
259    ///\sa id(Edge)
260    int maxId(Edge = INVALID) const { return _edgeNum-1; }
261
262    Node source(Edge e) const {
263      /// \todo we may do it faster
264      return Node(((int)sqrt((double)(1 + 8 * e.id)) + 1) / 2);
265    }
266
267    Node target(Edge e) const {
268      int source = ((int)sqrt((double)(1 + 8 * e.id)) + 1) / 2;;
269      return Node(e.id - (source) * (source - 1) / 2);
270    }
271
272
273    /// Node ID.
274   
275    /// The ID of a valid Node is a nonnegative integer not greater than
276    /// \ref maxNodeId(). The range of the ID's is not surely continuous
277    /// and the greatest node ID can be actually less then \ref maxNodeId().
278    ///
279    /// The ID of the \ref INVALID node is -1.
280    ///\return The ID of the node \c v.
281
282    static int id(Node v) { return v.id; }
283    /// Edge ID.
284   
285    /// The ID of a valid Edge is a nonnegative integer not greater than
286    /// \ref maxEdgeId(). The range of the ID's is not surely continuous
287    /// and the greatest edge ID can be actually less then \ref maxEdgeId().
288    ///
289    /// The ID of the \ref INVALID edge is -1.
290    ///\return The ID of the edge \c e.
291    static int id(Edge e) { return e.id; }
292
293    /// Finds an edge between two nodes.
294   
295    /// Finds an edge from node \c u to node \c v.
296    ///
297    /// If \c prev is \ref INVALID (this is the default value), then
298    /// It finds the first edge from \c u to \c v. Otherwise it looks for
299    /// the next edge from \c u to \c v after \c prev.
300    /// \return The found edge or INVALID if there is no such an edge.
301    Edge findEdge(Node u,Node v, Edge prev = INVALID)
302    {
303      return prev.id == -1 ? Edge(*this, u.id, v.id) : INVALID;
304    }
305   
306     
307    class Node {
308      friend class UndirFullGraphBase;
309
310    protected:
311      int id;
312      Node(int _id) { id = _id;}
313    public:
314      Node() {}
315      Node (Invalid) { id = -1; }
316      bool operator==(const Node node) const {return id == node.id;}
317      bool operator!=(const Node node) const {return id != node.id;}
318      bool operator<(const Node node) const {return id < node.id;}
319    };
320   
321
322
323    class Edge {
324      friend class UndirFullGraphBase;
325     
326    protected:
327      int id;  // _nodeNum * target + source;
328
329      Edge(int _id) : id(_id) {}
330
331      Edge(const UndirFullGraphBase& _graph, int source, int target)
332        : id(_graph._nodeNum * target+source) {}
333    public:
334      Edge() { }
335      Edge (Invalid) { id = -1; }
336      bool operator==(const Edge edge) const {return id == edge.id;}
337      bool operator!=(const Edge edge) const {return id != edge.id;}
338      bool operator<(const Edge edge) const {return id < edge.id;}
339    };
340
341    void first(Node& node) const {
342      node.id = _nodeNum-1;
343    }
344
345    static void next(Node& node) {
346      --node.id;
347    }
348
349    void first(Edge& edge) const {
350      edge.id = _edgeNum-1;
351    }
352
353    static void next(Edge& edge) {
354      --edge.id;
355    }
356
357    void firstOut(Edge& edge, const Node& node) const {     
358      edge.id = node.id != 0 ? node.id * (node.id - 1) / 2 : -1;
359    }
360
361    /// \todo with specialized iterators we can make faster iterating
362    void nextOut(Edge& e) const {
363      int source = ((int)sqrt((double)(1 + 8 * e.id)) + 1) / 2;;
364      int target = e.id - (source) * (source - 1) / 2;
365      ++target;
366      e.id = target < source ? source * (source - 1) / 2 + target : -1;
367    }
368
369    void firstIn(Edge& edge, const Node& node) const {
370      edge.id = node.id * (node.id + 1) / 2 - 1;
371    }
372   
373    void nextIn(Edge& e) const {
374      int source = ((int)sqrt((double)(1 + 8 * e.id)) + 1) / 2;;
375      int target = e.id - (source) * (source - 1) / 2; ++target;
376      ++source;
377      e.id = source < _nodeNum ? source * (source - 1) / 2 + target : -1;
378    }
379
380  };
381
382  typedef MappableUndirGraphExtender<
383    IterableUndirGraphExtender<
384    AlterableUndirGraphExtender<
385    UndirGraphExtender<UndirFullGraphBase> > > > ExtendedUndirFullGraphBase;
386
387  /// \ingroup graphs
388  ///
389  /// \brief An undirected full graph class.
390  ///
391  /// This is a simple and fast directed full graph implementation.
392  /// It is completely static, so you can neither add nor delete either
393  /// edges or nodes.
394  ///
395  /// The main difference beetween the \e FullGraph and \e UndirFullGraph class
396  /// is that this class conforms to the undirected graph concept and
397  /// it does not contain the hook edges.
398  ///
399  /// \sa FullGraph
400  ///
401  /// \author Balazs Dezso
402  class UndirFullGraph : public ExtendedUndirFullGraphBase {
403  public:
404    UndirFullGraph(int n) { construct(n); }
405  };
406
407} //namespace lemon
408
409
410#endif //LEMON_FULL_GRAPH_H
Note: See TracBrowser for help on using the repository browser.