[959] | 1 | /* -*- C++ -*- |
---|
| 2 | * src/lemon/concept/graph_component.h - Part of LEMON, a generic C++ optimization library |
---|
| 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 | */ |
---|
| 16 | |
---|
[1030] | 17 | ///\ingroup graph_concepts |
---|
[959] | 18 | ///\file |
---|
| 19 | ///\brief The graph components. |
---|
| 20 | |
---|
| 21 | |
---|
| 22 | #ifndef LEMON_CONCEPT_GRAPH_COMPONENT_H |
---|
| 23 | #define LEMON_CONCEPT_GRAPH_COMPONENT_H |
---|
| 24 | |
---|
| 25 | #include <lemon/invalid.h> |
---|
| 26 | #include <lemon/concept/maps.h> |
---|
| 27 | |
---|
[1134] | 28 | #include <lemon/alteration_notifier.h> |
---|
| 29 | |
---|
[959] | 30 | namespace lemon { |
---|
| 31 | namespace concept { |
---|
| 32 | |
---|
[1030] | 33 | /// \addtogroup graph_concepts |
---|
| 34 | /// @{ |
---|
[961] | 35 | |
---|
| 36 | /**************** Graph iterator concepts ****************/ |
---|
| 37 | |
---|
[1030] | 38 | /// Skeleton class for graph Node and Edge types |
---|
[961] | 39 | |
---|
[1030] | 40 | /// This class describes the interface of Node and Edge (and UndirEdge |
---|
| 41 | /// in undirected graphs) subtypes of graph types. |
---|
| 42 | /// |
---|
| 43 | /// \note This class is a template class so that we can use it to |
---|
| 44 | /// create graph skeleton classes. The reason for this is than Node |
---|
| 45 | /// and Edge types should \em not derive from the same base class. |
---|
| 46 | /// For Node you should instantiate it with character 'n' and for Edge |
---|
| 47 | /// with 'e'. |
---|
[961] | 48 | |
---|
[1030] | 49 | #ifndef DOXYGEN |
---|
| 50 | template <char _selector = '0'> |
---|
| 51 | #endif |
---|
[961] | 52 | class GraphItem { |
---|
| 53 | public: |
---|
[989] | 54 | /// Default constructor. |
---|
| 55 | |
---|
[1030] | 56 | /// \warning The default constructor is not required to set |
---|
| 57 | /// the item to some well-defined value. So you should consider it |
---|
| 58 | /// as uninitialized. |
---|
[961] | 59 | GraphItem() {} |
---|
[989] | 60 | /// Copy constructor. |
---|
| 61 | |
---|
| 62 | /// Copy constructor. |
---|
| 63 | /// |
---|
| 64 | GraphItem(GraphItem const&) {} |
---|
| 65 | /// Invalid constructor \& conversion. |
---|
| 66 | |
---|
| 67 | /// This constructor initializes the item to be invalid. |
---|
| 68 | /// \sa Invalid for more details. |
---|
[961] | 69 | GraphItem(Invalid) {} |
---|
[989] | 70 | /// Assign operator for nodes. |
---|
[961] | 71 | |
---|
[989] | 72 | /// The nodes are assignable. |
---|
| 73 | /// |
---|
[961] | 74 | GraphItem& operator=(GraphItem const&) { return *this; } |
---|
[989] | 75 | /// Equality operator. |
---|
| 76 | |
---|
| 77 | /// Two iterators are equal if and only if they represents the |
---|
| 78 | /// same node in the graph or both are invalid. |
---|
[961] | 79 | bool operator==(GraphItem) const { return false; } |
---|
[989] | 80 | /// Inequality operator. |
---|
| 81 | |
---|
| 82 | /// \sa operator==(const Node& n) |
---|
| 83 | /// |
---|
[961] | 84 | bool operator!=(GraphItem) const { return false; } |
---|
| 85 | |
---|
[1030] | 86 | /// Artificial ordering operator. |
---|
[989] | 87 | |
---|
[1030] | 88 | /// To allow the use of graph descriptors as key type in std::map or |
---|
| 89 | /// similar associative container we require this. |
---|
| 90 | /// |
---|
| 91 | /// \note This operator only have to define some strict ordering of |
---|
| 92 | /// the items; this order has nothing to do with the iteration |
---|
| 93 | /// ordering of the items. |
---|
| 94 | /// |
---|
| 95 | /// \bug This is a technical requirement. Do we really need this? |
---|
| 96 | bool operator<(GraphItem) const { return false; } |
---|
[989] | 97 | |
---|
| 98 | template<typename _GraphItem> |
---|
| 99 | struct Constraints { |
---|
| 100 | void constraints() { |
---|
| 101 | _GraphItem i1; |
---|
| 102 | _GraphItem i2 = i1; |
---|
| 103 | _GraphItem i3 = INVALID; |
---|
| 104 | |
---|
| 105 | i1 = i2 = i3; |
---|
| 106 | |
---|
| 107 | bool b; |
---|
| 108 | // b = (ia == ib) && (ia != ib) && (ia < ib); |
---|
| 109 | b = (ia == ib) && (ia != ib); |
---|
| 110 | b = (ia == INVALID) && (ib != INVALID); |
---|
[1136] | 111 | // b = (ia < ib); |
---|
[989] | 112 | } |
---|
| 113 | |
---|
| 114 | const _GraphItem &ia; |
---|
| 115 | const _GraphItem &ib; |
---|
| 116 | }; |
---|
[961] | 117 | }; |
---|
| 118 | |
---|
[1030] | 119 | /// A type describing the concept of graph node |
---|
| 120 | |
---|
| 121 | /// This is an instantiation of \ref GraphItem which can be used as a |
---|
| 122 | /// Node subtype in graph skeleton definitions |
---|
| 123 | typedef GraphItem<'n'> GraphNode; |
---|
| 124 | |
---|
| 125 | /// A type describing the concept of graph edge |
---|
| 126 | |
---|
| 127 | /// This is an instantiation of \ref GraphItem which can be used as a |
---|
| 128 | /// Edge subtype in graph skeleton definitions |
---|
| 129 | typedef GraphItem<'e'> GraphEdge; |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | /**************** Basic features of graphs ****************/ |
---|
| 133 | |
---|
[959] | 134 | /// An empty base graph class. |
---|
| 135 | |
---|
[961] | 136 | /// This class provides the minimal set of features needed for a graph |
---|
| 137 | /// structure. All graph concepts have to be conform to this base |
---|
| 138 | /// graph. |
---|
| 139 | /// |
---|
| 140 | /// \bug This is not true. The minimal graph concept is the |
---|
| 141 | /// BaseIterableGraphComponent. |
---|
[959] | 142 | |
---|
| 143 | class BaseGraphComponent { |
---|
| 144 | public: |
---|
| 145 | |
---|
| 146 | typedef BaseGraphComponent Graph; |
---|
| 147 | |
---|
| 148 | /// Node class of the graph. |
---|
| 149 | |
---|
| 150 | /// This class represents the Nodes of the graph. |
---|
| 151 | /// |
---|
[989] | 152 | typedef GraphItem<'n'> Node; |
---|
[959] | 153 | |
---|
| 154 | /// Edge class of the graph. |
---|
| 155 | |
---|
| 156 | /// This class represents the Edges of the graph. |
---|
| 157 | /// |
---|
[989] | 158 | typedef GraphItem<'e'> Edge; |
---|
[959] | 159 | |
---|
[986] | 160 | ///Gives back the target node of an edge. |
---|
[959] | 161 | |
---|
[986] | 162 | ///Gives back the target node of an edge. |
---|
[959] | 163 | /// |
---|
[986] | 164 | Node target(const Edge&) const { return INVALID;} |
---|
[959] | 165 | |
---|
[986] | 166 | ///Gives back the source node of an edge. |
---|
[959] | 167 | |
---|
[986] | 168 | ///Gives back the source node of an edge. |
---|
[959] | 169 | /// |
---|
[986] | 170 | Node source(const Edge&) const { return INVALID;} |
---|
[959] | 171 | |
---|
[961] | 172 | |
---|
[989] | 173 | template <typename _Graph> |
---|
| 174 | struct Constraints { |
---|
| 175 | typedef typename _Graph::Node Node; |
---|
| 176 | typedef typename _Graph::Edge Edge; |
---|
[959] | 177 | |
---|
[989] | 178 | void constraints() { |
---|
| 179 | checkConcept<GraphItem<'n'>, Node>(); |
---|
| 180 | checkConcept<GraphItem<'e'>, Edge>(); |
---|
| 181 | { |
---|
| 182 | Node n; |
---|
| 183 | Edge e; |
---|
| 184 | n = graph.source(e); |
---|
| 185 | n = graph.target(e); |
---|
| 186 | } |
---|
| 187 | } |
---|
[959] | 188 | |
---|
[989] | 189 | const _Graph& graph; |
---|
| 190 | }; |
---|
[959] | 191 | }; |
---|
| 192 | |
---|
| 193 | /// An empty iterable base graph class. |
---|
| 194 | |
---|
| 195 | /// This class provides beside the core graph features |
---|
| 196 | /// core iterable interface for the graph structure. |
---|
| 197 | /// Most of the base graphs should be conform to this concept. |
---|
| 198 | |
---|
| 199 | class BaseIterableGraphComponent : virtual public BaseGraphComponent { |
---|
| 200 | public: |
---|
| 201 | |
---|
| 202 | typedef BaseGraphComponent::Node Node; |
---|
| 203 | typedef BaseGraphComponent::Edge Edge; |
---|
| 204 | |
---|
| 205 | /// Gives back the first Node in the iterating order. |
---|
| 206 | |
---|
| 207 | /// Gives back the first Node in the iterating order. |
---|
| 208 | /// |
---|
| 209 | void first(Node&) const {} |
---|
| 210 | |
---|
| 211 | /// Gives back the next Node in the iterating order. |
---|
| 212 | |
---|
| 213 | /// Gives back the next Node in the iterating order. |
---|
| 214 | /// |
---|
| 215 | void next(Node&) const {} |
---|
| 216 | |
---|
| 217 | /// Gives back the first Edge in the iterating order. |
---|
| 218 | |
---|
| 219 | /// Gives back the first Edge in the iterating order. |
---|
| 220 | /// |
---|
| 221 | void first(Edge&) const {} |
---|
| 222 | /// Gives back the next Edge in the iterating order. |
---|
| 223 | |
---|
| 224 | /// Gives back the next Edge in the iterating order. |
---|
| 225 | /// |
---|
| 226 | void next(Edge&) const {} |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | /// Gives back the first of the Edges point to the given Node. |
---|
| 230 | |
---|
| 231 | /// Gives back the first of the Edges point to the given Node. |
---|
| 232 | /// |
---|
| 233 | void firstIn(Edge&, const Node&) const {} |
---|
| 234 | |
---|
| 235 | /// Gives back the next of the Edges points to the given Node. |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | /// Gives back the next of the Edges points to the given Node. |
---|
| 239 | /// |
---|
| 240 | void nextIn(Edge&) const {} |
---|
| 241 | |
---|
| 242 | /// Gives back the first of the Edges start from the given Node. |
---|
| 243 | |
---|
| 244 | /// Gives back the first of the Edges start from the given Node. |
---|
| 245 | /// |
---|
| 246 | void firstOut(Edge&, const Node&) const {} |
---|
| 247 | |
---|
| 248 | /// Gives back the next of the Edges start from the given Node. |
---|
| 249 | |
---|
| 250 | /// Gives back the next of the Edges start from the given Node. |
---|
| 251 | /// |
---|
| 252 | void nextOut(Edge&) const {} |
---|
| 253 | |
---|
| 254 | |
---|
[989] | 255 | template <typename _Graph> |
---|
| 256 | struct Constraints { |
---|
| 257 | |
---|
| 258 | void constraints() { |
---|
| 259 | checkConcept< BaseGraphComponent, _Graph >(); |
---|
| 260 | typename _Graph::Node node; |
---|
| 261 | typename _Graph::Edge edge; |
---|
| 262 | { |
---|
| 263 | graph.first(node); |
---|
| 264 | graph.next(node); |
---|
| 265 | } |
---|
| 266 | { |
---|
| 267 | graph.first(edge); |
---|
| 268 | graph.next(edge); |
---|
| 269 | } |
---|
| 270 | { |
---|
| 271 | graph.firstIn(edge, node); |
---|
| 272 | graph.nextIn(edge); |
---|
| 273 | } |
---|
| 274 | { |
---|
| 275 | graph.firstOut(edge, node); |
---|
| 276 | graph.nextOut(edge); |
---|
| 277 | } |
---|
| 278 | } |
---|
[959] | 279 | |
---|
[989] | 280 | const _Graph& graph; |
---|
| 281 | }; |
---|
[959] | 282 | }; |
---|
| 283 | |
---|
| 284 | /// An empty idable base graph class. |
---|
| 285 | |
---|
| 286 | /// This class provides beside the core graph features |
---|
| 287 | /// core id functions for the graph structure. |
---|
| 288 | /// The most of the base graphs should be conform to this concept. |
---|
| 289 | /// The id's are unique and immutable. |
---|
| 290 | class IDableGraphComponent : virtual public BaseGraphComponent { |
---|
| 291 | public: |
---|
| 292 | |
---|
| 293 | typedef BaseGraphComponent::Node Node; |
---|
| 294 | typedef BaseGraphComponent::Edge Edge; |
---|
| 295 | |
---|
| 296 | /// Gives back an unique integer id for the Node. |
---|
| 297 | |
---|
| 298 | /// Gives back an unique integer id for the Node. |
---|
| 299 | /// |
---|
| 300 | int id(const Node&) const { return -1;} |
---|
| 301 | |
---|
[1106] | 302 | /// \brief Gives back the node by the unique id. |
---|
| 303 | /// |
---|
| 304 | /// Gives back the node by the unique id. |
---|
| 305 | /// If the graph does not contain node with the given id |
---|
| 306 | /// then the result of the function is undetermined. |
---|
| 307 | Node fromId(int id, Node) const { return INVALID;} |
---|
[959] | 308 | |
---|
[1106] | 309 | /// \brief Gives back an unique integer id for the Edge. |
---|
| 310 | /// |
---|
[959] | 311 | /// Gives back an unique integer id for the Edge. |
---|
| 312 | /// |
---|
| 313 | int id(const Edge&) const { return -1;} |
---|
| 314 | |
---|
[1106] | 315 | /// \brief Gives back the edge by the unique id. |
---|
| 316 | /// |
---|
| 317 | /// Gives back the edge by the unique id. |
---|
| 318 | /// If the graph does not contain edge with the given id |
---|
| 319 | /// then the result of the function is undetermined. |
---|
| 320 | Edge fromId(int id, Edge) const { return INVALID;} |
---|
| 321 | |
---|
[989] | 322 | template <typename _Graph> |
---|
| 323 | struct Constraints { |
---|
[959] | 324 | |
---|
[989] | 325 | void constraints() { |
---|
| 326 | checkConcept< BaseGraphComponent, _Graph >(); |
---|
| 327 | typename _Graph::Node node; |
---|
| 328 | int nid = graph.id(node); |
---|
| 329 | nid = graph.id(node); |
---|
[1106] | 330 | node = graph.fromId(nid, Node()); |
---|
[989] | 331 | typename _Graph::Edge edge; |
---|
| 332 | int eid = graph.id(edge); |
---|
| 333 | eid = graph.id(edge); |
---|
[1106] | 334 | edge = graph.fromId(eid, Edge()); |
---|
[989] | 335 | } |
---|
[959] | 336 | |
---|
[989] | 337 | const _Graph& graph; |
---|
| 338 | }; |
---|
[959] | 339 | }; |
---|
| 340 | |
---|
| 341 | |
---|
| 342 | /// An empty max-idable base graph class. |
---|
| 343 | |
---|
| 344 | /// This class provides beside the core graph features |
---|
| 345 | /// core max id functions for the graph structure. |
---|
| 346 | /// The most of the base graphs should be conform to this concept. |
---|
| 347 | /// The id's are unique and immutable. |
---|
| 348 | class MaxIDableGraphComponent : virtual public BaseGraphComponent { |
---|
| 349 | public: |
---|
| 350 | |
---|
| 351 | /// Gives back an integer greater or equal to the maximum Node id. |
---|
| 352 | |
---|
| 353 | /// Gives back an integer greater or equal to the maximum Node id. |
---|
| 354 | /// |
---|
[980] | 355 | int maxId(Node = INVALID) const { return -1;} |
---|
[959] | 356 | |
---|
| 357 | /// Gives back an integer greater or equal to the maximum Edge id. |
---|
| 358 | |
---|
| 359 | /// Gives back an integer greater or equal to the maximum Edge id. |
---|
| 360 | /// |
---|
[980] | 361 | int maxId(Edge = INVALID) const { return -1;} |
---|
[959] | 362 | |
---|
[989] | 363 | template <typename _Graph> |
---|
| 364 | struct Constraints { |
---|
[959] | 365 | |
---|
[989] | 366 | void constraints() { |
---|
| 367 | checkConcept<BaseGraphComponent, _Graph>(); |
---|
| 368 | int nid = graph.maxId(typename _Graph::Node()); |
---|
| 369 | ignore_unused_variable_warning(nid); |
---|
| 370 | int eid = graph.maxId(typename _Graph::Edge()); |
---|
| 371 | ignore_unused_variable_warning(eid); |
---|
| 372 | } |
---|
| 373 | |
---|
| 374 | const _Graph& graph; |
---|
| 375 | }; |
---|
[959] | 376 | }; |
---|
| 377 | |
---|
| 378 | /// An empty extendable base graph class. |
---|
| 379 | |
---|
| 380 | /// This class provides beside the core graph features |
---|
| 381 | /// core graph extend interface for the graph structure. |
---|
| 382 | /// The most of the base graphs should be conform to this concept. |
---|
| 383 | class BaseExtendableGraphComponent : virtual public BaseGraphComponent { |
---|
| 384 | public: |
---|
| 385 | |
---|
| 386 | typedef BaseGraphComponent::Node Node; |
---|
| 387 | typedef BaseGraphComponent::Edge Edge; |
---|
| 388 | |
---|
| 389 | /// Adds a new Node to the graph. |
---|
| 390 | |
---|
| 391 | /// Adds a new Node to the graph. |
---|
| 392 | /// |
---|
| 393 | Node addNode() { |
---|
| 394 | return INVALID; |
---|
| 395 | } |
---|
| 396 | |
---|
| 397 | /// Adds a new Edge connects the two Nodes to the graph. |
---|
| 398 | |
---|
| 399 | /// Adds a new Edge connects the two Nodes to the graph. |
---|
| 400 | /// |
---|
| 401 | Edge addEdge(const Node& from, const Node& to) { |
---|
| 402 | return INVALID; |
---|
| 403 | } |
---|
| 404 | |
---|
[989] | 405 | template <typename _Graph> |
---|
| 406 | struct Constraints { |
---|
| 407 | void constraints() { |
---|
| 408 | checkConcept<BaseGraphComponent, _Graph >(); |
---|
| 409 | typename _Graph::Node node_a, node_b; |
---|
| 410 | node_a = graph.addNode(); |
---|
| 411 | typename _Graph::Edge edge; |
---|
| 412 | edge = graph.addEdge(node_a, node_b); |
---|
| 413 | } |
---|
[959] | 414 | |
---|
[989] | 415 | _Graph& graph; |
---|
| 416 | }; |
---|
[959] | 417 | }; |
---|
| 418 | |
---|
| 419 | /// An empty erasable base graph class. |
---|
| 420 | |
---|
| 421 | /// This class provides beside the core graph features |
---|
| 422 | /// core erase functions for the graph structure. |
---|
| 423 | /// The most of the base graphs should be conform to this concept. |
---|
| 424 | class BaseErasableGraphComponent : virtual public BaseGraphComponent { |
---|
| 425 | public: |
---|
| 426 | |
---|
| 427 | typedef BaseGraphComponent::Node Node; |
---|
| 428 | typedef BaseGraphComponent::Edge Edge; |
---|
| 429 | |
---|
| 430 | /// Erase a Node from the graph. |
---|
| 431 | |
---|
| 432 | /// Erase a Node from the graph. This function should not |
---|
| 433 | /// erase edges connecting to the Node. |
---|
| 434 | void erase(const Node&) {} |
---|
| 435 | |
---|
| 436 | /// Erase an Edge from the graph. |
---|
| 437 | |
---|
| 438 | /// Erase an Edge from the graph. |
---|
| 439 | /// |
---|
| 440 | void erase(const Edge&) {} |
---|
| 441 | |
---|
[989] | 442 | template <typename _Graph> |
---|
| 443 | struct Constraints { |
---|
| 444 | void constraints() { |
---|
| 445 | checkConcept<BaseGraphComponent, _Graph>(); |
---|
| 446 | typename _Graph::Node node; |
---|
| 447 | graph.erase(node); |
---|
| 448 | typename _Graph::Edge edge; |
---|
| 449 | graph.erase(edge); |
---|
| 450 | } |
---|
[959] | 451 | |
---|
[989] | 452 | _Graph& graph; |
---|
| 453 | }; |
---|
[959] | 454 | }; |
---|
| 455 | |
---|
| 456 | /// An empty clearable base graph class. |
---|
| 457 | |
---|
| 458 | /// This class provides beside the core graph features |
---|
| 459 | /// core clear functions for the graph structure. |
---|
| 460 | /// The most of the base graphs should be conform to this concept. |
---|
[1022] | 461 | class ClearableGraphComponent : virtual public BaseGraphComponent { |
---|
[959] | 462 | public: |
---|
| 463 | |
---|
| 464 | /// Erase all the Nodes and Edges from the graph. |
---|
| 465 | |
---|
| 466 | /// Erase all the Nodes and Edges from the graph. |
---|
| 467 | /// |
---|
| 468 | void clear() {} |
---|
[989] | 469 | |
---|
| 470 | template <typename _Graph> |
---|
| 471 | struct Constraints { |
---|
| 472 | void constraints() { |
---|
[1022] | 473 | checkConcept<BaseGraphComponent, _Graph>(); |
---|
[989] | 474 | graph.clear(); |
---|
| 475 | } |
---|
| 476 | |
---|
[1022] | 477 | _Graph graph; |
---|
[989] | 478 | }; |
---|
[959] | 479 | }; |
---|
| 480 | |
---|
| 481 | |
---|
[989] | 482 | /// Skeleton class for graph NodeIt and EdgeIt |
---|
| 483 | |
---|
| 484 | /// Skeleton class for graph NodeIt and EdgeIt. |
---|
[959] | 485 | /// |
---|
[989] | 486 | template <typename _Graph, typename _Item> |
---|
| 487 | class GraphIterator : public _Item { |
---|
| 488 | public: |
---|
| 489 | /// \todo Don't we need the Item type as typedef? |
---|
[959] | 490 | |
---|
[989] | 491 | /// Default constructor. |
---|
| 492 | |
---|
| 493 | /// @warning The default constructor sets the iterator |
---|
| 494 | /// to an undefined value. |
---|
| 495 | GraphIterator() {} |
---|
| 496 | /// Copy constructor. |
---|
| 497 | |
---|
| 498 | /// Copy constructor. |
---|
| 499 | /// |
---|
| 500 | GraphIterator(GraphIterator const&) {} |
---|
| 501 | /// Sets the iterator to the first item. |
---|
| 502 | |
---|
| 503 | /// Sets the iterator to the first item of \c the graph. |
---|
| 504 | /// |
---|
| 505 | explicit GraphIterator(const _Graph&) {} |
---|
| 506 | /// Invalid constructor \& conversion. |
---|
| 507 | |
---|
| 508 | /// This constructor initializes the item to be invalid. |
---|
| 509 | /// \sa Invalid for more details. |
---|
| 510 | GraphIterator(Invalid) {} |
---|
| 511 | /// Assign operator for items. |
---|
| 512 | |
---|
| 513 | /// The items are assignable. |
---|
| 514 | /// |
---|
| 515 | GraphIterator& operator=(GraphIterator const&) { return *this; } |
---|
| 516 | /// Next item. |
---|
| 517 | |
---|
| 518 | /// Assign the iterator to the next item. |
---|
| 519 | /// |
---|
| 520 | GraphIterator& operator++() { return *this; } |
---|
| 521 | // Node operator*() const { return INVALID; } |
---|
| 522 | /// Equality operator |
---|
| 523 | |
---|
| 524 | /// Two iterators are equal if and only if they point to the |
---|
| 525 | /// same object or both are invalid. |
---|
| 526 | bool operator==(const GraphIterator&) const { return true;} |
---|
| 527 | /// Inequality operator |
---|
| 528 | |
---|
| 529 | /// \sa operator==(Node n) |
---|
| 530 | /// |
---|
| 531 | bool operator!=(const GraphIterator&) const { return true;} |
---|
| 532 | |
---|
| 533 | template<typename _GraphIterator> |
---|
| 534 | struct Constraints { |
---|
| 535 | void constraints() { |
---|
| 536 | // checkConcept< Item, _GraphIterator >(); |
---|
| 537 | _GraphIterator it1(g); |
---|
| 538 | |
---|
| 539 | /// \todo Do we need NodeIt(Node) kind of constructor? |
---|
| 540 | // _GraphIterator it2(bj); |
---|
| 541 | _GraphIterator it2; |
---|
| 542 | |
---|
| 543 | it2 = ++it1; |
---|
| 544 | ++it2 = it1; |
---|
| 545 | ++(++it1); |
---|
| 546 | /// \bug This should be: is_base_and_derived<BaseItem, _GraphIterator> |
---|
| 547 | _Item bi = it1; |
---|
| 548 | bi = it2; |
---|
| 549 | } |
---|
| 550 | _Graph& g; |
---|
| 551 | }; |
---|
[959] | 552 | }; |
---|
| 553 | |
---|
[989] | 554 | /// Skeleton class for graph InEdgeIt and OutEdgeIt |
---|
[959] | 555 | |
---|
[989] | 556 | /// \note Because InEdgeIt and OutEdgeIt may not inherit from the same |
---|
| 557 | /// base class, the _selector is a additional template parameter. For |
---|
| 558 | /// InEdgeIt you should instantiate it with character 'i' and for |
---|
| 559 | /// OutEdgeIt with 'o'. |
---|
[1021] | 560 | /// \todo Is this a good name for this concept? |
---|
| 561 | template <typename Graph, |
---|
| 562 | typename Edge = typename Graph::Edge, |
---|
| 563 | char _selector = '0'> |
---|
| 564 | class GraphIncIterator : public Edge { |
---|
[989] | 565 | public: |
---|
| 566 | /// Default constructor. |
---|
| 567 | |
---|
| 568 | /// @warning The default constructor sets the iterator |
---|
| 569 | /// to an undefined value. |
---|
[1021] | 570 | GraphIncIterator() {} |
---|
[989] | 571 | /// Copy constructor. |
---|
| 572 | |
---|
| 573 | /// Copy constructor. |
---|
| 574 | /// |
---|
[1021] | 575 | GraphIncIterator(GraphIncIterator const&) {} |
---|
[1134] | 576 | /// Sets the iterator to the first edge incoming into or outgoing |
---|
| 577 | /// from the node. |
---|
[989] | 578 | |
---|
[1134] | 579 | /// Sets the iterator to the first edge incoming into or outgoing |
---|
| 580 | /// from the node. |
---|
[989] | 581 | /// |
---|
[1021] | 582 | explicit GraphIncIterator(const Graph&, const typename Graph::Node&) {} |
---|
[989] | 583 | /// Invalid constructor \& conversion. |
---|
| 584 | |
---|
| 585 | /// This constructor initializes the item to be invalid. |
---|
| 586 | /// \sa Invalid for more details. |
---|
[1021] | 587 | GraphIncIterator(Invalid) {} |
---|
[989] | 588 | /// Assign operator for nodes. |
---|
| 589 | |
---|
| 590 | /// The nodes are assignable. |
---|
| 591 | /// |
---|
[1021] | 592 | GraphIncIterator& operator=(GraphIncIterator const&) { return *this; } |
---|
[989] | 593 | /// Next edge. |
---|
| 594 | |
---|
| 595 | /// Assign the iterator to the next node. |
---|
| 596 | /// |
---|
[1021] | 597 | GraphIncIterator& operator++() { return *this; } |
---|
| 598 | |
---|
[989] | 599 | // Node operator*() const { return INVALID; } |
---|
[1021] | 600 | |
---|
[989] | 601 | /// Equality operator |
---|
| 602 | |
---|
| 603 | /// Two iterators are equal if and only if they point to the |
---|
| 604 | /// same object or both are invalid. |
---|
[1021] | 605 | bool operator==(const GraphIncIterator&) const { return true;} |
---|
| 606 | |
---|
[989] | 607 | /// Inequality operator |
---|
| 608 | |
---|
| 609 | /// \sa operator==(Node n) |
---|
| 610 | /// |
---|
[1021] | 611 | bool operator!=(const GraphIncIterator&) const { return true;} |
---|
[989] | 612 | |
---|
[1021] | 613 | template <typename _GraphIncIterator> |
---|
[989] | 614 | struct Constraints { |
---|
[1021] | 615 | typedef typename Graph::Node Node; |
---|
[989] | 616 | void constraints() { |
---|
[1021] | 617 | checkConcept<GraphItem<'e'>, _GraphIncIterator>(); |
---|
| 618 | _GraphIncIterator it1(graph, node); |
---|
[989] | 619 | /// \todo Do we need OutEdgeIt(Edge) kind of constructor? |
---|
[1021] | 620 | // _GraphIncIterator it2(edge); |
---|
| 621 | _GraphIncIterator it2; |
---|
[989] | 622 | |
---|
| 623 | it2 = ++it1; |
---|
| 624 | ++it2 = it1; |
---|
| 625 | ++(++it1); |
---|
| 626 | Edge e = it1; |
---|
| 627 | e = it2; |
---|
| 628 | } |
---|
| 629 | |
---|
| 630 | Edge& edge; |
---|
| 631 | Node& node; |
---|
[1021] | 632 | Graph& graph; |
---|
[989] | 633 | }; |
---|
| 634 | }; |
---|
[1021] | 635 | |
---|
| 636 | |
---|
[989] | 637 | /// An empty iterable base graph class. |
---|
| 638 | |
---|
| 639 | /// This class provides beside the core graph features |
---|
| 640 | /// iterator based iterable interface for the graph structure. |
---|
| 641 | /// This concept is part of the StaticGraphConcept. |
---|
| 642 | class IterableGraphComponent : virtual public BaseGraphComponent { |
---|
[959] | 643 | |
---|
| 644 | public: |
---|
| 645 | |
---|
| 646 | typedef IterableGraphComponent Graph; |
---|
| 647 | |
---|
| 648 | typedef BaseGraphComponent::Node Node; |
---|
| 649 | typedef BaseGraphComponent::Edge Edge; |
---|
| 650 | |
---|
[989] | 651 | /// This iterator goes through each node. |
---|
[959] | 652 | |
---|
[989] | 653 | /// This iterator goes through each node. |
---|
| 654 | /// |
---|
| 655 | typedef GraphIterator<Graph, Node> NodeIt; |
---|
| 656 | /// This iterator goes through each node. |
---|
[959] | 657 | |
---|
[989] | 658 | /// This iterator goes through each node. |
---|
| 659 | /// |
---|
| 660 | typedef GraphIterator<Graph, Edge> EdgeIt; |
---|
| 661 | /// This iterator goes trough the incoming edges of a node. |
---|
[959] | 662 | |
---|
[989] | 663 | /// This iterator goes trough the \e inccoming edges of a certain node |
---|
| 664 | /// of a graph. |
---|
[1021] | 665 | typedef GraphIncIterator<Graph, Edge, 'i'> InEdgeIt; |
---|
[989] | 666 | /// This iterator goes trough the outgoing edges of a node. |
---|
[959] | 667 | |
---|
[989] | 668 | /// This iterator goes trough the \e outgoing edges of a certain node |
---|
| 669 | /// of a graph. |
---|
[1021] | 670 | typedef GraphIncIterator<Graph, Edge, 'o'> OutEdgeIt; |
---|
[989] | 671 | }; |
---|
| 672 | |
---|
| 673 | template <typename _Graph> |
---|
| 674 | struct Constraints { |
---|
| 675 | void constraints() { |
---|
| 676 | checkConcept< BaseGraphComponent, _Graph>(); |
---|
[959] | 677 | |
---|
[1134] | 678 | checkConcept<GraphIterator<_Graph, typename _Graph::Edge>, |
---|
| 679 | typename _Graph::EdgeIt >(); |
---|
| 680 | checkConcept<GraphIterator<_Graph, typename _Graph::Node>, |
---|
| 681 | typename _Graph::NodeIt >(); |
---|
[1021] | 682 | checkConcept<GraphIncIterator<_Graph>, typename _Graph::InEdgeIt >(); |
---|
| 683 | checkConcept<GraphIncIterator<_Graph>, typename _Graph::OutEdgeIt >(); |
---|
[989] | 684 | } |
---|
| 685 | }; |
---|
[959] | 686 | |
---|
[1134] | 687 | /// An empty alteration notifier base graph class. |
---|
| 688 | |
---|
| 689 | /// This class provides beside the core graph features |
---|
| 690 | /// alteration notifier interface for the graph structure. |
---|
| 691 | /// This is an observer-notifier pattern. More Obsevers can |
---|
| 692 | /// be registered into the notifier and whenever an alteration |
---|
| 693 | /// occured in the graph all the observers will notified about it. |
---|
| 694 | class AlterableGraphComponent : virtual public BaseGraphComponent { |
---|
| 695 | public: |
---|
| 696 | |
---|
| 697 | /// The edge observer registry. |
---|
| 698 | typedef AlterationNotifier<Edge> EdgeNotifier; |
---|
| 699 | /// The node observer registry. |
---|
| 700 | typedef AlterationNotifier<Node> NodeNotifier; |
---|
| 701 | |
---|
| 702 | /// \brief Gives back the edge alteration notifier. |
---|
| 703 | /// |
---|
| 704 | /// Gives back the edge alteration notifier. |
---|
| 705 | EdgeNotifier getNotifier(Edge) const { |
---|
| 706 | return EdgeNotifier(); |
---|
| 707 | } |
---|
| 708 | |
---|
| 709 | /// \brief Gives back the node alteration notifier. |
---|
| 710 | /// |
---|
| 711 | /// Gives back the node alteration notifier. |
---|
| 712 | NodeNotifier getNotifier(Node) const { |
---|
| 713 | return NodeNotifier(); |
---|
| 714 | } |
---|
| 715 | |
---|
| 716 | }; |
---|
| 717 | |
---|
[959] | 718 | |
---|
[1030] | 719 | /// Class describing the concept of graph maps |
---|
| 720 | |
---|
| 721 | /// This class describes the common interface of the graph maps |
---|
[1043] | 722 | /// (NodeMap, EdgeMap), that is \ref maps-pages "maps" which can be used to |
---|
[1030] | 723 | /// associate data to graph descriptors (nodes or edges). |
---|
[989] | 724 | template <typename Graph, typename Item, typename _Value> |
---|
| 725 | class GraphMap : public ReadWriteMap<Item, _Value> { |
---|
| 726 | protected: |
---|
| 727 | GraphMap() {} |
---|
| 728 | public: |
---|
[1134] | 729 | /// \brief Construct a new map. |
---|
| 730 | /// |
---|
| 731 | /// Construct a new map for the graph. |
---|
[989] | 732 | explicit GraphMap(const Graph&) {} |
---|
[1134] | 733 | /// \brief Construct a new map with default value. |
---|
| 734 | /// |
---|
| 735 | /// Construct a new map for the graph and initalise the values. |
---|
[989] | 736 | GraphMap(const Graph&, const _Value&) {} |
---|
[1134] | 737 | /// \brief Copy constructor. |
---|
| 738 | /// |
---|
| 739 | /// Copy Constructor. |
---|
[989] | 740 | GraphMap(const GraphMap&) {} |
---|
| 741 | |
---|
[1134] | 742 | /// \brief Assign operator. |
---|
| 743 | /// |
---|
| 744 | /// Assign operator. |
---|
[989] | 745 | GraphMap& operator=(const GraphMap&) { return *this;} |
---|
[959] | 746 | |
---|
[989] | 747 | template<typename _Map> |
---|
| 748 | struct Constraints { |
---|
| 749 | void constraints() { |
---|
| 750 | checkConcept<ReadWriteMap<Item, _Value>, _Map >(); |
---|
| 751 | // Construction with a graph parameter |
---|
| 752 | _Map a(g); |
---|
| 753 | // Constructor with a graph and a default value parameter |
---|
| 754 | _Map a2(g,t); |
---|
| 755 | // Copy constructor. Do we need it? |
---|
| 756 | _Map b=c; |
---|
| 757 | // Copy operator. Do we need it? |
---|
| 758 | a=b; |
---|
[959] | 759 | |
---|
[989] | 760 | ignore_unused_variable_warning(a2); |
---|
| 761 | } |
---|
[959] | 762 | |
---|
[989] | 763 | const _Map &c; |
---|
| 764 | const Graph &g; |
---|
| 765 | const typename GraphMap::Value &t; |
---|
[959] | 766 | }; |
---|
| 767 | |
---|
| 768 | }; |
---|
[961] | 769 | |
---|
[989] | 770 | /// An empty mappable base graph class. |
---|
[959] | 771 | |
---|
[989] | 772 | /// This class provides beside the core graph features |
---|
| 773 | /// map interface for the graph structure. |
---|
| 774 | /// This concept is part of the StaticGraphConcept. |
---|
[959] | 775 | class MappableGraphComponent : virtual public BaseGraphComponent { |
---|
| 776 | public: |
---|
| 777 | |
---|
| 778 | typedef MappableGraphComponent Graph; |
---|
| 779 | |
---|
| 780 | typedef BaseGraphComponent::Node Node; |
---|
| 781 | typedef BaseGraphComponent::Edge Edge; |
---|
| 782 | |
---|
[989] | 783 | /// ReadWrite map of the nodes. |
---|
| 784 | |
---|
| 785 | /// ReadWrite map of the nodes. |
---|
| 786 | /// |
---|
[987] | 787 | template <typename _Value> |
---|
[989] | 788 | class NodeMap : public GraphMap<Graph, Node, _Value> { |
---|
| 789 | private: |
---|
| 790 | NodeMap(); |
---|
[959] | 791 | public: |
---|
[1134] | 792 | /// \brief Construct a new map. |
---|
| 793 | /// |
---|
| 794 | /// Construct a new map for the graph. |
---|
| 795 | /// \todo call the right parent class constructor |
---|
[989] | 796 | explicit NodeMap(const Graph&) {} |
---|
[1134] | 797 | /// \brief Construct a new map with default value. |
---|
| 798 | /// |
---|
| 799 | /// Construct a new map for the graph and initalise the values. |
---|
[987] | 800 | NodeMap(const Graph&, const _Value&) {} |
---|
[1134] | 801 | /// \brief Copy constructor. |
---|
| 802 | /// |
---|
| 803 | /// Copy Constructor. |
---|
[959] | 804 | NodeMap(const NodeMap&) {} |
---|
| 805 | |
---|
[1134] | 806 | /// \brief Assign operator. |
---|
| 807 | /// |
---|
| 808 | /// Assign operator. |
---|
[959] | 809 | NodeMap& operator=(const NodeMap&) { return *this;} |
---|
[989] | 810 | |
---|
[959] | 811 | }; |
---|
| 812 | |
---|
[989] | 813 | /// ReadWrite map of the edges. |
---|
| 814 | |
---|
| 815 | /// ReadWrite map of the edges. |
---|
| 816 | /// |
---|
[987] | 817 | template <typename _Value> |
---|
[989] | 818 | class EdgeMap : public GraphMap<Graph, Edge, _Value> { |
---|
| 819 | private: |
---|
| 820 | EdgeMap(); |
---|
[959] | 821 | public: |
---|
[1134] | 822 | /// \brief Construct a new map. |
---|
| 823 | /// |
---|
| 824 | /// Construct a new map for the graph. |
---|
| 825 | /// \todo call the right parent class constructor |
---|
[989] | 826 | explicit EdgeMap(const Graph&) {} |
---|
[1134] | 827 | /// \brief Construct a new map with default value. |
---|
| 828 | /// |
---|
| 829 | /// Construct a new map for the graph and initalise the values. |
---|
[987] | 830 | EdgeMap(const Graph&, const _Value&) {} |
---|
[1134] | 831 | /// \brief Copy constructor. |
---|
| 832 | /// |
---|
| 833 | /// Copy Constructor. |
---|
[959] | 834 | EdgeMap(const EdgeMap&) {} |
---|
| 835 | |
---|
[1134] | 836 | /// \brief Assign operator. |
---|
| 837 | /// |
---|
| 838 | /// Assign operator. |
---|
[959] | 839 | EdgeMap& operator=(const EdgeMap&) { return *this;} |
---|
[989] | 840 | |
---|
[959] | 841 | }; |
---|
| 842 | |
---|
[989] | 843 | template <typename _Graph> |
---|
| 844 | struct Constraints { |
---|
[959] | 845 | |
---|
[989] | 846 | struct Type { |
---|
| 847 | int value; |
---|
| 848 | Type() : value(0) {} |
---|
| 849 | Type(int _v) : value(_v) {} |
---|
| 850 | }; |
---|
[959] | 851 | |
---|
[989] | 852 | void constraints() { |
---|
| 853 | checkConcept<BaseGraphComponent, _Graph>(); |
---|
| 854 | { // int map test |
---|
| 855 | typedef typename _Graph::template NodeMap<int> IntNodeMap; |
---|
[1134] | 856 | checkConcept<GraphMap<_Graph, typename _Graph::Node, int>, |
---|
| 857 | IntNodeMap >(); |
---|
[989] | 858 | } { // bool map test |
---|
| 859 | typedef typename _Graph::template NodeMap<bool> BoolNodeMap; |
---|
[1134] | 860 | checkConcept<GraphMap<_Graph, typename _Graph::Node, bool>, |
---|
| 861 | BoolNodeMap >(); |
---|
[989] | 862 | } { // Type map test |
---|
| 863 | typedef typename _Graph::template NodeMap<Type> TypeNodeMap; |
---|
[1134] | 864 | checkConcept<GraphMap<_Graph, typename _Graph::Node, Type>, |
---|
| 865 | TypeNodeMap >(); |
---|
[989] | 866 | } |
---|
| 867 | |
---|
| 868 | { // int map test |
---|
| 869 | typedef typename _Graph::template EdgeMap<int> IntEdgeMap; |
---|
[1134] | 870 | checkConcept<GraphMap<_Graph, typename _Graph::Edge, int>, |
---|
| 871 | IntEdgeMap >(); |
---|
[989] | 872 | } { // bool map test |
---|
| 873 | typedef typename _Graph::template EdgeMap<bool> BoolEdgeMap; |
---|
[1134] | 874 | checkConcept<GraphMap<_Graph, typename _Graph::Edge, bool>, |
---|
| 875 | BoolEdgeMap >(); |
---|
[989] | 876 | } { // Type map test |
---|
| 877 | typedef typename _Graph::template EdgeMap<Type> TypeEdgeMap; |
---|
[1134] | 878 | checkConcept<GraphMap<_Graph, typename _Graph::Edge, Type>, |
---|
| 879 | TypeEdgeMap >(); |
---|
[989] | 880 | } |
---|
| 881 | } |
---|
| 882 | |
---|
| 883 | _Graph& graph; |
---|
[959] | 884 | }; |
---|
| 885 | }; |
---|
| 886 | |
---|
[1134] | 887 | /// \brief An empty extendable extended graph class. |
---|
| 888 | /// |
---|
| 889 | /// This class provides beside the core graph features |
---|
| 890 | /// item addition interface for the graph structure. |
---|
| 891 | /// The difference between this class and the |
---|
| 892 | /// \c BaseExtendableGraphComponent is that it should |
---|
| 893 | /// notify the item alteration observers. |
---|
[959] | 894 | class ExtendableGraphComponent : virtual public BaseGraphComponent { |
---|
| 895 | public: |
---|
| 896 | |
---|
| 897 | typedef ExtendableGraphComponent Graph; |
---|
| 898 | |
---|
| 899 | typedef BaseGraphComponent::Node Node; |
---|
| 900 | typedef BaseGraphComponent::Edge Edge; |
---|
| 901 | |
---|
[1134] | 902 | /// \brief Add a node to the graph. |
---|
| 903 | /// |
---|
| 904 | /// Add a node to the graph and notify the observers. |
---|
[959] | 905 | Node addNode() { |
---|
| 906 | return INVALID; |
---|
| 907 | } |
---|
| 908 | |
---|
[1134] | 909 | /// \brief Add an edge to the graph. |
---|
| 910 | /// |
---|
| 911 | /// Add an edge to the graph and notify the observers. |
---|
[959] | 912 | Edge addEdge(const Node& from, const Node& to) { |
---|
| 913 | return INVALID; |
---|
| 914 | } |
---|
| 915 | |
---|
[989] | 916 | template <typename _Graph> |
---|
| 917 | struct Constraints { |
---|
| 918 | void constraints() { |
---|
| 919 | checkConcept<BaseGraphComponent, _Graph >(); |
---|
| 920 | typename _Graph::Node node_a, node_b; |
---|
| 921 | node_a = graph.addNode(); |
---|
| 922 | typename _Graph::Edge edge; |
---|
| 923 | edge = graph.addEdge(node_a, node_b); |
---|
| 924 | } |
---|
| 925 | _Graph& graph; |
---|
| 926 | }; |
---|
[959] | 927 | }; |
---|
[1134] | 928 | |
---|
| 929 | /// \brief An empty erasable extended graph class. |
---|
| 930 | /// |
---|
| 931 | /// This class provides beside the core graph features |
---|
| 932 | /// item erase interface for the graph structure. |
---|
| 933 | /// The difference between this class and the |
---|
| 934 | /// \c BaseErasableGraphComponent is that it should |
---|
| 935 | /// notify the item alteration observers. |
---|
[959] | 936 | class ErasableGraphComponent : virtual public BaseGraphComponent { |
---|
| 937 | public: |
---|
| 938 | |
---|
| 939 | typedef ErasableGraphComponent Graph; |
---|
| 940 | |
---|
| 941 | typedef BaseGraphComponent::Node Node; |
---|
| 942 | typedef BaseGraphComponent::Edge Edge; |
---|
| 943 | |
---|
[1134] | 944 | /// \brief Erase the Node and notify the node alteration observers. |
---|
| 945 | /// |
---|
| 946 | /// Erase the Node and notify the node alteration observers. |
---|
[959] | 947 | void erase(const Node&) {} |
---|
[1134] | 948 | |
---|
| 949 | /// \brief Erase the Edge and notify the edge alteration observers. |
---|
| 950 | /// |
---|
| 951 | /// Erase the Edge and notify the edge alteration observers. |
---|
[959] | 952 | void erase(const Edge&) {} |
---|
| 953 | |
---|
[989] | 954 | template <typename _Graph> |
---|
| 955 | struct Constraints { |
---|
| 956 | void constraints() { |
---|
| 957 | checkConcept<BaseGraphComponent, _Graph >(); |
---|
| 958 | typename _Graph::Node node; |
---|
| 959 | graph.erase(node); |
---|
| 960 | typename _Graph::Edge edge; |
---|
| 961 | graph.erase(edge); |
---|
| 962 | } |
---|
[959] | 963 | |
---|
[989] | 964 | _Graph& graph; |
---|
| 965 | }; |
---|
[959] | 966 | }; |
---|
| 967 | |
---|
[1030] | 968 | /// @} |
---|
| 969 | |
---|
[959] | 970 | } |
---|
| 971 | |
---|
| 972 | } |
---|
| 973 | |
---|
| 974 | #endif |
---|