[906] | 1 | /* -*- C++ -*- |
---|
[921] | 2 | * src/lemon/smart_graph.h - Part of LEMON, a generic C++ optimization library |
---|
[906] | 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 | */ |
---|
[105] | 16 | |
---|
[921] | 17 | #ifndef LEMON_SMART_GRAPH_H |
---|
| 18 | #define LEMON_SMART_GRAPH_H |
---|
[104] | 19 | |
---|
[491] | 20 | ///\ingroup graphs |
---|
[242] | 21 | ///\file |
---|
| 22 | ///\brief SmartGraph and SymSmartGraph classes. |
---|
| 23 | |
---|
[104] | 24 | #include <vector> |
---|
| 25 | |
---|
[921] | 26 | #include <lemon/invalid.h> |
---|
[157] | 27 | |
---|
[946] | 28 | #include <lemon/clearable_graph_extender.h> |
---|
| 29 | #include <lemon/extendable_graph_extender.h> |
---|
| 30 | #include <lemon/iterable_graph_extender.h> |
---|
| 31 | #include <lemon/alteration_observer_registry.h> |
---|
| 32 | #include <lemon/default_map.h> |
---|
| 33 | |
---|
[977] | 34 | #include <lemon/utility.h> |
---|
[782] | 35 | |
---|
[921] | 36 | namespace lemon { |
---|
[104] | 37 | |
---|
[946] | 38 | /// \addtogroup graphs |
---|
| 39 | /// @{ |
---|
[185] | 40 | |
---|
[973] | 41 | class SmartGraph; |
---|
[969] | 42 | ///Base of SmartGraph |
---|
| 43 | |
---|
| 44 | ///Base of SmartGraph |
---|
| 45 | /// |
---|
[946] | 46 | class SmartGraphBase { |
---|
[104] | 47 | |
---|
[973] | 48 | friend class SmatGraph; |
---|
| 49 | |
---|
| 50 | protected: |
---|
[104] | 51 | struct NodeT |
---|
| 52 | { |
---|
| 53 | int first_in,first_out; |
---|
[157] | 54 | NodeT() : first_in(-1), first_out(-1) {} |
---|
[104] | 55 | }; |
---|
| 56 | struct EdgeT |
---|
| 57 | { |
---|
[986] | 58 | int target, source, next_in, next_out; |
---|
[104] | 59 | //FIXME: is this necessary? |
---|
[157] | 60 | EdgeT() : next_in(-1), next_out(-1) {} |
---|
[104] | 61 | }; |
---|
| 62 | |
---|
| 63 | std::vector<NodeT> nodes; |
---|
[129] | 64 | |
---|
[104] | 65 | std::vector<EdgeT> edges; |
---|
| 66 | |
---|
[185] | 67 | |
---|
[104] | 68 | public: |
---|
[782] | 69 | |
---|
[946] | 70 | typedef SmartGraphBase Graph; |
---|
[104] | 71 | |
---|
[164] | 72 | class Node; |
---|
| 73 | class Edge; |
---|
[108] | 74 | |
---|
[104] | 75 | |
---|
| 76 | public: |
---|
| 77 | |
---|
[946] | 78 | SmartGraphBase() : nodes(), edges() { } |
---|
| 79 | SmartGraphBase(const SmartGraphBase &_g) : nodes(_g.nodes), edges(_g.edges) { } |
---|
[104] | 80 | |
---|
[977] | 81 | typedef True NodeNumTag; |
---|
| 82 | typedef True EdgeNumTag; |
---|
| 83 | |
---|
[813] | 84 | ///Number of nodes. |
---|
| 85 | int nodeNum() const { return nodes.size(); } |
---|
| 86 | ///Number of edges. |
---|
| 87 | int edgeNum() const { return edges.size(); } |
---|
[104] | 88 | |
---|
[813] | 89 | /// Maximum node ID. |
---|
| 90 | |
---|
| 91 | /// Maximum node ID. |
---|
| 92 | ///\sa id(Node) |
---|
[980] | 93 | int maxId(Node = INVALID) const { return nodes.size()-1; } |
---|
[813] | 94 | /// Maximum edge ID. |
---|
| 95 | |
---|
| 96 | /// Maximum edge ID. |
---|
| 97 | ///\sa id(Edge) |
---|
[980] | 98 | int maxId(Edge = INVALID) const { return edges.size()-1; } |
---|
[108] | 99 | |
---|
[986] | 100 | Node source(Edge e) const { return edges[e.n].source; } |
---|
| 101 | Node target(Edge e) const { return edges[e.n].target; } |
---|
[104] | 102 | |
---|
[813] | 103 | /// Node ID. |
---|
| 104 | |
---|
| 105 | /// The ID of a valid Node is a nonnegative integer not greater than |
---|
| 106 | /// \ref maxNodeId(). The range of the ID's is not surely continuous |
---|
| 107 | /// and the greatest node ID can be actually less then \ref maxNodeId(). |
---|
| 108 | /// |
---|
| 109 | /// The ID of the \ref INVALID node is -1. |
---|
| 110 | ///\return The ID of the node \c v. |
---|
[713] | 111 | static int id(Node v) { return v.n; } |
---|
[813] | 112 | /// Edge ID. |
---|
| 113 | |
---|
| 114 | /// The ID of a valid Edge is a nonnegative integer not greater than |
---|
| 115 | /// \ref maxEdgeId(). The range of the ID's is not surely continuous |
---|
| 116 | /// and the greatest edge ID can be actually less then \ref maxEdgeId(). |
---|
| 117 | /// |
---|
| 118 | /// The ID of the \ref INVALID edge is -1. |
---|
| 119 | ///\return The ID of the edge \c e. |
---|
[713] | 120 | static int id(Edge e) { return e.n; } |
---|
[104] | 121 | |
---|
[164] | 122 | Node addNode() { |
---|
| 123 | Node n; n.n=nodes.size(); |
---|
[104] | 124 | nodes.push_back(NodeT()); //FIXME: Hmmm... |
---|
| 125 | return n; |
---|
| 126 | } |
---|
[108] | 127 | |
---|
[164] | 128 | Edge addEdge(Node u, Node v) { |
---|
| 129 | Edge e; e.n=edges.size(); edges.push_back(EdgeT()); //FIXME: Hmmm... |
---|
[986] | 130 | edges[e.n].source=u.n; edges[e.n].target=v.n; |
---|
[104] | 131 | edges[e.n].next_out=nodes[u.n].first_out; |
---|
| 132 | edges[e.n].next_in=nodes[v.n].first_in; |
---|
| 133 | nodes[u.n].first_out=nodes[v.n].first_in=e.n; |
---|
[108] | 134 | |
---|
[104] | 135 | return e; |
---|
| 136 | } |
---|
| 137 | |
---|
[782] | 138 | void clear() { |
---|
| 139 | edges.clear(); |
---|
| 140 | nodes.clear(); |
---|
| 141 | } |
---|
[104] | 142 | |
---|
[946] | 143 | |
---|
[164] | 144 | class Node { |
---|
[946] | 145 | friend class SmartGraphBase; |
---|
[973] | 146 | friend class SmartGraph; |
---|
[104] | 147 | |
---|
| 148 | protected: |
---|
| 149 | int n; |
---|
[973] | 150 | ///\todo It should be removed (or at least define a setToId() instead). |
---|
| 151 | /// |
---|
[164] | 152 | Node(int nn) {n=nn;} |
---|
[104] | 153 | public: |
---|
[164] | 154 | Node() {} |
---|
[503] | 155 | Node (Invalid) { n=-1; } |
---|
[164] | 156 | bool operator==(const Node i) const {return n==i.n;} |
---|
| 157 | bool operator!=(const Node i) const {return n!=i.n;} |
---|
| 158 | bool operator<(const Node i) const {return n<i.n;} |
---|
[104] | 159 | }; |
---|
| 160 | |
---|
| 161 | |
---|
[164] | 162 | class Edge { |
---|
[946] | 163 | friend class SmartGraphBase; |
---|
[973] | 164 | friend class SmartGraph; |
---|
[185] | 165 | |
---|
[104] | 166 | protected: |
---|
| 167 | int n; |
---|
[973] | 168 | ///\todo It should be removed (or at least define a setToId() instead). |
---|
| 169 | /// |
---|
[905] | 170 | Edge(int nn) {n=nn;} |
---|
[706] | 171 | public: |
---|
[164] | 172 | Edge() { } |
---|
[174] | 173 | Edge (Invalid) { n=-1; } |
---|
[164] | 174 | bool operator==(const Edge i) const {return n==i.n;} |
---|
| 175 | bool operator!=(const Edge i) const {return n!=i.n;} |
---|
| 176 | bool operator<(const Edge i) const {return n<i.n;} |
---|
[946] | 177 | }; |
---|
[905] | 178 | |
---|
[946] | 179 | void first(Node& node) const { |
---|
| 180 | node.n = nodes.size() - 1; |
---|
| 181 | } |
---|
| 182 | |
---|
| 183 | static void next(Node& node) { |
---|
| 184 | --node.n; |
---|
| 185 | } |
---|
| 186 | |
---|
| 187 | void first(Edge& edge) const { |
---|
| 188 | edge.n = edges.size() - 1; |
---|
| 189 | } |
---|
| 190 | |
---|
| 191 | static void next(Edge& edge) { |
---|
| 192 | --edge.n; |
---|
| 193 | } |
---|
| 194 | |
---|
| 195 | void firstOut(Edge& edge, const Node& node) const { |
---|
| 196 | edge.n = nodes[node.n].first_out; |
---|
| 197 | } |
---|
| 198 | |
---|
| 199 | void nextOut(Edge& edge) const { |
---|
| 200 | edge.n = edges[edge.n].next_out; |
---|
| 201 | } |
---|
| 202 | |
---|
| 203 | void firstIn(Edge& edge, const Node& node) const { |
---|
| 204 | edge.n = nodes[node.n].first_in; |
---|
| 205 | } |
---|
[104] | 206 | |
---|
[946] | 207 | void nextIn(Edge& edge) const { |
---|
| 208 | edge.n = edges[edge.n].next_in; |
---|
| 209 | } |
---|
[105] | 210 | |
---|
[969] | 211 | Edge _findEdge(Node u,Node v, Edge prev = INVALID) |
---|
| 212 | { |
---|
| 213 | int e = (prev.n==-1)? nodes[u.n].first_out : edges[prev.n].next_out; |
---|
[986] | 214 | while(e!=-1 && edges[e].source!=v.n) e = edges[e].next_out; |
---|
[969] | 215 | prev.n=e; |
---|
| 216 | return prev; |
---|
| 217 | } |
---|
[973] | 218 | |
---|
[104] | 219 | }; |
---|
[185] | 220 | |
---|
[946] | 221 | typedef AlterableGraphExtender<SmartGraphBase> AlterableSmartGraphBase; |
---|
| 222 | typedef IterableGraphExtender<AlterableSmartGraphBase> IterableSmartGraphBase; |
---|
[980] | 223 | typedef DefaultMappableGraphExtender<IterableSmartGraphBase> MappableSmartGraphBase; |
---|
[946] | 224 | typedef ExtendableGraphExtender<MappableSmartGraphBase> ExtendableSmartGraphBase; |
---|
| 225 | typedef ClearableGraphExtender<ExtendableSmartGraphBase> ClearableSmartGraphBase; |
---|
[937] | 226 | |
---|
[950] | 227 | ///A smart graph class. |
---|
[937] | 228 | |
---|
[950] | 229 | ///This is a simple and fast graph implementation. |
---|
| 230 | ///It is also quite memory efficient, but at the price |
---|
[974] | 231 | ///that <b> it does support only limited (only stack-like) |
---|
| 232 | ///node and edge deletions</b>. |
---|
[950] | 233 | ///It conforms to |
---|
[959] | 234 | ///the \ref concept::ExtendableGraph "ExtendableGraph" concept. |
---|
| 235 | ///\sa concept::ExtendableGraph. |
---|
[950] | 236 | /// |
---|
| 237 | ///\todo Some member functions could be \c static. |
---|
| 238 | /// |
---|
| 239 | ///\author Alpar Juttner |
---|
[980] | 240 | class SmartGraph : public ClearableSmartGraphBase { |
---|
[969] | 241 | public: |
---|
| 242 | /// Finds an edge between two nodes. |
---|
[973] | 243 | |
---|
[969] | 244 | /// Finds an edge from node \c u to node \c v. |
---|
| 245 | /// |
---|
| 246 | /// If \c prev is \ref INVALID (this is the default value), then |
---|
| 247 | /// it finds the first edge from \c u to \c v. Otherwise it looks for |
---|
| 248 | /// the next edge from \c u to \c v after \c prev. |
---|
| 249 | /// \return The found edge or \ref INVALID if there is no such an edge. |
---|
| 250 | /// |
---|
| 251 | /// Thus you can iterate through each edge from \c u to \c v as it follows. |
---|
| 252 | /// \code |
---|
| 253 | /// for(Edge e=G.findEdge(u,v);e!=INVALID;e=G.findEdge(u,v,e)) { |
---|
| 254 | /// ... |
---|
| 255 | /// } |
---|
| 256 | /// \endcode |
---|
| 257 | /// \todo Possibly it should be a global function. |
---|
| 258 | Edge findEdge(Node u,Node v, Edge prev = INVALID) |
---|
| 259 | { |
---|
| 260 | return _findEdge(u,v,prev); |
---|
| 261 | } |
---|
[973] | 262 | |
---|
| 263 | ///Internal data structure to store snapshots |
---|
| 264 | |
---|
| 265 | ///\ingroup graphs |
---|
| 266 | ///\sa makeSnapShot() |
---|
| 267 | ///\sa rollBack() |
---|
| 268 | struct SnapShot |
---|
| 269 | { |
---|
| 270 | unsigned int node_num; |
---|
| 271 | unsigned int edge_num; |
---|
| 272 | }; |
---|
| 273 | |
---|
| 274 | ///Make a snapshot of the graph. |
---|
| 275 | |
---|
| 276 | ///Make a snapshot of the graph. |
---|
| 277 | /// |
---|
| 278 | ///The newly added nodes and edges can be removed using the |
---|
| 279 | ///rollBack() function. |
---|
| 280 | /// |
---|
| 281 | ///\return An stucture SnapShot describing the pesent state of the |
---|
| 282 | ///graph. |
---|
| 283 | ///\note After you rolled back to a state, you cannot roll "back" to |
---|
| 284 | ///a later state, in other word you cannot add again the edges deleted |
---|
| 285 | ///by rollBack(). |
---|
[974] | 286 | ///\todo This function might be called saveState() or getState(). |
---|
[973] | 287 | SnapShot makeSnapShot() |
---|
| 288 | { |
---|
| 289 | SnapShot s; |
---|
| 290 | s.node_num=nodes.size(); |
---|
| 291 | s.edge_num=edges.size(); |
---|
| 292 | return s; |
---|
| 293 | } |
---|
| 294 | |
---|
| 295 | ///Undo the changes until a snapshot. |
---|
| 296 | |
---|
| 297 | ///Undo the changes until a snapshot created by makeSnapShot(). |
---|
| 298 | /// |
---|
| 299 | ///\param s an internal stucture given back by makeSnapShot() |
---|
| 300 | ///\note After you rolled back to a state, you cannot "roll forward" to |
---|
| 301 | ///a later state, in other word you cannot add again the edges deleted |
---|
| 302 | ///by rollBack(). |
---|
| 303 | /// |
---|
| 304 | ///\todo This function might be called undo(). |
---|
| 305 | |
---|
| 306 | void rollBack(const SnapShot &s) |
---|
| 307 | { |
---|
| 308 | while(s.edge_num>edges.size()) { |
---|
| 309 | edge_observers.erase(Edge(edges.size()-1)); |
---|
[986] | 310 | nodes[edges.back().target].first_in=edges.back().next_in; |
---|
| 311 | nodes[edges.back().source].first_out=edges.back().next_out; |
---|
[973] | 312 | edges.pop_back(); |
---|
| 313 | } |
---|
| 314 | //nodes.resize(s.nodes_num); |
---|
| 315 | while(s.node_num>nodes.size()) { |
---|
| 316 | node_observers.erase(Node(nodes.size()-1)); |
---|
| 317 | nodes.pop_back(); |
---|
| 318 | } |
---|
| 319 | } |
---|
| 320 | }; |
---|
[950] | 321 | |
---|
[407] | 322 | /// @} |
---|
[921] | 323 | } //namespace lemon |
---|
[104] | 324 | |
---|
[157] | 325 | |
---|
[921] | 326 | #endif //LEMON_SMART_GRAPH_H |
---|