COIN-OR::LEMON - Graph Library

Ignore:
Timestamp:
04/14/09 10:33:17 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Various improvements and fixes (mainly in the doc) (#190)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/concepts/graph_components.h

    r606 r626  
    3232  namespace concepts {
    3333
    34     /// \brief Skeleton class for graph Node and Arc types
    35     ///
    36     /// This class describes the interface of Node and Arc (and Edge
    37     /// in undirected graphs) subtypes of graph types.
     34    /// \brief Concept class for \c Node, \c Arc and \c Edge types.
     35    ///
     36    /// This class describes the concept of \c Node, \c Arc and \c Edge
     37    /// subtypes of digraph and graph types.
    3838    ///
    3939    /// \note This class is a template class so that we can use it to
    40     /// create graph skeleton classes. The reason for this is than Node
    41     /// and Arc types should \em not derive from the same base class.
    42     /// For Node you should instantiate it with character 'n' and for Arc
    43     /// with 'a'.
    44 
     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
     42    /// base class. For \c Node you should instantiate it with character
     43    /// \c 'n', for \c Arc with \c 'a' and for \c Edge with \c 'e'.
    4544#ifndef DOXYGEN
    4645    template <char sel = '0'>
     
    5049      /// \brief Default constructor.
    5150      ///
     51      /// Default constructor.
    5252      /// \warning The default constructor is not required to set
    5353      /// the item to some well-defined value. So you should consider it
    5454      /// as uninitialized.
    5555      GraphItem() {}
     56
    5657      /// \brief Copy constructor.
    5758      ///
    5859      /// Copy constructor.
    59       ///
    6060      GraphItem(const GraphItem &) {}
    61       /// \brief Invalid constructor \& conversion.
    62       ///
    63       /// This constructor initializes the item to be invalid.
     61
     62      /// \brief Constructor for conversion from \c INVALID.
     63      ///
     64      /// Constructor for conversion from \c INVALID.
     65      /// It initializes the item to be invalid.
    6466      /// \sa Invalid for more details.
    6567      GraphItem(Invalid) {}
    66       /// \brief Assign operator for nodes.
    67       ///
    68       /// The nodes are assignable.
    69       ///
    70       GraphItem& operator=(GraphItem const&) { return *this; }
     68
     69      /// \brief Assignment operator.
     70      ///
     71      /// Assignment operator for the item.
     72      GraphItem& operator=(const GraphItem&) { return *this; }
     73
    7174      /// \brief Equality operator.
    7275      ///
    73       /// Two iterators are equal if and only if they represents the
    74       /// same node in the graph or both are invalid.
    75       bool operator==(GraphItem) const { return false; }
     76      /// Equality operator.
     77      bool operator==(const GraphItem&) const { return false; }
     78
    7679      /// \brief Inequality operator.
    7780      ///
    78       /// \sa operator==(const Node& n)
    79       ///
    80       bool operator!=(GraphItem) const { return false; }
    81 
    82       /// \brief Artificial ordering operator.
    83       ///
    84       /// To allow the use of graph descriptors as key type in std::map or
    85       /// similar associative container we require this.
     81      /// Inequality operator.
     82      bool operator!=(const GraphItem&) const { return false; }
     83
     84      /// \brief Ordering operator.
     85      ///
     86      /// This operator defines an ordering of the items.
     87      /// It makes possible to use graph item types as key types in
     88      /// associative containers (e.g. \c std::map).
    8689      ///
    8790      /// \note This operator only have to define some strict ordering of
    8891      /// the items; this order has nothing to do with the iteration
    8992      /// ordering of the items.
    90       bool operator<(GraphItem) const { return false; }
     93      bool operator<(const GraphItem&) const { return false; }
    9194
    9295      template<typename _GraphItem>
     
    100103
    101104          bool b;
    102           //          b = (ia == ib) && (ia != ib) && (ia < ib);
    103105          b = (ia == ib) && (ia != ib);
    104106          b = (ia == INVALID) && (ib != INVALID);
     
    111113    };
    112114
    113     /// \brief An empty base directed graph class.
    114     ///
    115     /// This class provides the minimal set of features needed for a
    116     /// directed graph structure. All digraph concepts have to
    117     /// conform to this base directed graph. It just provides types
    118     /// for nodes and arcs and functions to get the source and the
    119     /// target of the arcs.
     115    /// \brief Base skeleton class for directed graphs.
     116    ///
     117    /// This class describes the base interface of directed graph types.
     118    /// All digraph %concepts have to conform to this class.
     119    /// It just provides types for nodes and arcs and functions
     120    /// to get the source and the target nodes of arcs.
    120121    class BaseDigraphComponent {
    121122    public:
     
    125126      /// \brief Node class of the digraph.
    126127      ///
    127       /// This class represents the Nodes of the digraph.
    128       ///
     128      /// This class represents the nodes of the digraph.
    129129      typedef GraphItem<'n'> Node;
    130130
    131131      /// \brief Arc class of the digraph.
    132132      ///
    133       /// This class represents the Arcs of the digraph.
    134       ///
    135       typedef GraphItem<'e'> Arc;
    136 
    137       /// \brief Gives back the target node of an arc.
    138       ///
    139       /// Gives back the target node of an arc.
    140       ///
    141       Node target(const Arc&) const { return INVALID;}
    142 
    143       /// \brief Gives back the source node of an arc.
    144       ///
    145       /// Gives back the source node of an arc.
    146       ///
    147       Node source(const Arc&) const { return INVALID;}
    148 
    149       /// \brief Gives back the opposite node on the given arc.
    150       ///
    151       /// Gives back the opposite node on the given arc.
     133      /// This class represents the arcs of the digraph.
     134      typedef GraphItem<'a'> Arc;
     135
     136      /// \brief Return the source node of an arc.
     137      ///
     138      /// This function returns the source node of an arc.
     139      Node source(const Arc&) const { return INVALID; }
     140
     141      /// \brief Return the target node of an arc.
     142      ///
     143      /// This function returns the target node of an arc.
     144      Node target(const Arc&) const { return INVALID; }
     145
     146      /// \brief Return the opposite node on the given arc.
     147      ///
     148      /// This function returns the opposite node on the given arc.
    152149      Node oppositeNode(const Node&, const Arc&) const {
    153150        return INVALID;
     
    175172    };
    176173
    177     /// \brief An empty base undirected graph class.
    178     ///
    179     /// This class provides the minimal set of features needed for an
    180     /// undirected graph structure. All undirected graph concepts have
    181     /// to conform to this base graph. It just provides types for
    182     /// nodes, arcs and edges and functions to get the
    183     /// source and the target of the arcs and edges,
    184     /// conversion from arcs to edges and function to get
    185     /// both direction of the edges.
     174    /// \brief Base skeleton class for undirected graphs.
     175    ///
     176    /// This class describes the base interface of undirected graph types.
     177    /// All graph %concepts have to conform to this class.
     178    /// It extends the interface of \ref BaseDigraphComponent with an
     179    /// \c Edge type and functions to get the end nodes of edges,
     180    /// to convert from arcs to edges and to get both direction of edges.
    186181    class BaseGraphComponent : public BaseDigraphComponent {
    187182    public:
    188183      typedef BaseDigraphComponent::Node Node;
    189184      typedef BaseDigraphComponent::Arc Arc;
    190       /// \brief Undirected arc class of the graph.
    191       ///
    192       /// This class represents the edges of the graph.
    193       /// The undirected graphs can be used as a directed graph which
    194       /// for each arc contains the opposite arc too so the graph is
    195       /// bidirected. The edge represents two opposite
    196       /// directed arcs.
    197       class Edge : public GraphItem<'u'> {
     185
     186      /// \brief Undirected edge class of the graph.
     187      ///
     188      /// This class represents the undirected edges of the graph.
     189      /// Undirected graphs can be used as directed graphs, each edge is
     190      /// represented by two opposite directed arcs.
     191      class Edge : public GraphItem<'e'> {
    198192      public:
    199         typedef GraphItem<'u'> Parent;
     193        typedef GraphItem<'e'> Parent;
     194
    200195        /// \brief Default constructor.
    201196        ///
     197        /// Default constructor.
    202198        /// \warning The default constructor is not required to set
    203199        /// the item to some well-defined value. So you should consider it
    204200        /// as uninitialized.
    205201        Edge() {}
     202
    206203        /// \brief Copy constructor.
    207204        ///
    208205        /// Copy constructor.
    209         ///
    210206        Edge(const Edge &) : Parent() {}
    211         /// \brief Invalid constructor \& conversion.
    212         ///
    213         /// This constructor initializes the item to be invalid.
     207
     208        /// \brief Constructor for conversion from \c INVALID.
     209        ///
     210        /// Constructor for conversion from \c INVALID.
     211        /// It initializes the item to be invalid.
    214212        /// \sa Invalid for more details.
    215213        Edge(Invalid) {}
    216         /// \brief Converter from arc to edge.
    217         ///
     214
     215        /// \brief Constructor for conversion from an arc.
     216        ///
     217        /// Constructor for conversion from an arc.
    218218        /// Besides the core graph item functionality each arc should
    219219        /// be convertible to the represented edge.
    220220        Edge(const Arc&) {}
    221         /// \brief Assign arc to edge.
    222         ///
     221
     222        /// \brief Assign an arc to an edge.
     223        ///
     224        /// This function assigns an arc to an edge.
    223225        /// Besides the core graph item functionality each arc should
    224226        /// be convertible to the represented edge.
     
    226228      };
    227229
    228       /// \brief Returns the direction of the arc.
     230      /// \brief Return one end node of an edge.
     231      ///
     232      /// This function returns one end node of an edge.
     233      Node u(const Edge&) const { return INVALID; }
     234
     235      /// \brief Return the other end node of an edge.
     236      ///
     237      /// This function returns the other end node of an edge.
     238      Node v(const Edge&) const { return INVALID; }
     239
     240      /// \brief Return a directed arc related to an edge.
     241      ///
     242      /// This function returns a directed arc from its direction and the
     243      /// represented edge.
     244      Arc direct(const Edge&, bool) const { return INVALID; }
     245
     246      /// \brief Return a directed arc related to an edge.
     247      ///
     248      /// This function returns a directed arc from its source node and the
     249      /// represented edge.
     250      Arc direct(const Edge&, const Node&) const { return INVALID; }
     251
     252      /// \brief Return the direction of the arc.
    229253      ///
    230254      /// Returns the direction of the arc. Each arc represents an
     
    233257      bool direction(const Arc&) const { return true; }
    234258
    235       /// \brief Returns the directed arc.
    236       ///
    237       /// Returns the directed arc from its direction and the
    238       /// represented edge.
    239       Arc direct(const Edge&, bool) const { return INVALID;}
    240 
    241       /// \brief Returns the directed arc.
    242       ///
    243       /// Returns the directed arc from its source and the
    244       /// represented edge.
    245       Arc direct(const Edge&, const Node&) const { return INVALID;}
    246 
    247       /// \brief Returns the opposite arc.
    248       ///
    249       /// Returns the opposite arc. It is the arc representing the
    250       /// same edge and has opposite direction.
    251       Arc oppositeArc(const Arc&) const { return INVALID;}
    252 
    253       /// \brief Gives back one ending of an edge.
    254       ///
    255       /// Gives back one ending of an edge.
    256       Node u(const Edge&) const { return INVALID;}
    257 
    258       /// \brief Gives back the other ending of an edge.
    259       ///
    260       /// Gives back the other ending of an edge.
    261       Node v(const Edge&) const { return INVALID;}
     259      /// \brief Return the opposite arc.
     260      ///
     261      /// This function returns the opposite arc, i.e. the arc representing
     262      /// the same edge and has opposite direction.
     263      Arc oppositeArc(const Arc&) const { return INVALID; }
    262264
    263265      template <typename _Graph>
     
    269271        void constraints() {
    270272          checkConcept<BaseDigraphComponent, _Graph>();
    271           checkConcept<GraphItem<'u'>, Edge>();
     273          checkConcept<GraphItem<'e'>, Edge>();
    272274          {
    273275            Node n;
     
    277279            n = graph.v(ue);
    278280            e = graph.direct(ue, true);
     281            e = graph.direct(ue, false);
    279282            e = graph.direct(ue, n);
    280283            e = graph.oppositeArc(e);
     
    290293    };
    291294
    292     /// \brief An empty idable base digraph class.
    293     ///
    294     /// This class provides beside the core digraph features
    295     /// core id functions for the digraph structure.
    296     /// The most of the base digraphs should conform to this concept.
    297     /// The id's are unique and immutable.
     295    /// \brief Skeleton class for \e idable directed graphs.
     296    ///
     297    /// This class describes the interface of \e idable directed graphs.
     298    /// It extends \ref BaseDigraphComponent with the core ID functions.
     299    /// The ids of the items must be unique and immutable.
     300    /// This concept is part of the Digraph concept.
    298301    template <typename BAS = BaseDigraphComponent>
    299302    class IDableDigraphComponent : public BAS {
     
    304307      typedef typename Base::Arc Arc;
    305308
    306       /// \brief Gives back an unique integer id for the Node.
    307       ///
    308       /// Gives back an unique integer id for the Node.
    309       ///
    310       int id(const Node&) const { return -1;}
    311 
    312       /// \brief Gives back the node by the unique id.
    313       ///
    314       /// Gives back the node by the unique id.
    315       /// If the digraph does not contain node with the given id
    316       /// then the result of the function is undetermined.
    317       Node nodeFromId(int) const { return INVALID;}
    318 
    319       /// \brief Gives back an unique integer id for the Arc.
    320       ///
    321       /// Gives back an unique integer id for the Arc.
    322       ///
    323       int id(const Arc&) const { return -1;}
    324 
    325       /// \brief Gives back the arc by the unique id.
    326       ///
    327       /// Gives back the arc by the unique id.
    328       /// If the digraph does not contain arc with the given id
    329       /// then the result of the function is undetermined.
    330       Arc arcFromId(int) const { return INVALID;}
    331 
    332       /// \brief Gives back an integer greater or equal to the maximum
    333       /// Node id.
    334       ///
    335       /// Gives back an integer greater or equal to the maximum Node
    336       /// id.
    337       int maxNodeId() const { return -1;}
    338 
    339       /// \brief Gives back an integer greater or equal to the maximum
    340       /// Arc id.
    341       ///
    342       /// Gives back an integer greater or equal to the maximum Arc
    343       /// id.
    344       int maxArcId() const { return -1;}
     309      /// \brief Return a unique integer id for the given node.
     310      ///
     311      /// This function returns a unique integer id for the given node.
     312      int id(const Node&) const { return -1; }
     313
     314      /// \brief Return the node by its unique id.
     315      ///
     316      /// This function returns the node by its unique id.
     317      /// If the digraph does not contain a node with the given id,
     318      /// then the result of the function is undefined.
     319      Node nodeFromId(int) const { return INVALID; }
     320
     321      /// \brief Return a unique integer id for the given arc.
     322      ///
     323      /// This function returns a unique integer id for the given arc.
     324      int id(const Arc&) const { return -1; }
     325
     326      /// \brief Return the arc by its unique id.
     327      ///
     328      /// This function returns the arc by its unique id.
     329      /// If the digraph does not contain an arc with the given id,
     330      /// then the result of the function is undefined.
     331      Arc arcFromId(int) const { return INVALID; }
     332
     333      /// \brief Return an integer greater or equal to the maximum
     334      /// node id.
     335      ///
     336      /// This function returns an integer greater or equal to the
     337      /// maximum node id.
     338      int maxNodeId() const { return -1; }
     339
     340      /// \brief Return an integer greater or equal to the maximum
     341      /// arc id.
     342      ///
     343      /// This function returns an integer greater or equal to the
     344      /// maximum arc id.
     345      int maxArcId() const { return -1; }
    345346
    346347      template <typename _Digraph>
     
    368369    };
    369370
    370     /// \brief An empty idable base undirected graph class.
    371     ///
    372     /// This class provides beside the core undirected graph features
    373     /// core id functions for the undirected graph structure.  The
    374     /// most of the base undirected graphs should conform to this
    375     /// concept.  The id's are unique and immutable.
     371    /// \brief Skeleton class for \e idable undirected graphs.
     372    ///
     373    /// This class describes the interface of \e idable undirected
     374    /// graphs. It extends \ref IDableDigraphComponent with the core ID
     375    /// functions of undirected graphs.
     376    /// The ids of the items must be unique and immutable.
     377    /// This concept is part of the Graph concept.
    376378    template <typename BAS = BaseGraphComponent>
    377379    class IDableGraphComponent : public IDableDigraphComponent<BAS> {
     
    383385      using IDableDigraphComponent<Base>::id;
    384386
    385       /// \brief Gives back an unique integer id for the Edge.
    386       ///
    387       /// Gives back an unique integer id for the Edge.
    388       ///
    389       int id(const Edge&) const { return -1;}
    390 
    391       /// \brief Gives back the edge by the unique id.
    392       ///
    393       /// Gives back the edge by the unique id.  If the
    394       /// graph does not contain arc with the given id then the
    395       /// result of the function is undetermined.
    396       Edge edgeFromId(int) const { return INVALID;}
    397 
    398       /// \brief Gives back an integer greater or equal to the maximum
    399       /// Edge id.
    400       ///
    401       /// Gives back an integer greater or equal to the maximum Edge
    402       /// id.
    403       int maxEdgeId() const { return -1;}
     387      /// \brief Return a unique integer id for the given edge.
     388      ///
     389      /// This function returns a unique integer id for the given edge.
     390      int id(const Edge&) const { return -1; }
     391
     392      /// \brief Return the edge by its unique id.
     393      ///
     394      /// This function returns the edge by its unique id.
     395      /// If the graph does not contain an edge with the given id,
     396      /// then the result of the function is undefined.
     397      Edge edgeFromId(int) const { return INVALID; }
     398
     399      /// \brief Return an integer greater or equal to the maximum
     400      /// edge id.
     401      ///
     402      /// This function returns an integer greater or equal to the
     403      /// maximum edge id.
     404      int maxEdgeId() const { return -1; }
    404405
    405406      template <typename _Graph>
     
    407408
    408409        void constraints() {
    409           checkConcept<Base, _Graph >();
    410410          checkConcept<IDableDigraphComponent<Base>, _Graph >();
    411411          typename _Graph::Edge edge;
     
    421421    };
    422422
    423     /// \brief Skeleton class for graph NodeIt and ArcIt
    424     ///
    425     /// Skeleton class for graph NodeIt and ArcIt.
    426     ///
     423    /// \brief Concept class for \c NodeIt, \c ArcIt and \c EdgeIt types.
     424    ///
     425    /// This class describes the concept of \c NodeIt, \c ArcIt and
     426    /// \c EdgeIt subtypes of digraph and graph types.
    427427    template <typename GR, typename Item>
    428428    class GraphItemIt : public Item {
     
    430430      /// \brief Default constructor.
    431431      ///
    432       /// @warning The default constructor sets the iterator
    433       /// to an undefined value.
     432      /// Default constructor.
     433      /// \warning The default constructor is not required to set
     434      /// the iterator to some well-defined value. So you should consider it
     435      /// as uninitialized.
    434436      GraphItemIt() {}
     437
    435438      /// \brief Copy constructor.
    436439      ///
    437440      /// Copy constructor.
    438       ///
    439       GraphItemIt(const GraphItemIt& ) {}
    440       /// \brief Sets the iterator to the first item.
    441       ///
    442       /// Sets the iterator to the first item of \c the graph.
    443       ///
     441      GraphItemIt(const GraphItemIt& it) : Item(it) {}
     442
     443      /// \brief Constructor that sets the iterator to the first item.
     444      ///
     445      /// Constructor that sets the iterator to the first item.
    444446      explicit GraphItemIt(const GR&) {}
    445       /// \brief Invalid constructor \& conversion.
    446       ///
    447       /// This constructor initializes the item to be invalid.
     447
     448      /// \brief Constructor for conversion from \c INVALID.
     449      ///
     450      /// Constructor for conversion from \c INVALID.
     451      /// It initializes the iterator to be invalid.
    448452      /// \sa Invalid for more details.
    449453      GraphItemIt(Invalid) {}
    450       /// \brief Assign operator for items.
    451       ///
    452       /// The items are assignable.
    453       ///
     454
     455      /// \brief Assignment operator.
     456      ///
     457      /// Assignment operator for the iterator.
    454458      GraphItemIt& operator=(const GraphItemIt&) { return *this; }
    455       /// \brief Next item.
    456       ///
    457       /// Assign the iterator to the next item.
    458       ///
     459
     460      /// \brief Increment the iterator.
     461      ///
     462      /// This operator increments the iterator, i.e. assigns it to the
     463      /// next item.
    459464      GraphItemIt& operator++() { return *this; }
     465 
    460466      /// \brief Equality operator
    461467      ///
     468      /// Equality operator.
    462469      /// Two iterators are equal if and only if they point to the
    463470      /// same object or both are invalid.
    464471      bool operator==(const GraphItemIt&) const { return true;}
     472
    465473      /// \brief Inequality operator
    466474      ///
    467       /// \sa operator==(Node n)
    468       ///
     475      /// Inequality operator.
     476      /// Two iterators are equal if and only if they point to the
     477      /// same object or both are invalid.
    469478      bool operator!=(const GraphItemIt&) const { return true;}
    470479
     
    472481      struct Constraints {
    473482        void constraints() {
     483          checkConcept<GraphItem<>, _GraphItemIt>();
    474484          _GraphItemIt it1(g);
    475485          _GraphItemIt it2;
     486          _GraphItemIt it3 = it1;
     487          _GraphItemIt it4 = INVALID;
    476488
    477489          it2 = ++it1;
     
    482494          bi = it2;
    483495        }
    484         GR& g;
    485       };
    486     };
    487 
    488     /// \brief Skeleton class for graph InArcIt and OutArcIt
    489     ///
    490     /// \note Because InArcIt and OutArcIt may not inherit from the same
    491     /// base class, the \c sel is a additional template parameter (selector).
    492     /// For InArcIt you should instantiate it with character 'i' and for
    493     /// OutArcIt with 'o'.
     496        const GR& g;
     497      };
     498    };
     499
     500    /// \brief Concept class for \c InArcIt, \c OutArcIt and
     501    /// \c IncEdgeIt types.
     502    ///
     503    /// This class describes the concept of \c InArcIt, \c OutArcIt
     504    /// and \c IncEdgeIt subtypes of digraph and graph types.
     505    ///
     506    /// \note Since these iterator classes do not inherit from the same
     507    /// base class, there is an additional template parameter (selector)
     508    /// \c sel. For \c InArcIt you should instantiate it with character
     509    /// \c 'i', for \c OutArcIt with \c 'o' and for \c IncEdgeIt with \c 'e'.
    494510    template <typename GR,
    495511              typename Item = typename GR::Arc,
     
    500516      /// \brief Default constructor.
    501517      ///
    502       /// @warning The default constructor sets the iterator
    503       /// to an undefined value.
     518      /// Default constructor.
     519      /// \warning The default constructor is not required to set
     520      /// the iterator to some well-defined value. So you should consider it
     521      /// as uninitialized.
    504522      GraphIncIt() {}
     523
    505524      /// \brief Copy constructor.
    506525      ///
    507526      /// Copy constructor.
    508       ///
    509       GraphIncIt(GraphIncIt const& gi) : Item(gi) {}
    510       /// \brief Sets the iterator to the first arc incoming into or outgoing
    511       /// from the node.
    512       ///
    513       /// Sets the iterator to the first arc incoming into or outgoing
    514       /// from the node.
    515       ///
     527      GraphIncIt(const GraphIncIt& it) : Item(it) {}
     528
     529      /// \brief Constructor that sets the iterator to the first
     530      /// incoming or outgoing arc.
     531      ///
     532      /// Constructor that sets the iterator to the first arc
     533      /// incoming to or outgoing from the given node.
    516534      explicit GraphIncIt(const GR&, const Base&) {}
    517       /// \brief Invalid constructor \& conversion.
    518       ///
    519       /// This constructor initializes the item to be invalid.
     535
     536      /// \brief Constructor for conversion from \c INVALID.
     537      ///
     538      /// Constructor for conversion from \c INVALID.
     539      /// It initializes the iterator to be invalid.
    520540      /// \sa Invalid for more details.
    521541      GraphIncIt(Invalid) {}
    522       /// \brief Assign operator for iterators.
    523       ///
    524       /// The iterators are assignable.
    525       ///
    526       GraphIncIt& operator=(GraphIncIt const&) { return *this; }
    527       /// \brief Next item.
    528       ///
    529       /// Assign the iterator to the next item.
    530       ///
     542
     543      /// \brief Assignment operator.
     544      ///
     545      /// Assignment operator for the iterator.
     546      GraphIncIt& operator=(const GraphIncIt&) { return *this; }
     547
     548      /// \brief Increment the iterator.
     549      ///
     550      /// This operator increments the iterator, i.e. assigns it to the
     551      /// next arc incoming to or outgoing from the given node.
    531552      GraphIncIt& operator++() { return *this; }
    532553
    533554      /// \brief Equality operator
    534555      ///
     556      /// Equality operator.
    535557      /// Two iterators are equal if and only if they point to the
    536558      /// same object or both are invalid.
     
    539561      /// \brief Inequality operator
    540562      ///
    541       /// \sa operator==(Node n)
    542       ///
     563      /// Inequality operator.
     564      /// Two iterators are equal if and only if they point to the
     565      /// same object or both are invalid.
    543566      bool operator!=(const GraphIncIt&) const { return true;}
    544567
     
    549572          _GraphIncIt it1(graph, node);
    550573          _GraphIncIt it2;
     574          _GraphIncIt it3 = it1;
     575          _GraphIncIt it4 = INVALID;
    551576
    552577          it2 = ++it1;
     
    555580          Item e = it1;
    556581          e = it2;
    557 
    558         }
    559 
    560         Item arc;
    561         Base node;
    562         GR graph;
    563         _GraphIncIt it;
    564       };
    565     };
    566 
    567 
    568     /// \brief An empty iterable digraph class.
    569     ///
    570     /// This class provides beside the core digraph features
    571     /// iterator based iterable interface for the digraph structure.
     582        }
     583        const Base& node;
     584        const GR& graph;
     585      };
     586    };
     587
     588    /// \brief Skeleton class for iterable directed graphs.
     589    ///
     590    /// This class describes the interface of iterable directed
     591    /// graphs. It extends \ref BaseDigraphComponent with the core
     592    /// iterable interface.
    572593    /// This concept is part of the Digraph concept.
    573594    template <typename BAS = BaseDigraphComponent>
     
    584605      /// \name Base iteration
    585606      ///
    586       /// This interface provides functions for iteration on digraph items
     607      /// This interface provides functions for iteration on digraph items.
    587608      ///
    588609      /// @{
    589610
    590       /// \brief Gives back the first node in the iterating order.
    591       ///
    592       /// Gives back the first node in the iterating order.
    593       ///
     611      /// \brief Return the first node.
     612      ///
     613      /// This function gives back the first node in the iteration order.
    594614      void first(Node&) const {}
    595615
    596       /// \brief Gives back the next node in the iterating order.
    597       ///
    598       /// Gives back the next node in the iterating order.
    599       ///
     616      /// \brief Return the next node.
     617      ///
     618      /// This function gives back the next node in the iteration order.
    600619      void next(Node&) const {}
    601620
    602       /// \brief Gives back the first arc in the iterating order.
    603       ///
    604       /// Gives back the first arc in the iterating order.
    605       ///
     621      /// \brief Return the first arc.
     622      ///
     623      /// This function gives back the first arc in the iteration order.
    606624      void first(Arc&) const {}
    607625
    608       /// \brief Gives back the next arc in the iterating order.
    609       ///
    610       /// Gives back the next arc in the iterating order.
    611       ///
     626      /// \brief Return the next arc.
     627      ///
     628      /// This function gives back the next arc in the iteration order.
    612629      void next(Arc&) const {}
    613630
    614 
    615       /// \brief Gives back the first of the arcs point to the given
    616       /// node.
    617       ///
    618       /// Gives back the first of the arcs point to the given node.
    619       ///
     631      /// \brief Return the first arc incomming to the given node.
     632      ///
     633      /// This function gives back the first arc incomming to the
     634      /// given node.
    620635      void firstIn(Arc&, const Node&) const {}
    621636
    622       /// \brief Gives back the next of the arcs points to the given
    623       /// node.
    624       ///
    625       /// Gives back the next of the arcs points to the given node.
    626       ///
     637      /// \brief Return the next arc incomming to the given node.
     638      ///
     639      /// This function gives back the next arc incomming to the
     640      /// given node.
    627641      void nextIn(Arc&) const {}
    628642
    629       /// \brief Gives back the first of the arcs start from the
     643      /// \brief Return the first arc outgoing form the given node.
     644      ///
     645      /// This function gives back the first arc outgoing form the
    630646      /// given node.
    631       ///
    632       /// Gives back the first of the arcs start from the given node.
    633       ///
    634647      void firstOut(Arc&, const Node&) const {}
    635648
    636       /// \brief Gives back the next of the arcs start from the given
    637       /// node.
    638       ///
    639       /// Gives back the next of the arcs start from the given node.
    640       ///
     649      /// \brief Return the next arc outgoing form the given node.
     650      ///
     651      /// This function gives back the next arc outgoing form the
     652      /// given node.
    641653      void nextOut(Arc&) const {}
    642654
     
    645657      /// \name Class based iteration
    646658      ///
    647       /// This interface provides functions for iteration on digraph items
     659      /// This interface provides iterator classes for digraph items.
    648660      ///
    649661      /// @{
     
    655667      typedef GraphItemIt<Digraph, Node> NodeIt;
    656668
    657       /// \brief This iterator goes through each node.
    658       ///
    659       /// This iterator goes through each node.
     669      /// \brief This iterator goes through each arc.
     670      ///
     671      /// This iterator goes through each arc.
    660672      ///
    661673      typedef GraphItemIt<Digraph, Arc> ArcIt;
     
    663675      /// \brief This iterator goes trough the incoming arcs of a node.
    664676      ///
    665       /// This iterator goes trough the \e inccoming arcs of a certain node
     677      /// This iterator goes trough the \e incoming arcs of a certain node
    666678      /// of a digraph.
    667679      typedef GraphIncIt<Digraph, Arc, Node, 'i'> InArcIt;
     
    675687      /// \brief The base node of the iterator.
    676688      ///
    677       /// Gives back the base node of the iterator.
    678       /// It is always the target of the pointed arc.
     689      /// This function gives back the base node of the iterator.
     690      /// It is always the target node of the pointed arc.
    679691      Node baseNode(const InArcIt&) const { return INVALID; }
    680692
    681693      /// \brief The running node of the iterator.
    682694      ///
    683       /// Gives back the running node of the iterator.
    684       /// It is always the source of the pointed arc.
     695      /// This function gives back the running node of the iterator.
     696      /// It is always the source node of the pointed arc.
    685697      Node runningNode(const InArcIt&) const { return INVALID; }
    686698
    687699      /// \brief The base node of the iterator.
    688700      ///
    689       /// Gives back the base node of the iterator.
    690       /// It is always the source of the pointed arc.
     701      /// This function gives back the base node of the iterator.
     702      /// It is always the source node of the pointed arc.
    691703      Node baseNode(const OutArcIt&) const { return INVALID; }
    692704
    693705      /// \brief The running node of the iterator.
    694706      ///
    695       /// Gives back the running node of the iterator.
    696       /// It is always the target of the pointed arc.
     707      /// This function gives back the running node of the iterator.
     708      /// It is always the target node of the pointed arc.
    697709      Node runningNode(const OutArcIt&) const { return INVALID; }
    698710
     
    736748
    737749            typename _Digraph::Node n;
    738             typename _Digraph::InArcIt ieit(INVALID);
    739             typename _Digraph::OutArcIt oeit(INVALID);
    740             n = digraph.baseNode(ieit);
    741             n = digraph.runningNode(ieit);
    742             n = digraph.baseNode(oeit);
    743             n = digraph.runningNode(oeit);
     750            const typename _Digraph::InArcIt iait(INVALID);
     751            const typename _Digraph::OutArcIt oait(INVALID);
     752            n = digraph.baseNode(iait);
     753            n = digraph.runningNode(iait);
     754            n = digraph.baseNode(oait);
     755            n = digraph.runningNode(oait);
    744756            ignore_unused_variable_warning(n);
    745757          }
     
    747759
    748760        const _Digraph& digraph;
    749 
    750       };
    751     };
    752 
    753     /// \brief An empty iterable undirected graph class.
    754     ///
    755     /// This class provides beside the core graph features iterator
    756     /// based iterable interface for the undirected graph structure.
     761      };
     762    };
     763
     764    /// \brief Skeleton class for iterable undirected graphs.
     765    ///
     766    /// This class describes the interface of iterable undirected
     767    /// graphs. It extends \ref IterableDigraphComponent with the core
     768    /// iterable interface of undirected graphs.
    757769    /// This concept is part of the Graph concept.
    758770    template <typename BAS = BaseGraphComponent>
     
    770782      /// \name Base iteration
    771783      ///
    772       /// This interface provides functions for iteration on graph items
     784      /// This interface provides functions for iteration on edges.
     785      ///
    773786      /// @{
    774787
     
    776789      using IterableDigraphComponent<Base>::next;
    777790
    778       /// \brief Gives back the first edge in the iterating
    779       /// order.
    780       ///
    781       /// Gives back the first edge in the iterating order.
    782       ///
     791      /// \brief Return the first edge.
     792      ///
     793      /// This function gives back the first edge in the iteration order.
    783794      void first(Edge&) const {}
    784795
    785       /// \brief Gives back the next edge in the iterating
    786       /// order.
    787       ///
    788       /// Gives back the next edge in the iterating order.
    789       ///
     796      /// \brief Return the next edge.
     797      ///
     798      /// This function gives back the next edge in the iteration order.
    790799      void next(Edge&) const {}
    791800
    792 
    793       /// \brief Gives back the first of the edges from the
     801      /// \brief Return the first edge incident to the given node.
     802      ///
     803      /// This function gives back the first edge incident to the given
     804      /// node. The bool parameter gives back the direction for which the
     805      /// source node of the directed arc representing the edge is the
    794806      /// given node.
    795       ///
    796       /// Gives back the first of the edges from the given
    797       /// node. The bool parameter gives back that direction which
    798       /// gives a good direction of the edge so the source of the
    799       /// directed arc is the given node.
    800807      void firstInc(Edge&, bool&, const Node&) const {}
    801808
     
    803810      /// given node.
    804811      ///
    805       /// Gives back the next of the edges from the given
    806       /// node. The bool parameter should be used as the \c firstInc()
    807       /// use it.
     812      /// This function gives back the next edge incident to the given
     813      /// node. The bool parameter should be used as \c firstInc() use it.
    808814      void nextInc(Edge&, bool&) const {}
    809815
     
    815821      /// \name Class based iteration
    816822      ///
    817       /// This interface provides functions for iteration on graph items
     823      /// This interface provides iterator classes for edges.
    818824      ///
    819825      /// @{
    820826
    821       /// \brief This iterator goes through each node.
    822       ///
    823       /// This iterator goes through each node.
     827      /// \brief This iterator goes through each edge.
     828      ///
     829      /// This iterator goes through each edge.
    824830      typedef GraphItemIt<Graph, Edge> EdgeIt;
    825       /// \brief This iterator goes trough the incident arcs of a
     831
     832      /// \brief This iterator goes trough the incident edges of a
    826833      /// node.
    827834      ///
    828       /// This iterator goes trough the incident arcs of a certain
     835      /// This iterator goes trough the incident edges of a certain
    829836      /// node of a graph.
    830       typedef GraphIncIt<Graph, Edge, Node, 'u'> IncEdgeIt;
     837      typedef GraphIncIt<Graph, Edge, Node, 'e'> IncEdgeIt;
     838
    831839      /// \brief The base node of the iterator.
    832840      ///
    833       /// Gives back the base node of the iterator.
     841      /// This function gives back the base node of the iterator.
    834842      Node baseNode(const IncEdgeIt&) const { return INVALID; }
    835843
    836844      /// \brief The running node of the iterator.
    837845      ///
    838       /// Gives back the running node of the iterator.
     846      /// This function gives back the running node of the iterator.
    839847      Node runningNode(const IncEdgeIt&) const { return INVALID; }
    840848
     
    865873              typename _Graph::EdgeIt >();
    866874            checkConcept<GraphIncIt<_Graph, typename _Graph::Edge,
    867               typename _Graph::Node, 'u'>, typename _Graph::IncEdgeIt>();
     875              typename _Graph::Node, 'e'>, typename _Graph::IncEdgeIt>();
    868876
    869877            typename _Graph::Node n;
    870             typename _Graph::IncEdgeIt ueit(INVALID);
    871             n = graph.baseNode(ueit);
    872             n = graph.runningNode(ueit);
     878            const typename _Graph::IncEdgeIt ieit(INVALID);
     879            n = graph.baseNode(ieit);
     880            n = graph.runningNode(ieit);
    873881          }
    874882        }
     
    878886    };
    879887
    880     /// \brief An empty alteration notifier digraph class.
    881     ///
    882     /// This class provides beside the core digraph features alteration
    883     /// notifier interface for the digraph structure.  This implements
     888    /// \brief Skeleton class for alterable directed graphs.
     889    ///
     890    /// This class describes the interface of alterable directed
     891    /// graphs. It extends \ref BaseDigraphComponent with the alteration
     892    /// notifier interface. It implements
    884893    /// an observer-notifier pattern for each digraph item. More
    885894    /// obsevers can be registered into the notifier and whenever an
    886     /// alteration occured in the digraph all the observers will
     895    /// alteration occured in the digraph all the observers will be
    887896    /// notified about it.
    888897    template <typename BAS = BaseDigraphComponent>
     
    895904
    896905
    897       /// The node observer registry.
     906      /// Node alteration notifier class.
    898907      typedef AlterationNotifier<AlterableDigraphComponent, Node>
    899908      NodeNotifier;
    900       /// The arc observer registry.
     909      /// Arc alteration notifier class.
    901910      typedef AlterationNotifier<AlterableDigraphComponent, Arc>
    902911      ArcNotifier;
    903912
    904       /// \brief Gives back the node alteration notifier.
    905       ///
    906       /// Gives back the node alteration notifier.
     913      /// \brief Return the node alteration notifier.
     914      ///
     915      /// This function gives back the node alteration notifier.
    907916      NodeNotifier& notifier(Node) const {
    908         return NodeNotifier();
     917         return NodeNotifier();
    909918      }
    910919
    911       /// \brief Gives back the arc alteration notifier.
    912       ///
    913       /// Gives back the arc alteration notifier.
     920      /// \brief Return the arc alteration notifier.
     921      ///
     922      /// This function gives back the arc alteration notifier.
    914923      ArcNotifier& notifier(Arc) const {
    915924        return ArcNotifier();
     
    931940
    932941        const _Digraph& digraph;
    933 
    934       };
    935 
    936     };
    937 
    938     /// \brief An empty alteration notifier undirected graph class.
    939     ///
    940     /// This class provides beside the core graph features alteration
    941     /// notifier interface for the graph structure.  This implements
    942     /// an observer-notifier pattern for each graph item. More
     942      };
     943    };
     944
     945    /// \brief Skeleton class for alterable undirected graphs.
     946    ///
     947    /// This class describes the interface of alterable undirected
     948    /// graphs. It extends \ref AlterableDigraphComponent with the alteration
     949    /// notifier interface of undirected graphs. It implements
     950    /// an observer-notifier pattern for the edges. More
    943951    /// obsevers can be registered into the notifier and whenever an
    944     /// alteration occured in the graph all the observers will
     952    /// alteration occured in the graph all the observers will be
    945953    /// notified about it.
    946954    template <typename BAS = BaseGraphComponent>
     
    952960
    953961
    954       /// The arc observer registry.
     962      /// Edge alteration notifier class.
    955963      typedef AlterationNotifier<AlterableGraphComponent, Edge>
    956964      EdgeNotifier;
    957965
    958       /// \brief Gives back the arc alteration notifier.
    959       ///
    960       /// Gives back the arc alteration notifier.
     966      /// \brief Return the edge alteration notifier.
     967      ///
     968      /// This function gives back the edge alteration notifier.
    961969      EdgeNotifier& notifier(Edge) const {
    962970        return EdgeNotifier();
     
    966974      struct Constraints {
    967975        void constraints() {
    968           checkConcept<AlterableGraphComponent<Base>, _Graph>();
     976          checkConcept<AlterableDigraphComponent<Base>, _Graph>();
    969977          typename _Graph::EdgeNotifier& uen
    970978            = graph.notifier(typename _Graph::Edge());
     
    976984    };
    977985
    978     /// \brief Class describing the concept of graph maps
    979     ///
    980     /// This class describes the common interface of the graph maps
    981     /// (NodeMap, ArcMap), that is maps that can be used to
    982     /// associate data to graph descriptors (nodes or arcs).
     986    /// \brief Concept class for standard graph maps.
     987    ///
     988    /// This class describes the concept of standard graph maps, i.e.
     989    /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and
     990    /// graph types, which can be used for associating data to graph items.
    983991    template <typename GR, typename K, typename V>
    984992    class GraphMap : public ReadWriteMap<K, V> {
     
    10001008      /// \brief Construct a new map with default value.
    10011009      ///
    1002       /// Construct a new map for the graph and initalise the values.
     1010      /// Construct a new map for the graph and initalize the values.
    10031011      GraphMap(const Graph&, const Value&) {}
    10041012
     
    10091017      GraphMap(const GraphMap&) : Parent() {}
    10101018
    1011       /// \brief Assign operator.
    1012       ///
    1013       /// Assign operator. It does not mofify the underlying graph,
     1019      /// \brief Assignment operator.
     1020      ///
     1021      /// Assignment operator. It does not mofify the underlying graph,
    10141022      /// it just iterates on the current item set and set the  map
    10151023      /// with the value returned by the assigned map.
     
    10251033        void constraints() {
    10261034          checkConcept<ReadWriteMap<Key, Value>, _Map >();
    1027           // Construction with a graph parameter
    1028           _Map a(g);
    1029           // Constructor with a graph and a default value parameter
    1030           _Map a2(g,t);
    1031           // Copy constructor.
    1032           // _Map b(c);
    1033 
     1035          _Map m1(g);
     1036          _Map m2(g,t);
     1037         
     1038          // Copy constructor
     1039          // _Map m3(m);
     1040
     1041          // Assignment operator
    10341042          // ReadMap<Key, Value> cmap;
    1035           // b = cmap;
    1036 
    1037           ignore_unused_variable_warning(a);
    1038           ignore_unused_variable_warning(a2);
    1039           // ignore_unused_variable_warning(b);
    1040         }
    1041 
    1042         const _Map &c;
     1043          // m3 = cmap;
     1044
     1045          ignore_unused_variable_warning(m1);
     1046          ignore_unused_variable_warning(m2);
     1047          // ignore_unused_variable_warning(m3);
     1048        }
     1049
     1050        const _Map &m;
    10431051        const Graph &g;
    10441052        const typename GraphMap::Value &t;
     
    10471055    };
    10481056
    1049     /// \brief An empty mappable digraph class.
    1050     ///
    1051     /// This class provides beside the core digraph features
    1052     /// map interface for the digraph structure.
     1057    /// \brief Skeleton class for mappable directed graphs.
     1058    ///
     1059    /// This class describes the interface of mappable directed graphs.
     1060    /// It extends \ref BaseDigraphComponent with the standard digraph
     1061    /// map classes, namely \c NodeMap and \c ArcMap.
    10531062    /// This concept is part of the Digraph concept.
    10541063    template <typename BAS = BaseDigraphComponent>
     
    10621071      typedef MappableDigraphComponent Digraph;
    10631072
    1064       /// \brief ReadWrite map of the nodes.
    1065       ///
    1066       /// ReadWrite map of the nodes.
    1067       ///
     1073      /// \brief Standard graph map for the nodes.
     1074      ///
     1075      /// Standard graph map for the nodes.
    10681076      template <typename V>
    1069       class NodeMap : public GraphMap<Digraph, Node, V> {
     1077      class NodeMap : public GraphMap<MappableDigraphComponent, Node, V> {
    10701078      public:
    10711079        typedef GraphMap<MappableDigraphComponent, Node, V> Parent;
     
    10791087        /// \brief Construct a new map with default value.
    10801088        ///
    1081         /// Construct a new map for the digraph and initalise the values.
     1089        /// Construct a new map for the digraph and initalize the values.
    10821090        NodeMap(const MappableDigraphComponent& digraph, const V& value)
    10831091          : Parent(digraph, value) {}
     
    10891097        NodeMap(const NodeMap& nm) : Parent(nm) {}
    10901098
    1091         /// \brief Assign operator.
    1092         ///
    1093         /// Assign operator.
     1099        /// \brief Assignment operator.
     1100        ///
     1101        /// Assignment operator.
    10941102        template <typename CMap>
    10951103        NodeMap& operator=(const CMap&) {
     
    11001108      };
    11011109
    1102       /// \brief ReadWrite map of the arcs.
    1103       ///
    1104       /// ReadWrite map of the arcs.
    1105       ///
     1110      /// \brief Standard graph map for the arcs.
     1111      ///
     1112      /// Standard graph map for the arcs.
    11061113      template <typename V>
    1107       class ArcMap : public GraphMap<Digraph, Arc, V> {
     1114      class ArcMap : public GraphMap<MappableDigraphComponent, Arc, V> {
    11081115      public:
    11091116        typedef GraphMap<MappableDigraphComponent, Arc, V> Parent;
     
    11171124        /// \brief Construct a new map with default value.
    11181125        ///
    1119         /// Construct a new map for the digraph and initalise the values.
     1126        /// Construct a new map for the digraph and initalize the values.
    11201127        ArcMap(const MappableDigraphComponent& digraph, const V& value)
    11211128          : Parent(digraph, value) {}
     
    11271134        ArcMap(const ArcMap& nm) : Parent(nm) {}
    11281135
    1129         /// \brief Assign operator.
    1130         ///
    1131         /// Assign operator.
     1136        /// \brief Assignment operator.
     1137        ///
     1138        /// Assignment operator.
    11321139        template <typename CMap>
    11331140        ArcMap& operator=(const CMap&) {
     
    11791186        }
    11801187
    1181         _Digraph& digraph;
    1182       };
    1183     };
    1184 
    1185     /// \brief An empty mappable base bipartite graph class.
    1186     ///
    1187     /// This class provides beside the core graph features
    1188     /// map interface for the graph structure.
     1188        const _Digraph& digraph;
     1189      };
     1190    };
     1191
     1192    /// \brief Skeleton class for mappable undirected graphs.
     1193    ///
     1194    /// This class describes the interface of mappable undirected graphs.
     1195    /// It extends \ref MappableDigraphComponent with the standard graph
     1196    /// map class for edges (\c EdgeMap).
    11891197    /// This concept is part of the Graph concept.
    11901198    template <typename BAS = BaseGraphComponent>
     
    11971205      typedef MappableGraphComponent Graph;
    11981206
    1199       /// \brief ReadWrite map of the edges.
    1200       ///
    1201       /// ReadWrite map of the edges.
    1202       ///
     1207      /// \brief Standard graph map for the edges.
     1208      ///
     1209      /// Standard graph map for the edges.
    12031210      template <typename V>
    1204       class EdgeMap : public GraphMap<Graph, Edge, V> {
     1211      class EdgeMap : public GraphMap<MappableGraphComponent, Edge, V> {
    12051212      public:
    12061213        typedef GraphMap<MappableGraphComponent, Edge, V> Parent;
     
    12141221        /// \brief Construct a new map with default value.
    12151222        ///
    1216         /// Construct a new map for the graph and initalise the values.
     1223        /// Construct a new map for the graph and initalize the values.
    12171224        EdgeMap(const MappableGraphComponent& graph, const V& value)
    12181225          : Parent(graph, value) {}
     
    12241231        EdgeMap(const EdgeMap& nm) : Parent(nm) {}
    12251232
    1226         /// \brief Assign operator.
    1227         ///
    1228         /// Assign operator.
     1233        /// \brief Assignment operator.
     1234        ///
     1235        /// Assignment operator.
    12291236        template <typename CMap>
    12301237        EdgeMap& operator=(const CMap&) {
     
    12461253
    12471254        void constraints() {
    1248           checkConcept<MappableGraphComponent<Base>, _Graph>();
     1255          checkConcept<MappableDigraphComponent<Base>, _Graph>();
    12491256
    12501257          { // int map test
     
    12631270        }
    12641271
    1265         _Graph& graph;
    1266       };
    1267     };
    1268 
    1269     /// \brief An empty extendable digraph class.
    1270     ///
    1271     /// This class provides beside the core digraph features digraph
    1272     /// extendable interface for the digraph structure.  The main
    1273     /// difference between the base and this interface is that the
    1274     /// digraph alterations should handled already on this level.
     1272        const _Graph& graph;
     1273      };
     1274    };
     1275
     1276    /// \brief Skeleton class for extendable directed graphs.
     1277    ///
     1278    /// This class describes the interface of extendable directed graphs.
     1279    /// It extends \ref BaseDigraphComponent with functions for adding
     1280    /// nodes and arcs to the digraph.
     1281    /// This concept requires \ref AlterableDigraphComponent.
    12751282    template <typename BAS = BaseDigraphComponent>
    12761283    class ExtendableDigraphComponent : public BAS {
     
    12811288      typedef typename Base::Arc Arc;
    12821289
    1283       /// \brief Adds a new node to the digraph.
    1284       ///
    1285       /// Adds a new node to the digraph.
    1286       ///
     1290      /// \brief Add a new node to the digraph.
     1291      ///
     1292      /// This function adds a new node to the digraph.
    12871293      Node addNode() {
    12881294        return INVALID;
    12891295      }
    12901296
    1291       /// \brief Adds a new arc connects the given two nodes.
    1292       ///
    1293       /// Adds a new arc connects the the given two nodes.
     1297      /// \brief Add a new arc connecting the given two nodes.
     1298      ///
     1299      /// This function adds a new arc connecting the given two nodes
     1300      /// of the digraph.
    12941301      Arc addArc(const Node&, const Node&) {
    12951302        return INVALID;
     
    13111318    };
    13121319
    1313     /// \brief An empty extendable base undirected graph class.
    1314     ///
    1315     /// This class provides beside the core undirected graph features
    1316     /// core undircted graph extend interface for the graph structure.
    1317     /// The main difference between the base and this interface is
    1318     /// that the graph alterations should handled already on this
    1319     /// level.
     1320    /// \brief Skeleton class for extendable undirected graphs.
     1321    ///
     1322    /// This class describes the interface of extendable undirected graphs.
     1323    /// It extends \ref BaseGraphComponent with functions for adding
     1324    /// nodes and edges to the graph.
     1325    /// This concept requires \ref AlterableGraphComponent.
    13201326    template <typename BAS = BaseGraphComponent>
    13211327    class ExtendableGraphComponent : public BAS {
     
    13261332      typedef typename Base::Edge Edge;
    13271333
    1328       /// \brief Adds a new node to the graph.
    1329       ///
    1330       /// Adds a new node to the graph.
    1331       ///
     1334      /// \brief Add a new node to the digraph.
     1335      ///
     1336      /// This function adds a new node to the digraph.
    13321337      Node addNode() {
    13331338        return INVALID;
    13341339      }
    13351340
    1336       /// \brief Adds a new arc connects the given two nodes.
    1337       ///
    1338       /// Adds a new arc connects the the given two nodes.
    1339       Edge addArc(const Node&, const Node&) {
     1341      /// \brief Add a new edge connecting the given two nodes.
     1342      ///
     1343      /// This function adds a new edge connecting the given two nodes
     1344      /// of the graph.
     1345      Edge addEdge(const Node&, const Node&) {
    13401346        return INVALID;
    13411347      }
     
    13561362    };
    13571363
    1358     /// \brief An empty erasable digraph class.
    1359     ///
    1360     /// This class provides beside the core digraph features core erase
    1361     /// functions for the digraph structure. The main difference between
    1362     /// the base and this interface is that the digraph alterations
    1363     /// should handled already on this level.
     1364    /// \brief Skeleton class for erasable directed graphs.
     1365    ///
     1366    /// This class describes the interface of erasable directed graphs.
     1367    /// It extends \ref BaseDigraphComponent with functions for removing
     1368    /// nodes and arcs from the digraph.
     1369    /// This concept requires \ref AlterableDigraphComponent.
    13641370    template <typename BAS = BaseDigraphComponent>
    13651371    class ErasableDigraphComponent : public BAS {
     
    13721378      /// \brief Erase a node from the digraph.
    13731379      ///
    1374       /// Erase a node from the digraph. This function should
    1375       /// erase all arcs connecting to the node.
     1380      /// This function erases the given node from the digraph and all arcs
     1381      /// connected to the node.
    13761382      void erase(const Node&) {}
    13771383
    13781384      /// \brief Erase an arc from the digraph.
    13791385      ///
    1380       /// Erase an arc from the digraph.
    1381       ///
     1386      /// This function erases the given arc from the digraph.
    13821387      void erase(const Arc&) {}
    13831388
     
    13861391        void constraints() {
    13871392          checkConcept<Base, _Digraph>();
    1388           typename _Digraph::Node node;
     1393          const typename _Digraph::Node node(INVALID);
    13891394          digraph.erase(node);
    1390           typename _Digraph::Arc arc;
     1395          const typename _Digraph::Arc arc(INVALID);
    13911396          digraph.erase(arc);
    13921397        }
     
    13961401    };
    13971402
    1398     /// \brief An empty erasable base undirected graph class.
    1399     ///
    1400     /// This class provides beside the core undirected graph features
    1401     /// core erase functions for the undirceted graph structure. The
    1402     /// main difference between the base and this interface is that
    1403     /// the graph alterations should handled already on this level.
     1403    /// \brief Skeleton class for erasable undirected graphs.
     1404    ///
     1405    /// This class describes the interface of erasable undirected graphs.
     1406    /// It extends \ref BaseGraphComponent with functions for removing
     1407    /// nodes and edges from the graph.
     1408    /// This concept requires \ref AlterableGraphComponent.
    14041409    template <typename BAS = BaseGraphComponent>
    14051410    class ErasableGraphComponent : public BAS {
     
    14121417      /// \brief Erase a node from the graph.
    14131418      ///
    1414       /// Erase a node from the graph. This function should erase
    1415       /// arcs connecting to the node.
     1419      /// This function erases the given node from the graph and all edges
     1420      /// connected to the node.
    14161421      void erase(const Node&) {}
    14171422
    1418       /// \brief Erase an arc from the graph.
    1419       ///
    1420       /// Erase an arc from the graph.
    1421       ///
     1423      /// \brief Erase an edge from the digraph.
     1424      ///
     1425      /// This function erases the given edge from the digraph.
    14221426      void erase(const Edge&) {}
    14231427
     
    14261430        void constraints() {
    14271431          checkConcept<Base, _Graph>();
    1428           typename _Graph::Node node;
     1432          const typename _Graph::Node node(INVALID);
    14291433          graph.erase(node);
    1430           typename _Graph::Edge edge;
     1434          const typename _Graph::Edge edge(INVALID);
    14311435          graph.erase(edge);
    14321436        }
     
    14361440    };
    14371441
    1438     /// \brief An empty clearable base digraph class.
    1439     ///
    1440     /// This class provides beside the core digraph features core clear
    1441     /// functions for the digraph structure. The main difference between
    1442     /// the base and this interface is that the digraph alterations
    1443     /// should handled already on this level.
     1442    /// \brief Skeleton class for clearable directed graphs.
     1443    ///
     1444    /// This class describes the interface of clearable directed graphs.
     1445    /// It extends \ref BaseDigraphComponent with a function for clearing
     1446    /// the digraph.
     1447    /// This concept requires \ref AlterableDigraphComponent.
    14441448    template <typename BAS = BaseDigraphComponent>
    14451449    class ClearableDigraphComponent : public BAS {
     
    14501454      /// \brief Erase all nodes and arcs from the digraph.
    14511455      ///
    1452       /// Erase all nodes and arcs from the digraph.
    1453       ///
     1456      /// This function erases all nodes and arcs from the digraph.
    14541457      void clear() {}
    14551458
     
    14611464        }
    14621465
    1463         _Digraph digraph;
    1464       };
    1465     };
    1466 
    1467     /// \brief An empty clearable base undirected graph class.
    1468     ///
    1469     /// This class provides beside the core undirected graph features
    1470     /// core clear functions for the undirected graph structure. The
    1471     /// main difference between the base and this interface is that
    1472     /// the graph alterations should handled already on this level.
     1466        _Digraph& digraph;
     1467      };
     1468    };
     1469
     1470    /// \brief Skeleton class for clearable undirected graphs.
     1471    ///
     1472    /// This class describes the interface of clearable undirected graphs.
     1473    /// It extends \ref BaseGraphComponent with a function for clearing
     1474    /// the graph.
     1475    /// This concept requires \ref AlterableGraphComponent.
    14731476    template <typename BAS = BaseGraphComponent>
    14741477    class ClearableGraphComponent : public ClearableDigraphComponent<BAS> {
     
    14771480      typedef BAS Base;
    14781481
     1482      /// \brief Erase all nodes and edges from the graph.
     1483      ///
     1484      /// This function erases all nodes and edges from the graph.
     1485      void clear() {}
     1486
    14791487      template <typename _Graph>
    14801488      struct Constraints {
    14811489        void constraints() {
    1482           checkConcept<ClearableGraphComponent<Base>, _Graph>();
    1483         }
    1484 
    1485         _Graph graph;
     1490          checkConcept<Base, _Graph>();
     1491          graph.clear();
     1492        }
     1493
     1494        _Graph& graph;
    14861495      };
    14871496    };
Note: See TracChangeset for help on using the changeset viewer.