2 #ifndef HUGO_SKELETON_GRAPH_H
3 #define HUGO_SKELETON_GRAPH_H
6 ///\brief Declaration of GraphSkeleton.
10 /// The namespace of HugoLib
13 // @defgroup empty_graph The GraphSkeleton class
16 /// An empty graph class.
18 /// This class provides all the common features of a graph structure,
19 /// however completely without implementations and real data structures
20 /// behind the interface.
21 /// All graph algorithms should compile with this class, but it will not
22 /// run properly, of course.
24 /// It can be used for checking the interface compatibility,
25 /// or it can serve as a skeleton of a new graph structure.
27 /// Also, you will find here the full documentation of a certain graph
28 /// feature, the documentation of a real graph imlementation
29 /// like @ref ListGraph or
30 /// @ref SmartGraph will just refer to this structure.
34 /// Defalult constructor.
38 ///\todo It is not clear, what we expect from a copy constructor.
39 ///E.g. How to assign the nodes/edges to each other? What about maps?
40 GraphSkeleton(const GraphSkeleton &G) {}
42 /// The base type of the node iterators.
44 /// This is the base type of each node iterators,
45 /// thus each kind of node iterator will convert to this.
48 /// @warning The default constructor sets the iterator
49 /// to an undefined value.
51 /// Invalid constructor \& conversion.
53 /// This constructor initializes the iterator to be invalid.
54 /// \sa Invalid for more details.
57 //Node(const Node &) {}
59 /// Two iterators are equal if and only if they point to the
60 /// same object or both are invalid.
61 bool operator==(Node) const { return true; }
63 /// \sa \ref operator==(Node n)
65 bool operator!=(Node) const { return true; }
67 bool operator<(Node) const { return true; }
70 /// This iterator goes through each node.
72 /// This iterator goes through each node.
73 /// Its usage is quite simple, for example you can count the number
74 /// of nodes in graph \c G of type \c Graph like this:
77 ///for(Graph::NodeIt n(G);G.valid(n);G.next(n)) count++;
79 class NodeIt : public Node {
81 /// @warning The default constructor sets the iterator
82 /// to an undefined value.
84 /// Invalid constructor \& conversion.
86 /// Initialize the iterator to be invalid
87 /// \sa Invalid for more details.
89 /// Sets the iterator to the first node of \c G.
90 NodeIt(const GraphSkeleton &) {}
91 /// @warning The default constructor sets the iterator
92 /// to an undefined value.
93 NodeIt(const NodeIt &n) : Node(n) {}
97 /// The base type of the edge iterators.
100 /// @warning The default constructor sets the iterator
101 /// to an undefined value.
103 /// Initialize the iterator to be invalid
105 /// Two iterators are equal if and only if they point to the
106 /// same object or both are invalid.
107 bool operator==(Edge) const { return true; }
108 bool operator!=(Edge) const { return true; }
109 bool operator<(Edge) const { return true; }
112 /// This iterator goes trough the outgoing edges of a node.
114 /// This iterator goes trough the \e outgoing edges of a certain node
116 /// Its usage is quite simple, for example you can count the number
117 /// of outgoing edges of a node \c n
118 /// in graph \c G of type \c Graph as follows.
121 ///for(Graph::OutEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
124 class OutEdgeIt : public Edge {
126 /// @warning The default constructor sets the iterator
127 /// to an undefined value.
129 /// Initialize the iterator to be invalid
130 OutEdgeIt(Invalid) {}
131 /// This constructor sets the iterator to first outgoing edge.
133 /// This constructor set the iterator to the first outgoing edge of
136 ///@param G the graph
137 OutEdgeIt(const GraphSkeleton &, Node) {}
140 /// This iterator goes trough the incoming edges of a node.
142 /// This iterator goes trough the \e incoming edges of a certain node
144 /// Its usage is quite simple, for example you can count the number
145 /// of outgoing edges of a node \c n
146 /// in graph \c G of type \c Graph as follows.
149 ///for(Graph::InEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
152 class InEdgeIt : public Edge {
154 /// @warning The default constructor sets the iterator
155 /// to an undefined value.
157 /// Initialize the iterator to be invalid
159 InEdgeIt(const GraphSkeleton &, Node) {}
161 // class SymEdgeIt : public Edge {};
163 /// This iterator goes through each edge.
165 /// This iterator goes through each edge of a graph.
166 /// Its usage is quite simple, for example you can count the number
167 /// of edges in a graph \c G of type \c Graph as follows:
170 ///for(Graph::EdgeIt e(G);G.valid(e);G.next(e)) count++;
172 class EdgeIt : public Edge {
174 /// @warning The default constructor sets the iterator
175 /// to an undefined value.
177 /// Initialize the iterator to be invalid
179 EdgeIt(const GraphSkeleton &) {}
182 /// First node of the graph.
184 /// \retval i the first node.
185 /// \return the first node.
187 NodeIt &first(NodeIt &i) const { return i;}
189 /// The first incoming edge.
190 InEdgeIt &first(InEdgeIt &i, Node) const { return i;}
191 /// The first outgoing edge.
192 OutEdgeIt &first(OutEdgeIt &i, Node) const { return i;}
193 // SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
194 /// The first edge of the Graph.
195 EdgeIt &first(EdgeIt &i) const { return i;}
197 // Node getNext(Node) const {}
198 // InEdgeIt getNext(InEdgeIt) const {}
199 // OutEdgeIt getNext(OutEdgeIt) const {}
200 // //SymEdgeIt getNext(SymEdgeIt) const {}
201 // EdgeIt getNext(EdgeIt) const {}
203 /// Go to the next node.
204 NodeIt &next(NodeIt &i) const { return i;}
205 /// Go to the next incoming edge.
206 InEdgeIt &next(InEdgeIt &i) const { return i;}
207 /// Go to the next outgoing edge.
208 OutEdgeIt &next(OutEdgeIt &i) const { return i;}
209 //SymEdgeIt &next(SymEdgeIt &) const {}
210 /// Go to the next edge.
211 EdgeIt &next(EdgeIt &i) const { return i;}
213 ///Gives back the head node of an edge.
214 Node head(Edge) const { return INVALID; }
215 ///Gives back the tail node of an edge.
216 Node tail(Edge) const { return INVALID; }
218 // Node aNode(InEdgeIt) const {}
219 // Node aNode(OutEdgeIt) const {}
220 // Node aNode(SymEdgeIt) const {}
222 // Node bNode(InEdgeIt) const {}
223 // Node bNode(OutEdgeIt) const {}
224 // Node bNode(SymEdgeIt) const {}
226 /// Checks if a node iterator is valid
228 ///\todo Maybe, it would be better if iterator converted to
229 ///bool directly, as Jacint prefers.
230 bool valid(const Node&) const { return true;}
231 /// Checks if an edge iterator is valid
233 ///\todo Maybe, it would be better if iterator converted to
234 ///bool directly, as Jacint prefers.
235 bool valid(const Edge&) const { return true;}
237 ///Gives back the \e id of a node.
239 ///\warning Not all graph structures provide this feature.
241 int id(const Node&) const { return 0;}
242 ///Gives back the \e id of an edge.
244 ///\warning Not all graph structures provide this feature.
246 int id(const Edge&) const { return 0;}
248 //void setInvalid(Node &) const {};
249 //void setInvalid(Edge &) const {};
251 ///Add a new node to the graph.
253 /// \return the new node.
255 Node addNode() { return INVALID;}
256 ///Add a new edge to the graph.
258 ///Add a new edge to the graph with tail node \c tail
259 ///and head node \c head.
260 ///\return the new edge.
261 Edge addEdge(Node, Node) { return INVALID;}
263 /// Resets the graph.
265 /// This function deletes all edges and nodes of the graph.
266 /// It also frees the memory allocated to store them.
269 int nodeNum() const { return 0;}
270 int edgeNum() const { return 0;}
272 ///Read/write/reference map of the nodes to type \c T.
274 ///Read/write/reference map of the nodes to type \c T.
275 /// \sa MemoryMapSkeleton
276 /// \todo We may need copy constructor
277 /// \todo We may need conversion from other nodetype
278 /// \todo We may need operator=
279 /// \warning Making maps that can handle bool type (NodeMap<bool>)
280 /// needs extra attention!
282 template<class T> class NodeMap
286 typedef Node KeyType;
288 NodeMap(const GraphSkeleton &) {}
289 NodeMap(const GraphSkeleton &, T) {}
291 template<typename TT> NodeMap(const NodeMap<TT> &) {}
293 /// Sets the value of a node.
295 /// Sets the value associated with node \c i to the value \c t.
298 // Gets the value of a node.
299 //T get(Node i) const {return *(T*)0;} //FIXME: Is it necessary?
300 T &operator[](Node) {return *(T*)0;}
301 const T &operator[](Node) const {return *(T*)0;}
303 /// Updates the map if the graph has been changed
305 /// \todo Do we need this?
308 void update(T a) {} //FIXME: Is it necessary
311 ///Read/write/reference map of the edges to type \c T.
313 ///Read/write/reference map of the edges to type \c T.
314 ///It behaves exactly in the same way as \ref NodeMap.
316 /// \sa MemoryMapSkeleton
317 /// \todo We may need copy constructor
318 /// \todo We may need conversion from other edgetype
319 /// \todo We may need operator=
320 template<class T> class EdgeMap
324 typedef Edge KeyType;
326 EdgeMap(const GraphSkeleton &) {}
327 EdgeMap(const GraphSkeleton &, T ) {}
329 ///\todo It can copy between different types.
331 template<typename TT> EdgeMap(const EdgeMap<TT> &) {}
334 //T get(Edge) const {return *(T*)0;}
335 T &operator[](Edge) {return *(T*)0;}
336 const T &operator[](Edge) const {return *(T*)0;}
339 void update(T a) {} //FIXME: Is it necessary
343 /// An empty eraseable graph class.
345 /// This class provides all the common features of an \e eraseable graph
347 /// however completely without implementations and real data structures
348 /// behind the interface.
349 /// All graph algorithms should compile with this class, but it will not
350 /// run properly, of course.
352 /// \todo This blabla could be replaced by a sepatate description about
355 /// It can be used for checking the interface compatibility,
356 /// or it can serve as a skeleton of a new graph structure.
358 /// Also, you will find here the full documentation of a certain graph
359 /// feature, the documentation of a real graph imlementation
360 /// like @ref ListGraph or
361 /// @ref SmartGraph will just refer to this structure.
362 class EraseableGraphSkeleton : public GraphSkeleton
366 void erase(Node n) {}
368 void erase(Edge e) {}
370 /// Defalult constructor.
371 EraseableGraphSkeleton() {}
373 EraseableGraphSkeleton(const GraphSkeleton &G) {}
383 // class EmptyBipGraph : public Graph Skeleton
388 // ANode &next(ANode &) {}
389 // BNode &next(BNode &) {}
391 // ANode &getFirst(ANode &) const {}
392 // BNode &getFirst(BNode &) const {}
394 // enum NodeClass { A = 0, B = 1 };
395 // NodeClass getClass(Node n) {}
399 #endif // HUGO_SKELETON_GRAPH_H