A sample file.
2 #ifndef LEMON_NET_GRAPH_H
3 #define LEMON_NET_GRAPH_H
6 ///\brief Declaration of HierarchyGraph.
8 #include <lemon/invalid.h>
9 #include <lemon/maps.h>
11 /// The namespace of LEMON
15 // @defgroup empty_graph The HierarchyGraph class
18 /// A graph class in that a simple edge can represent a path.
20 /// This class provides common features of a graph structure
21 /// that represents a network. You can handle with it layers. This
22 /// means that a node in one layer can be a complete network in a nother
25 template < class Gact, class Gsub > class HierarchyGraph
34 /// Map of the subnetworks in the sublayer
35 /// The appropriate edge nodes are also stored here
40 struct actedgesubnodestruct
42 typename Gact::Edge actedge;
43 typename Gsub::Node subnode;
49 typename Gact::Node * actuallayernode;
51 actedgesubnodestruct *assignments;
55 int addAssignment (typename Gact::Edge actedge,
56 typename Gsub::Node subnode)
58 if (!(actuallayer->valid (actedge)))
60 cerr << "The given edge is not in the given network!" << endl;
63 else if ((actuallayer->id (actuallayer->source (actedge)) !=
64 actuallayer->id (*actuallayernode))
65 && (actuallayer->id (actuallayer->target (actedge)) !=
66 actuallayer->id (*actuallayernode)))
68 cerr << "The given edge does not connect to the given node!" <<
73 if (!(subnetwork->valid (subnode)))
75 cerr << "The given node is not in the given network!" << endl;
80 //while in the array there is valid note that is not equvivalent with the one that would be noted increase i
81 while ((i < edgenumber)
82 && (actuallayer->valid (assignments[i].actedge))
83 && (assignments[i].actedge != actedge))
85 if (assignments[i].actedge == actedge)
87 cout << "Warning: Redefinement of assigment!!!" << endl;
92 "This case can't be!!! (because there should be the guven edge in the array already and the cycle had to stop)"
95 //if(!(actuallayer->valid(assignments[i].actedge))) //this condition is necessary if we do not obey redefinition
97 assignments[i].actedge = actedge;
98 assignments[i].subnode = subnode;
101 /// If to all of the edges a subnode is assigned then the subnetwork is connectable (attachable?)
102 /// We do not need to check for further attributes, because to notice an assignment we need
103 /// all of them to be correctly initialised before.
104 if (i == edgenumber - 1)
110 int setSubNetwork (Gsub * sn)
116 int setActualLayer (Gact * al)
122 int setActualLayerNode (typename Gact::Node * aln)
124 typename Gact::InEdgeIt iei;
125 typename Gact::OutEdgeIt oei;
127 actuallayernode = aln;
133 for (iei = actuallayer->first (iei, (*actuallayernode));
134 ((actuallayer->valid (iei))
135 && (actuallayer->target (iei) == (*actuallayernode)));
136 actuallayer->next (iei))
138 cout << actuallayer->id (actuallayer->
139 source (iei)) << " " << actuallayer->
140 id (actuallayer->target (iei)) << endl;
143 //cout << "Number of in-edges: " << edgenumber << endl;
144 for (oei = actuallayer->first (oei, (*actuallayernode));
145 ((actuallayer->valid (oei))
146 && (actuallayer->source (oei) == (*actuallayernode)));
147 actuallayer->next (oei))
149 cout << actuallayer->id (actuallayer->
150 source (oei)) << " " << actuallayer->
151 id (actuallayer->target (oei)) << endl;
154 //cout << "Number of in+out-edges: " << edgenumber << endl;
155 assignments = new actedgesubnodestruct[edgenumber];
156 for (int i = 0; i < edgenumber; i++)
158 assignments[i].actedge = INVALID;
159 assignments[i].subnode = INVALID;
164 cerr << "There is no actual layer defined yet!" << endl;
171 SubNetwork ():edgenumber (0), connectable (false), actuallayer (NULL),
172 actuallayernode (NULL), subnetwork (NULL),
179 typename Gact::template NodeMap < SubNetwork > subnetworks;
182 /// Defalult constructor.
183 /// We don't need any extra lines, because the actuallayer
184 /// variable has run its constructor, when we have created this class
185 /// So only the two maps has to be initialised here.
186 HierarchyGraph ():subnetworks (actuallayer)
192 HierarchyGraph (const HierarchyGraph < Gact, Gsub > &HG):actuallayer (HG.actuallayer),
199 /// The base type of the node iterators.
201 /// This is the base type of each node iterators,
202 /// thus each kind of node iterator will convert to this.
203 /// The Node type of the HierarchyGraph is the Node type of the actual layer.
204 typedef typename Gact::Node Node;
207 /// This iterator goes through each node.
209 /// Its usage is quite simple, for example you can count the number
210 /// of nodes in graph \c G of type \c Graph like this:
213 ///for(Graph::NodeIt n(G);G.valid(n);G.next(n)) count++;
215 /// The NodeIt type of the HierarchyGraph is the NodeIt type of the actual layer.
216 typedef typename Gact::NodeIt NodeIt;
219 /// The base type of the edge iterators.
220 /// The Edge type of the HierarchyGraph is the Edge type of the actual layer.
221 typedef typename Gact::Edge Edge;
224 /// This iterator goes trough the outgoing edges of a node.
226 /// This iterator goes trough the \e outgoing edges of a certain node
228 /// Its usage is quite simple, for example you can count the number
229 /// of outgoing edges of a node \c n
230 /// in graph \c G of type \c Graph as follows.
233 ///for(Graph::OutEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
235 /// The OutEdgeIt type of the HierarchyGraph is the OutEdgeIt type of the actual layer.
236 typedef typename Gact::OutEdgeIt OutEdgeIt;
239 /// This iterator goes trough the incoming edges of a node.
241 /// This iterator goes trough the \e incoming edges of a certain node
243 /// Its usage is quite simple, for example you can count the number
244 /// of outgoing edges of a node \c n
245 /// in graph \c G of type \c Graph as follows.
248 ///for(Graph::InEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
250 /// The InEdgeIt type of the HierarchyGraph is the InEdgeIt type of the actual layer.
251 typedef typename Gact::InEdgeIt InEdgeIt;
254 /// This iterator goes through each edge.
256 /// This iterator goes through each edge of a graph.
257 /// Its usage is quite simple, for example you can count the number
258 /// of edges in a graph \c G of type \c Graph as follows:
261 ///for(Graph::EdgeIt e(G);G.valid(e);G.next(e)) count++;
263 /// The EdgeIt type of the HierarchyGraph is the EdgeIt type of the actual layer.
264 typedef typename Gact::EdgeIt EdgeIt;
267 /// First node of the graph.
269 /// \retval i the first node.
270 /// \return the first node.
271 typename Gact::NodeIt & first (typename Gact::NodeIt & i) const
273 return actuallayer.first (i);
277 /// The first incoming edge.
278 typename Gact::InEdgeIt & first (typename Gact::InEdgeIt & i,
279 typename Gact::Node) const
281 return actuallayer.first (i);
285 /// The first outgoing edge.
286 typename Gact::OutEdgeIt & first (typename Gact::OutEdgeIt & i,
287 typename Gact::Node) const
289 return actuallayer.first (i);
293 // SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
294 /// The first edge of the Graph.
295 typename Gact::EdgeIt & first (typename Gact::EdgeIt & i) const
297 return actuallayer.first (i);
301 // Node getNext(Node) const {}
302 // InEdgeIt getNext(InEdgeIt) const {}
303 // OutEdgeIt getNext(OutEdgeIt) const {}
304 // //SymEdgeIt getNext(SymEdgeIt) const {}
305 // EdgeIt getNext(EdgeIt) const {}
308 /// Go to the next node.
309 typename Gact::NodeIt & next (typename Gact::NodeIt & i) const
311 return actuallayer.next (i);
313 /// Go to the next incoming edge.
314 typename Gact::InEdgeIt & next (typename Gact::InEdgeIt & i) const
316 return actuallayer.next (i);
318 /// Go to the next outgoing edge.
319 typename Gact::OutEdgeIt & next (typename Gact::OutEdgeIt & i) const
321 return actuallayer.next (i);
323 //SymEdgeIt &next(SymEdgeIt &) const {}
324 /// Go to the next edge.
325 typename Gact::EdgeIt & next (typename Gact::EdgeIt & i) const
327 return actuallayer.next (i);
330 ///Gives back the target node of an edge.
331 typename Gact::Node target (typename Gact::Edge edge) const
333 return actuallayer.target (edge);
335 ///Gives back the source node of an edge.
336 typename Gact::Node source (typename Gact::Edge edge) const
338 return actuallayer.source (edge);
341 // Node aNode(InEdgeIt) const {}
342 // Node aNode(OutEdgeIt) const {}
343 // Node aNode(SymEdgeIt) const {}
345 // Node bNode(InEdgeIt) const {}
346 // Node bNode(OutEdgeIt) const {}
347 // Node bNode(SymEdgeIt) const {}
349 /// Checks if a node iterator is valid
351 ///\todo Maybe, it would be better if iterator converted to
352 ///bool directly, as Jacint prefers.
353 bool valid (const typename Gact::Node & node) const
355 return actuallayer.valid (node);
357 /// Checks if an edge iterator is valid
359 ///\todo Maybe, it would be better if iterator converted to
360 ///bool directly, as Jacint prefers.
361 bool valid (const typename Gact::Edge & edge) const
363 return actuallayer.valid (edge);
366 ///Gives back the \e id of a node.
368 ///\warning Not all graph structures provide this feature.
370 int id (const typename Gact::Node & node) const
372 return actuallayer.id (node);
374 ///Gives back the \e id of an edge.
376 ///\warning Not all graph structures provide this feature.
378 int id (const typename Gact::Edge & edge) const
380 return actuallayer.id (edge);
383 //void setInvalid(Node &) const {};
384 //void setInvalid(Edge &) const {};
386 ///Add a new node to the graph.
388 /// \return the new node.
390 typename Gact::Node addNode ()
392 return actuallayer.addNode ();
394 ///Add a new edge to the graph.
396 ///Add a new edge to the graph with source node \c source
397 ///and target node \c target.
398 ///\return the new edge.
399 typename Gact::Edge addEdge (typename Gact::Node node1,
400 typename Gact::Node node2)
402 return actuallayer.addEdge (node1, node2);
405 /// Resets the graph.
407 /// This function deletes all edges and nodes of the graph.
408 /// It also frees the memory allocated to store them.
411 actuallayer.clear ();
416 return actuallayer.nodeNum ();
420 return actuallayer.edgeNum ();
423 ///Read/write/reference map of the nodes to type \c T.
425 ///Read/write/reference map of the nodes to type \c T.
427 /// \todo We may need copy constructor
428 /// \todo We may need conversion from other nodetype
429 /// \todo We may need operator=
430 /// \warning Making maps that can handle bool type (NodeMap<bool>)
431 /// needs extra attention!
433 template < class T > class NodeMap
439 NodeMap (const HierarchyGraph &)
442 NodeMap (const HierarchyGraph &, T)
446 template < typename TT > NodeMap (const NodeMap < TT > &)
450 /// Sets the value of a node.
452 /// Sets the value associated with node \c i to the value \c t.
457 // Gets the value of a node.
458 //T get(Node i) const {return *(T*)0;} //FIXME: Is it necessary?
463 const T & operator[] (Node) const
468 /// Updates the map if the graph has been changed
470 /// \todo Do we need this?
477 } //FIXME: Is it necessary
480 ///Read/write/reference map of the edges to type \c T.
482 ///Read/write/reference map of the edges to type \c T.
483 ///It behaves exactly in the same way as \ref NodeMap.
486 /// \todo We may need copy constructor
487 /// \todo We may need conversion from other edgetype
488 /// \todo We may need operator=
489 template < class T > class EdgeMap
495 EdgeMap (const HierarchyGraph &)
498 EdgeMap (const HierarchyGraph &, T)
502 ///\todo It can copy between different types.
504 template < typename TT > EdgeMap (const EdgeMap < TT > &)
511 //T get(Edge) const {return *(T*)0;}
516 const T & operator[] (Edge) const
526 } //FIXME: Is it necessary
530 /// An empty erasable graph class.
532 /// This class provides all the common features of an \e erasable graph
534 /// however completely without implementations and real data structures
535 /// behind the interface.
536 /// All graph algorithms should compile with this class, but it will not
537 /// run properly, of course.
539 /// \todo This blabla could be replaced by a sepatate description about
542 /// It can be used for checking the interface compatibility,
543 /// or it can serve as a skeleton of a new graph structure.
545 /// Also, you will find here the full documentation of a certain graph
546 /// feature, the documentation of a real graph imlementation
547 /// like @ref ListGraph or
548 /// @ref SmartGraph will just refer to this structure.
549 template < typename Gact, typename Gsub > class ErasableHierarchyGraph:public HierarchyGraph < Gact,
555 void erase (typename Gact::Node n)
557 actuallayer.erase (n);
560 void erase (typename Gact::Edge e)
562 actuallayer.erase (e);
565 /// Defalult constructor.
566 ErasableHierarchyGraph ()
570 ErasableHierarchyGraph (const HierarchyGraph < Gact, Gsub > &EPG)
581 #endif // LEMON_SKELETON_GRAPH_H