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.
37 GraphSkeleton(const GraphSkeleton &G) {}
39 /// The base type of the node iterators.
41 /// This is the base type of each node iterators,
42 /// thus each kind of node iterator will convert to this.
45 /// @warning The default constructor sets the iterator
46 /// to an undefined value.
48 /// Invalid constructor \& conversion.
50 /// This constructor initializes the iterator to be invalid.
51 /// \sa Invalid for more details.
54 //Node(const Node &) {}
56 /// Two iterators are equal if and only if they point to the
57 /// same object or both are invalid.
58 bool operator==(Node n) const { return true; }
60 /// \sa \ref operator==(Node n)
62 bool operator!=(Node n) const { return true; }
64 bool operator<(Node n) const { return true; }
67 /// This iterator goes through each node.
69 /// This iterator goes through each node.
70 /// Its usage is quite simple, for example you can count the number
71 /// of nodes in graph \c G of type \c Graph like this:
74 ///for(Graph::NodeIt n(G);G.valid(n);G.next(n)) count++;
76 class NodeIt : public Node {
78 /// @warning The default constructor sets the iterator
79 /// to an undefined value.
81 /// Invalid constructor \& conversion.
83 /// Initialize the iterator to be invalid
84 /// \sa Invalid for more details.
86 /// Sets the iterator to the first node of \c G.
87 NodeIt(const GraphSkeleton &G) {}
88 /// @warning The default constructor sets the iterator
89 /// to an undefined value.
90 NodeIt(const NodeIt &) {}
94 /// The base type of the edge iterators.
97 /// @warning The default constructor sets the iterator
98 /// to an undefined value.
100 /// Initialize the iterator to be invalid
102 /// Two iterators are equal if and only if they point to the
103 /// same object or both are invalid.
104 bool operator==(Edge n) const { return true; }
105 bool operator!=(Edge n) const { return true; }
106 bool operator<(Edge n) const { return true; }
109 /// This iterator goes trough the outgoing edges of a node.
111 /// This iterator goes trough the \e outgoing edges of a certain node
113 /// Its usage is quite simple, for example you can count the number
114 /// of outgoing edges of a node \c n
115 /// in graph \c G of type \c Graph as follows.
118 ///for(Graph::OutEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
121 class OutEdgeIt : public Edge {
123 /// @warning The default constructor sets the iterator
124 /// to an undefined value.
126 /// Initialize the iterator to be invalid
127 OutEdgeIt(Invalid) {}
128 /// This constructor sets the iterator to first outgoing edge.
130 /// This constructor set the iterator to the first outgoing edge of
133 ///@param G the graph
134 OutEdgeIt(const GraphSkeleton & G, Node n) {}
137 /// This iterator goes trough the incoming edges of a node.
139 /// This iterator goes trough the \e incoming edges of a certain node
141 /// Its usage is quite simple, for example you can count the number
142 /// of outgoing edges of a node \c n
143 /// in graph \c G of type \c Graph as follows.
146 ///for(Graph::InEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
149 class InEdgeIt : public Edge {
151 /// @warning The default constructor sets the iterator
152 /// to an undefined value.
154 /// Initialize the iterator to be invalid
156 InEdgeIt(const GraphSkeleton &, Node) {}
158 // class SymEdgeIt : public Edge {};
160 /// This iterator goes through each edge.
162 /// This iterator goes through each edge of a graph.
163 /// Its usage is quite simple, for example you can count the number
164 /// of edges in a graph \c G of type \c Graph as follows:
167 ///for(Graph::EdgeIt e(G);G.valid(e);G.next(e)) count++;
169 class EdgeIt : public Edge {
171 /// @warning The default constructor sets the iterator
172 /// to an undefined value.
174 /// Initialize the iterator to be invalid
176 EdgeIt(const GraphSkeleton &) {}
179 /// First node of the graph.
181 /// \post \c i and the return value will be the first node.
183 NodeIt &first(NodeIt &i) const { return i;}
185 /// The first incoming edge.
186 InEdgeIt &first(InEdgeIt &i, Node n) const { return i;}
187 /// The first outgoing edge.
188 OutEdgeIt &first(OutEdgeIt &i, Node n) const { return i;}
189 // SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
190 /// The first edge of the Graph.
191 EdgeIt &first(EdgeIt &i) const { return i;}
193 // Node getNext(Node) const {}
194 // InEdgeIt getNext(InEdgeIt) const {}
195 // OutEdgeIt getNext(OutEdgeIt) const {}
196 // //SymEdgeIt getNext(SymEdgeIt) const {}
197 // EdgeIt getNext(EdgeIt) const {}
199 /// Go to the next node.
200 NodeIt &next(NodeIt &i) const { return i;}
201 /// Go to the next incoming edge.
202 InEdgeIt &next(InEdgeIt &i) const { return i;}
203 /// Go to the next outgoing edge.
204 OutEdgeIt &next(OutEdgeIt &i) const { return i;}
205 //SymEdgeIt &next(SymEdgeIt &) const {}
206 /// Go to the next edge.
207 EdgeIt &next(EdgeIt &i) const { return i;}
209 ///Gives back the head node of an edge.
210 Node head(Edge) const { return INVALID; }
211 ///Gives back the tail node of an edge.
212 Node tail(Edge) const { return INVALID; }
214 // Node aNode(InEdgeIt) const {}
215 // Node aNode(OutEdgeIt) const {}
216 // Node aNode(SymEdgeIt) const {}
218 // Node bNode(InEdgeIt) const {}
219 // Node bNode(OutEdgeIt) const {}
220 // Node bNode(SymEdgeIt) const {}
222 /// Checks if a node iterator is valid
224 ///\todo Maybe, it would be better if iterator converted to
225 ///bool directly, as Jacint prefers.
226 bool valid(const Node&) const { return true;}
227 /// Checks if an edge iterator is valid
229 ///\todo Maybe, it would be better if iterator converted to
230 ///bool directly, as Jacint prefers.
231 bool valid(const Edge&) const { return true;}
233 ///Gives back the \e id of a node.
235 ///\warning Not all graph structures provide this feature.
237 int id(const Node&) const { return 0;}
238 ///Gives back the \e id of an edge.
240 ///\warning Not all graph structures provide this feature.
242 int id(const Edge&) const { return 0;}
244 //void setInvalid(Node &) const {};
245 //void setInvalid(Edge &) const {};
247 ///Add a new node to the graph.
249 /// \return the new node.
251 Node addNode() { return INVALID;}
252 ///Add a new edge to the graph.
254 ///Add a new edge to the graph with tail node \c tail
255 ///and head node \c head.
256 ///\return the new edge.
257 Edge addEdge(Node tail, Node head) { return INVALID;}
259 /// Resets the graph.
261 /// This function deletes all edges and nodes of the graph.
262 /// It also frees the memory allocated to store them.
265 int nodeNum() const { return 0;}
266 int edgeNum() const { return 0;}
268 ///Read/write/reference map of the nodes to type \c T.
270 ///Read/write/reference map of the nodes to type \c T.
271 /// \sa MemoryMapSkeleton
272 /// \todo We may need copy constructor
273 /// \todo We may need conversion from other nodetype
274 /// \todo We may need operator=
275 /// \warning Making maps that can handle bool type (NodeMap<bool>)
276 /// needs extra attention!
278 template<class T> class NodeMap
282 typedef Node KeyType;
284 NodeMap(const GraphSkeleton &G) {}
285 NodeMap(const GraphSkeleton &G, T t) {}
287 template<typename TT> NodeMap(const NodeMap<TT> &m) {}
289 /// Sets the value of a node.
291 /// Sets the value associated with node \c i to the value \c t.
293 void set(Node i, T t) {}
294 /// Gets the value of a node.
295 T get(Node i) const {return *(T*)0;} //FIXME: Is it necessary
296 T &operator[](Node i) {return *(T*)0;}
297 const T &operator[](Node i) const {return *(T*)0;}
299 /// Updates the map if the graph has been changed
301 /// \todo Do we need this?
304 void update(T a) {} //FIXME: Is it necessary
307 ///Read/write/reference map of the edges to type \c T.
309 ///Read/write/reference map of the edges to type \c T.
310 ///It behaves exactly in the same way as \ref NodeMap.
312 /// \sa MemoryMapSkeleton
313 /// \todo We may need copy constructor
314 /// \todo We may need conversion from other edgetype
315 /// \todo We may need operator=
316 template<class T> class EdgeMap
320 typedef Edge KeyType;
322 EdgeMap(const GraphSkeleton &G) {}
323 EdgeMap(const GraphSkeleton &G, T t) {}
325 void set(Edge i, T t) {}
326 T get(Edge i) const {return *(T*)0;}
327 T &operator[](Edge i) {return *(T*)0;}
330 void update(T a) {} //FIXME: Is it necessary
334 /// An empty eraseable graph class.
336 /// This class provides all the common features of an \e eraseable graph
338 /// however completely without implementations and real data structures
339 /// behind the interface.
340 /// All graph algorithms should compile with this class, but it will not
341 /// run properly, of course.
343 /// \todo This blabla could be replaced by a sepatate description about
346 /// It can be used for checking the interface compatibility,
347 /// or it can serve as a skeleton of a new graph structure.
349 /// Also, you will find here the full documentation of a certain graph
350 /// feature, the documentation of a real graph imlementation
351 /// like @ref ListGraph or
352 /// @ref SmartGraph will just refer to this structure.
353 class EraseableGraphSkeleton : public GraphSkeleton
357 void erase(Node n) {}
359 void erase(Edge e) {}
361 /// Defalult constructor.
364 GraphSkeleton(const GraphSkeleton &G) {}
374 // class EmptyBipGraph : public Graph Skeleton
379 // ANode &next(ANode &) {}
380 // BNode &next(BNode &) {}
382 // ANode &getFirst(ANode &) const {}
383 // BNode &getFirst(BNode &) const {}
385 // enum NodeClass { A = 0, B = 1 };
386 // NodeClass getClass(Node n) {}
390 #endif // HUGO_GRAPH_H