Changes in lemon/concepts/graph_components.h [1125:b873350e6258:1126:a30455cd0107] in lemon
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
lemon/concepts/graph_components.h
r1125 r1126 3 3 * This file is a part of LEMON, a generic C++ optimization library. 4 4 * 5 * Copyright (C) 2003-20 095 * Copyright (C) 2003-2011 6 6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport 7 7 * (Egervary Research Group on Combinatorial Optimization, EGRES). … … 39 39 /// \note This class is a template class so that we can use it to 40 40 /// create graph skeleton classes. The reason for this is that \c Node 41 /// and \c Arc (or \c Edge) types should \e not derive from the same 41 /// and \c Arc (or \c Edge) types should \e not derive from the same 42 42 /// base class. For \c Node you should instantiate it with character 43 43 /// \c 'n', for \c Arc with \c 'a' and for \c Edge with \c 'e'. … … 90 90 /// 91 91 /// This operator defines an ordering of the items. 92 /// It makes possible to use graph item types as key types in 92 /// It makes possible to use graph item types as key types in 93 93 /// associative containers (e.g. \c std::map). 94 94 /// … … 124 124 /// This class describes the base interface of directed graph types. 125 125 /// All digraph %concepts have to conform to this class. 126 /// It just provides types for nodes and arcs and functions 126 /// It just provides types for nodes and arcs and functions 127 127 /// to get the source and the target nodes of arcs. 128 128 class BaseDigraphComponent { … … 432 432 /// \brief Concept class for \c NodeIt, \c ArcIt and \c EdgeIt types. 433 433 /// 434 /// This class describes the concept of \c NodeIt, \c ArcIt and 434 /// This class describes the concept of \c NodeIt, \c ArcIt and 435 435 /// \c EdgeIt subtypes of digraph and graph types. 436 436 template <typename GR, typename Item> … … 472 472 /// next item. 473 473 GraphItemIt& operator++() { return *this; } 474 474 475 475 /// \brief Equality operator 476 476 /// … … 508 508 }; 509 509 510 /// \brief Concept class for \c InArcIt, \c OutArcIt and 510 /// \brief Concept class for \c InArcIt, \c OutArcIt and 511 511 /// \c IncEdgeIt types. 512 512 /// 513 /// This class describes the concept of \c InArcIt, \c OutArcIt 513 /// This class describes the concept of \c InArcIt, \c OutArcIt 514 514 /// and \c IncEdgeIt subtypes of digraph and graph types. 515 515 /// 516 516 /// \note Since these iterator classes do not inherit from the same 517 517 /// base class, there is an additional template parameter (selector) 518 /// \c sel. For \c InArcIt you should instantiate it with character 518 /// \c sel. For \c InArcIt you should instantiate it with character 519 519 /// \c 'i', for \c OutArcIt with \c 'o' and for \c IncEdgeIt with \c 'e'. 520 520 template <typename GR, … … 537 537 GraphIncIt(const GraphIncIt& it) : Item(it) {} 538 538 539 /// \brief Constructor that sets the iterator to the first 539 /// \brief Constructor that sets the iterator to the first 540 540 /// incoming or outgoing arc. 541 541 /// 542 /// Constructor that sets the iterator to the first arc 542 /// Constructor that sets the iterator to the first arc 543 543 /// incoming to or outgoing from the given node. 544 544 explicit GraphIncIt(const GR&, const Base&) {} … … 813 813 /// \brief Return the first edge incident to the given node. 814 814 /// 815 /// This function gives back the first edge incident to the given 815 /// This function gives back the first edge incident to the given 816 816 /// node. The bool parameter gives back the direction for which the 817 /// source node of the directed arc representing the edge is the 817 /// source node of the directed arc representing the edge is the 818 818 /// given node. 819 819 void firstInc(Edge&, bool&, const Node&) const {} … … 822 822 /// given node. 823 823 /// 824 /// This function gives back the next edge incident to the given 824 /// This function gives back the next edge incident to the given 825 825 /// node. The bool parameter should be used as \c firstInc() use it. 826 826 void nextInc(Edge&, bool&) const {} … … 1002 1002 /// 1003 1003 /// This class describes the concept of standard graph maps, i.e. 1004 /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and 1004 /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and 1005 1005 /// graph types, which can be used for associating data to graph items. 1006 1006 /// The standard graph maps must conform to the ReferenceMap concept. … … 1057 1057 _Map m1(g); 1058 1058 _Map m2(g,t); 1059 1059 1060 1060 // Copy constructor 1061 1061 // _Map m3(m); … … 1081 1081 /// 1082 1082 /// This class describes the interface of mappable directed graphs. 1083 /// It extends \ref BaseDigraphComponent with the standard digraph 1083 /// It extends \ref BaseDigraphComponent with the standard digraph 1084 1084 /// map classes, namely \c NodeMap and \c ArcMap. 1085 1085 /// This concept is part of the Digraph concept. … … 1219 1219 /// 1220 1220 /// This class describes the interface of mappable undirected graphs. 1221 /// It extends \ref MappableDigraphComponent with the standard graph 1221 /// It extends \ref MappableDigraphComponent with the standard graph 1222 1222 /// map class for edges (\c EdgeMap). 1223 1223 /// This concept is part of the Graph concept. … … 1305 1305 /// 1306 1306 /// This class describes the interface of extendable directed graphs. 1307 /// It extends \ref BaseDigraphComponent with functions for adding 1307 /// It extends \ref BaseDigraphComponent with functions for adding 1308 1308 /// nodes and arcs to the digraph. 1309 1309 /// This concept requires \ref AlterableDigraphComponent. … … 1350 1350 /// 1351 1351 /// This class describes the interface of extendable undirected graphs. 1352 /// It extends \ref BaseGraphComponent with functions for adding 1352 /// It extends \ref BaseGraphComponent with functions for adding 1353 1353 /// nodes and edges to the graph. 1354 1354 /// This concept requires \ref AlterableGraphComponent. … … 1395 1395 /// 1396 1396 /// This class describes the interface of erasable directed graphs. 1397 /// It extends \ref BaseDigraphComponent with functions for removing 1397 /// It extends \ref BaseDigraphComponent with functions for removing 1398 1398 /// nodes and arcs from the digraph. 1399 1399 /// This concept requires \ref AlterableDigraphComponent. … … 1408 1408 /// \brief Erase a node from the digraph. 1409 1409 /// 1410 /// This function erases the given node from the digraph and all arcs 1410 /// This function erases the given node from the digraph and all arcs 1411 1411 /// connected to the node. 1412 1412 void erase(const Node&) {} … … 1435 1435 /// 1436 1436 /// This class describes the interface of erasable undirected graphs. 1437 /// It extends \ref BaseGraphComponent with functions for removing 1437 /// It extends \ref BaseGraphComponent with functions for removing 1438 1438 /// nodes and edges from the graph. 1439 1439 /// This concept requires \ref AlterableGraphComponent.
Note: See TracChangeset
for help on using the changeset viewer.