COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/concepts/graph_components.h

    r584 r534  
    2121///\brief The concept of graph components.
    2222
     23
    2324#ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H
    2425#define LEMON_CONCEPTS_GRAPH_COMPONENTS_H
     
    3233  namespace concepts {
    3334
    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.
     35    /// \brief Skeleton class for graph Node and Arc types
     36    ///
     37    /// This class describes the interface of Node and Arc (and Edge
     38    /// in undirected graphs) subtypes of graph types.
    3839    ///
    3940    /// \note This class is a template class so that we can use it to
    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'.
     41    /// create graph skeleton classes. The reason for this is than Node
     42    /// and Arc types should \em not derive from the same base class.
     43    /// For Node you should instantiate it with character 'n' and for Arc
     44    /// with 'a'.
     45
    4446#ifndef DOXYGEN
    45     template <char sel = '0'>
     47    template <char _selector = '0'>
    4648#endif
    4749    class GraphItem {
     
    4951      /// \brief Default constructor.
    5052      ///
    51       /// Default constructor.
    5253      /// \warning The default constructor is not required to set
    5354      /// the item to some well-defined value. So you should consider it
    5455      /// as uninitialized.
    5556      GraphItem() {}
    56 
    5757      /// \brief Copy constructor.
    5858      ///
    5959      /// Copy constructor.
     60      ///
    6061      GraphItem(const GraphItem &) {}
    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.
     62      /// \brief Invalid constructor \& conversion.
     63      ///
     64      /// This constructor initializes the item to be invalid.
    6665      /// \sa Invalid for more details.
    6766      GraphItem(Invalid) {}
    68 
    69       /// \brief Assignment operator.
    70       ///
    71       /// Assignment operator for the item.
    72       GraphItem& operator=(const GraphItem&) { return *this; }
    73 
     67      /// \brief Assign operator for nodes.
     68      ///
     69      /// The nodes are assignable.
     70      ///
     71      GraphItem& operator=(GraphItem const&) { return *this; }
    7472      /// \brief Equality operator.
    7573      ///
    76       /// Equality operator.
    77       bool operator==(const GraphItem&) const { return false; }
    78 
     74      /// Two iterators are equal if and only if they represents the
     75      /// same node in the graph or both are invalid.
     76      bool operator==(GraphItem) const { return false; }
    7977      /// \brief Inequality operator.
    8078      ///
    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).
     79      /// \sa operator==(const Node& n)
     80      ///
     81      bool operator!=(GraphItem) const { return false; }
     82
     83      /// \brief Artificial ordering operator.
     84      ///
     85      /// To allow the use of graph descriptors as key type in std::map or
     86      /// similar associative container we require this.
    8987      ///
    9088      /// \note This operator only have to define some strict ordering of
    9189      /// the items; this order has nothing to do with the iteration
    9290      /// ordering of the items.
    93       bool operator<(const GraphItem&) const { return false; }
     91      bool operator<(GraphItem) const { return false; }
    9492
    9593      template<typename _GraphItem>
     
    103101
    104102          bool b;
     103          //          b = (ia == ib) && (ia != ib) && (ia < ib);
    105104          b = (ia == ib) && (ia != ib);
    106105          b = (ia == INVALID) && (ib != INVALID);
     
    113112    };
    114113
    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.
     114    /// \brief An empty base directed graph class.
     115    ///
     116    /// This class provides the minimal set of features needed for a
     117    /// directed graph structure. All digraph concepts have to
     118    /// conform to this base directed graph. It just provides types
     119    /// for nodes and arcs and functions to get the source and the
     120    /// target of the arcs.
    121121    class BaseDigraphComponent {
    122122    public:
     
    126126      /// \brief Node class of the digraph.
    127127      ///
    128       /// This class represents the nodes of the digraph.
     128      /// This class represents the Nodes of the digraph.
     129      ///
    129130      typedef GraphItem<'n'> Node;
    130131
    131132      /// \brief Arc class of the digraph.
    132133      ///
    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.
     134      /// This class represents the Arcs of the digraph.
     135      ///
     136      typedef GraphItem<'e'> Arc;
     137
     138      /// \brief Gives back the target node of an arc.
     139      ///
     140      /// Gives back the target node of an arc.
     141      ///
     142      Node target(const Arc&) const { return INVALID;}
     143
     144      /// \brief Gives back the source node of an arc.
     145      ///
     146      /// Gives back the source node of an arc.
     147      ///
     148      Node source(const Arc&) const { return INVALID;}
     149
     150      /// \brief Gives back the opposite node on the given arc.
     151      ///
     152      /// Gives back the opposite node on the given arc.
    149153      Node oppositeNode(const Node&, const Arc&) const {
    150154        return INVALID;
     
    172176    };
    173177
    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.
     178    /// \brief An empty base undirected graph class.
     179    ///
     180    /// This class provides the minimal set of features needed for an
     181    /// undirected graph structure. All undirected graph concepts have
     182    /// to conform to this base graph. It just provides types for
     183    /// nodes, arcs and edges and functions to get the
     184    /// source and the target of the arcs and edges,
     185    /// conversion from arcs to edges and function to get
     186    /// both direction of the edges.
    181187    class BaseGraphComponent : public BaseDigraphComponent {
    182188    public:
    183189      typedef BaseDigraphComponent::Node Node;
    184190      typedef BaseDigraphComponent::Arc Arc;
    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'> {
     191      /// \brief Undirected arc class of the graph.
     192      ///
     193      /// This class represents the edges of the graph.
     194      /// The undirected graphs can be used as a directed graph which
     195      /// for each arc contains the opposite arc too so the graph is
     196      /// bidirected. The edge represents two opposite
     197      /// directed arcs.
     198      class Edge : public GraphItem<'u'> {
    192199      public:
    193         typedef GraphItem<'e'> Parent;
    194 
     200        typedef GraphItem<'u'> Parent;
    195201        /// \brief Default constructor.
    196202        ///
    197         /// Default constructor.
    198203        /// \warning The default constructor is not required to set
    199204        /// the item to some well-defined value. So you should consider it
    200205        /// as uninitialized.
    201206        Edge() {}
    202 
    203207        /// \brief Copy constructor.
    204208        ///
    205209        /// Copy constructor.
     210        ///
    206211        Edge(const Edge &) : Parent() {}
    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.
     212        /// \brief Invalid constructor \& conversion.
     213        ///
     214        /// This constructor initializes the item to be invalid.
    212215        /// \sa Invalid for more details.
    213216        Edge(Invalid) {}
    214 
    215         /// \brief Constructor for conversion from an arc.
    216         ///
    217         /// Constructor for conversion from an arc.
     217        /// \brief Converter from arc to edge.
     218        ///
    218219        /// Besides the core graph item functionality each arc should
    219220        /// be convertible to the represented edge.
    220221        Edge(const Arc&) {}
    221 
    222         /// \brief Assign an arc to an edge.
    223         ///
    224         /// This function assigns an arc to an edge.
     222        /// \brief Assign arc to edge.
     223        ///
    225224        /// Besides the core graph item functionality each arc should
    226225        /// be convertible to the represented edge.
     
    228227      };
    229228
    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.
     229      /// \brief Returns the direction of the arc.
    253230      ///
    254231      /// Returns the direction of the arc. Each arc represents an
     
    257234      bool direction(const Arc&) const { return true; }
    258235
    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; }
     236      /// \brief Returns the directed arc.
     237      ///
     238      /// Returns the directed arc from its direction and the
     239      /// represented edge.
     240      Arc direct(const Edge&, bool) const { return INVALID;}
     241
     242      /// \brief Returns the directed arc.
     243      ///
     244      /// Returns the directed arc from its source and the
     245      /// represented edge.
     246      Arc direct(const Edge&, const Node&) const { return INVALID;}
     247
     248      /// \brief Returns the opposite arc.
     249      ///
     250      /// Returns the opposite arc. It is the arc representing the
     251      /// same edge and has opposite direction.
     252      Arc oppositeArc(const Arc&) const { return INVALID;}
     253
     254      /// \brief Gives back one ending of an edge.
     255      ///
     256      /// Gives back one ending of an edge.
     257      Node u(const Edge&) const { return INVALID;}
     258
     259      /// \brief Gives back the other ending of an edge.
     260      ///
     261      /// Gives back the other ending of an edge.
     262      Node v(const Edge&) const { return INVALID;}
    264263
    265264      template <typename _Graph>
     
    271270        void constraints() {
    272271          checkConcept<BaseDigraphComponent, _Graph>();
    273           checkConcept<GraphItem<'e'>, Edge>();
     272          checkConcept<GraphItem<'u'>, Edge>();
    274273          {
    275274            Node n;
     
    279278            n = graph.v(ue);
    280279            e = graph.direct(ue, true);
    281             e = graph.direct(ue, false);
    282280            e = graph.direct(ue, n);
    283281            e = graph.oppositeArc(e);
     
    293291    };
    294292
    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.
    301     template <typename BAS = BaseDigraphComponent>
    302     class IDableDigraphComponent : public BAS {
    303     public:
    304 
    305       typedef BAS Base;
     293    /// \brief An empty idable base digraph class.
     294    ///
     295    /// This class provides beside the core digraph features
     296    /// core id functions for the digraph structure.
     297    /// The most of the base digraphs should conform to this concept.
     298    /// The id's are unique and immutable.
     299    template <typename _Base = BaseDigraphComponent>
     300    class IDableDigraphComponent : public _Base {
     301    public:
     302
     303      typedef _Base Base;
    306304      typedef typename Base::Node Node;
    307305      typedef typename Base::Arc Arc;
    308306
    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; }
     307      /// \brief Gives back an unique integer id for the Node.
     308      ///
     309      /// Gives back an unique integer id for the Node.
     310      ///
     311      int id(const Node&) const { return -1;}
     312
     313      /// \brief Gives back the node by the unique id.
     314      ///
     315      /// Gives back the node by the unique id.
     316      /// If the digraph does not contain node with the given id
     317      /// then the result of the function is undetermined.
     318      Node nodeFromId(int) const { return INVALID;}
     319
     320      /// \brief Gives back an unique integer id for the Arc.
     321      ///
     322      /// Gives back an unique integer id for the Arc.
     323      ///
     324      int id(const Arc&) const { return -1;}
     325
     326      /// \brief Gives back the arc by the unique id.
     327      ///
     328      /// Gives back the arc by the unique id.
     329      /// If the digraph does not contain arc with the given id
     330      /// then the result of the function is undetermined.
     331      Arc arcFromId(int) const { return INVALID;}
     332
     333      /// \brief Gives back an integer greater or equal to the maximum
     334      /// Node id.
     335      ///
     336      /// Gives back an integer greater or equal to the maximum Node
     337      /// id.
     338      int maxNodeId() const { return -1;}
     339
     340      /// \brief Gives back an integer greater or equal to the maximum
     341      /// Arc id.
     342      ///
     343      /// Gives back an integer greater or equal to the maximum Arc
     344      /// id.
     345      int maxArcId() const { return -1;}
    346346
    347347      template <typename _Digraph>
     
    369369    };
    370370
    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.
    378     template <typename BAS = BaseGraphComponent>
    379     class IDableGraphComponent : public IDableDigraphComponent<BAS> {
    380     public:
    381 
    382       typedef BAS Base;
     371    /// \brief An empty idable base undirected graph class.
     372    ///
     373    /// This class provides beside the core undirected graph features
     374    /// core id functions for the undirected graph structure.  The
     375    /// most of the base undirected graphs should conform to this
     376    /// concept.  The id's are unique and immutable.
     377    template <typename _Base = BaseGraphComponent>
     378    class IDableGraphComponent : public IDableDigraphComponent<_Base> {
     379    public:
     380
     381      typedef _Base Base;
    383382      typedef typename Base::Edge Edge;
    384383
    385       using IDableDigraphComponent<Base>::id;
    386 
    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; }
     384      using IDableDigraphComponent<_Base>::id;
     385
     386      /// \brief Gives back an unique integer id for the Edge.
     387      ///
     388      /// Gives back an unique integer id for the Edge.
     389      ///
     390      int id(const Edge&) const { return -1;}
     391
     392      /// \brief Gives back the edge by the unique id.
     393      ///
     394      /// Gives back the edge by the unique id.  If the
     395      /// graph does not contain arc with the given id then the
     396      /// result of the function is undetermined.
     397      Edge edgeFromId(int) const { return INVALID;}
     398
     399      /// \brief Gives back an integer greater or equal to the maximum
     400      /// Edge id.
     401      ///
     402      /// Gives back an integer greater or equal to the maximum Edge
     403      /// id.
     404      int maxEdgeId() const { return -1;}
    405405
    406406      template <typename _Graph>
     
    408408
    409409        void constraints() {
     410          checkConcept<Base, _Graph >();
    410411          checkConcept<IDableDigraphComponent<Base>, _Graph >();
    411412          typename _Graph::Edge edge;
     
    421422    };
    422423
    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.
    427     template <typename GR, typename Item>
    428     class GraphItemIt : public Item {
     424    /// \brief Skeleton class for graph NodeIt and ArcIt
     425    ///
     426    /// Skeleton class for graph NodeIt and ArcIt.
     427    ///
     428    template <typename _Graph, typename _Item>
     429    class GraphItemIt : public _Item {
    429430    public:
    430431      /// \brief Default constructor.
    431432      ///
    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.
     433      /// @warning The default constructor sets the iterator
     434      /// to an undefined value.
    436435      GraphItemIt() {}
    437 
    438436      /// \brief Copy constructor.
    439437      ///
    440438      /// Copy constructor.
    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.
    446       explicit GraphItemIt(const GR&) {}
    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.
     439      ///
     440      GraphItemIt(const GraphItemIt& ) {}
     441      /// \brief Sets the iterator to the first item.
     442      ///
     443      /// Sets the iterator to the first item of \c the graph.
     444      ///
     445      explicit GraphItemIt(const _Graph&) {}
     446      /// \brief Invalid constructor \& conversion.
     447      ///
     448      /// This constructor initializes the item to be invalid.
    452449      /// \sa Invalid for more details.
    453450      GraphItemIt(Invalid) {}
    454 
    455       /// \brief Assignment operator.
    456       ///
    457       /// Assignment operator for the iterator.
     451      /// \brief Assign operator for items.
     452      ///
     453      /// The items are assignable.
     454      ///
    458455      GraphItemIt& operator=(const GraphItemIt&) { return *this; }
    459 
    460       /// \brief Increment the iterator.
    461       ///
    462       /// This operator increments the iterator, i.e. assigns it to the
    463       /// next item.
     456      /// \brief Next item.
     457      ///
     458      /// Assign the iterator to the next item.
     459      ///
    464460      GraphItemIt& operator++() { return *this; }
    465  
    466461      /// \brief Equality operator
    467462      ///
    468       /// Equality operator.
    469463      /// Two iterators are equal if and only if they point to the
    470464      /// same object or both are invalid.
    471465      bool operator==(const GraphItemIt&) const { return true;}
    472 
    473466      /// \brief Inequality operator
    474467      ///
    475       /// Inequality operator.
    476       /// Two iterators are equal if and only if they point to the
    477       /// same object or both are invalid.
     468      /// \sa operator==(Node n)
     469      ///
    478470      bool operator!=(const GraphItemIt&) const { return true;}
    479471
     
    481473      struct Constraints {
    482474        void constraints() {
    483           checkConcept<GraphItem<>, _GraphItemIt>();
    484475          _GraphItemIt it1(g);
    485476          _GraphItemIt it2;
    486           _GraphItemIt it3 = it1;
    487           _GraphItemIt it4 = INVALID;
    488477
    489478          it2 = ++it1;
     
    491480          ++(++it1);
    492481
    493           Item bi = it1;
     482          _Item bi = it1;
    494483          bi = it2;
    495484        }
    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'.
    510     template <typename GR,
    511               typename Item = typename GR::Arc,
    512               typename Base = typename GR::Node,
    513               char sel = '0'>
    514     class GraphIncIt : public Item {
     485        _Graph& g;
     486      };
     487    };
     488
     489    /// \brief Skeleton class for graph InArcIt and OutArcIt
     490    ///
     491    /// \note Because InArcIt and OutArcIt may not inherit from the same
     492    /// base class, the _selector is a additional template parameter. For
     493    /// InArcIt you should instantiate it with character 'i' and for
     494    /// OutArcIt with 'o'.
     495    template <typename _Graph,
     496              typename _Item = typename _Graph::Arc,
     497              typename _Base = typename _Graph::Node,
     498              char _selector = '0'>
     499    class GraphIncIt : public _Item {
    515500    public:
    516501      /// \brief Default constructor.
    517502      ///
    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.
     503      /// @warning The default constructor sets the iterator
     504      /// to an undefined value.
    522505      GraphIncIt() {}
    523 
    524506      /// \brief Copy constructor.
    525507      ///
    526508      /// Copy constructor.
    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.
    534       explicit GraphIncIt(const GR&, const Base&) {}
    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.
     509      ///
     510      GraphIncIt(GraphIncIt const& gi) : _Item(gi) {}
     511      /// \brief Sets the iterator to the first arc incoming into or outgoing
     512      /// from the node.
     513      ///
     514      /// Sets the iterator to the first arc incoming into or outgoing
     515      /// from the node.
     516      ///
     517      explicit GraphIncIt(const _Graph&, const _Base&) {}
     518      /// \brief Invalid constructor \& conversion.
     519      ///
     520      /// This constructor initializes the item to be invalid.
    540521      /// \sa Invalid for more details.
    541522      GraphIncIt(Invalid) {}
    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.
     523      /// \brief Assign operator for iterators.
     524      ///
     525      /// The iterators are assignable.
     526      ///
     527      GraphIncIt& operator=(GraphIncIt const&) { return *this; }
     528      /// \brief Next item.
     529      ///
     530      /// Assign the iterator to the next item.
     531      ///
    552532      GraphIncIt& operator++() { return *this; }
    553533
    554534      /// \brief Equality operator
    555535      ///
    556       /// Equality operator.
    557536      /// Two iterators are equal if and only if they point to the
    558537      /// same object or both are invalid.
     
    561540      /// \brief Inequality operator
    562541      ///
    563       /// Inequality operator.
    564       /// Two iterators are equal if and only if they point to the
    565       /// same object or both are invalid.
     542      /// \sa operator==(Node n)
     543      ///
    566544      bool operator!=(const GraphIncIt&) const { return true;}
    567545
     
    569547      struct Constraints {
    570548        void constraints() {
    571           checkConcept<GraphItem<sel>, _GraphIncIt>();
     549          checkConcept<GraphItem<_selector>, _GraphIncIt>();
    572550          _GraphIncIt it1(graph, node);
    573551          _GraphIncIt it2;
    574           _GraphIncIt it3 = it1;
    575           _GraphIncIt it4 = INVALID;
    576552
    577553          it2 = ++it1;
    578554          ++it2 = it1;
    579555          ++(++it1);
    580           Item e = it1;
     556          _Item e = it1;
    581557          e = it2;
    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.
     558
     559        }
     560
     561        _Item arc;
     562        _Base node;
     563        _Graph graph;
     564        _GraphIncIt it;
     565      };
     566    };
     567
     568
     569    /// \brief An empty iterable digraph class.
     570    ///
     571    /// This class provides beside the core digraph features
     572    /// iterator based iterable interface for the digraph structure.
    593573    /// This concept is part of the Digraph concept.
    594     template <typename BAS = BaseDigraphComponent>
    595     class IterableDigraphComponent : public BAS {
    596 
    597     public:
    598 
    599       typedef BAS Base;
     574    template <typename _Base = BaseDigraphComponent>
     575    class IterableDigraphComponent : public _Base {
     576
     577    public:
     578
     579      typedef _Base Base;
    600580      typedef typename Base::Node Node;
    601581      typedef typename Base::Arc Arc;
     
    603583      typedef IterableDigraphComponent Digraph;
    604584
    605       /// \name Base Iteration
    606       ///
    607       /// This interface provides functions for iteration on digraph items.
     585      /// \name Base iteration
     586      ///
     587      /// This interface provides functions for iteration on digraph items
    608588      ///
    609589      /// @{
    610590
    611       /// \brief Return the first node.
    612       ///
    613       /// This function gives back the first node in the iteration order.
     591      /// \brief Gives back the first node in the iterating order.
     592      ///
     593      /// Gives back the first node in the iterating order.
     594      ///
    614595      void first(Node&) const {}
    615596
    616       /// \brief Return the next node.
    617       ///
    618       /// This function gives back the next node in the iteration order.
     597      /// \brief Gives back the next node in the iterating order.
     598      ///
     599      /// Gives back the next node in the iterating order.
     600      ///
    619601      void next(Node&) const {}
    620602
    621       /// \brief Return the first arc.
    622       ///
    623       /// This function gives back the first arc in the iteration order.
     603      /// \brief Gives back the first arc in the iterating order.
     604      ///
     605      /// Gives back the first arc in the iterating order.
     606      ///
    624607      void first(Arc&) const {}
    625608
    626       /// \brief Return the next arc.
    627       ///
    628       /// This function gives back the next arc in the iteration order.
     609      /// \brief Gives back the next arc in the iterating order.
     610      ///
     611      /// Gives back the next arc in the iterating order.
     612      ///
    629613      void next(Arc&) const {}
    630614
    631       /// \brief Return the first arc incomming to the given node.
    632       ///
    633       /// This function gives back the first arc incomming to the
     615
     616      /// \brief Gives back the first of the arcs point to the given
     617      /// node.
     618      ///
     619      /// Gives back the first of the arcs point to the given node.
     620      ///
     621      void firstIn(Arc&, const Node&) const {}
     622
     623      /// \brief Gives back the next of the arcs points to the given
     624      /// node.
     625      ///
     626      /// Gives back the next of the arcs points to the given node.
     627      ///
     628      void nextIn(Arc&) const {}
     629
     630      /// \brief Gives back the first of the arcs start from the
    634631      /// given node.
    635       void firstIn(Arc&, const Node&) const {}
    636 
    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.
    641       void nextIn(Arc&) const {}
    642 
    643       /// \brief Return the first arc outgoing form the given node.
    644       ///
    645       /// This function gives back the first arc outgoing form the
    646       /// given node.
     632      ///
     633      /// Gives back the first of the arcs start from the given node.
     634      ///
    647635      void firstOut(Arc&, const Node&) const {}
    648636
    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.
     637      /// \brief Gives back the next of the arcs start from the given
     638      /// node.
     639      ///
     640      /// Gives back the next of the arcs start from the given node.
     641      ///
    653642      void nextOut(Arc&) const {}
    654643
    655644      /// @}
    656645
    657       /// \name Class Based Iteration
    658       ///
    659       /// This interface provides iterator classes for digraph items.
     646      /// \name Class based iteration
     647      ///
     648      /// This interface provides functions for iteration on digraph items
    660649      ///
    661650      /// @{
     
    667656      typedef GraphItemIt<Digraph, Node> NodeIt;
    668657
    669       /// \brief This iterator goes through each arc.
    670       ///
    671       /// This iterator goes through each arc.
     658      /// \brief This iterator goes through each node.
     659      ///
     660      /// This iterator goes through each node.
    672661      ///
    673662      typedef GraphItemIt<Digraph, Arc> ArcIt;
     
    675664      /// \brief This iterator goes trough the incoming arcs of a node.
    676665      ///
    677       /// This iterator goes trough the \e incoming arcs of a certain node
     666      /// This iterator goes trough the \e inccoming arcs of a certain node
    678667      /// of a digraph.
    679668      typedef GraphIncIt<Digraph, Arc, Node, 'i'> InArcIt;
     
    687676      /// \brief The base node of the iterator.
    688677      ///
    689       /// This function gives back the base node of the iterator.
    690       /// It is always the target node of the pointed arc.
     678      /// Gives back the base node of the iterator.
     679      /// It is always the target of the pointed arc.
    691680      Node baseNode(const InArcIt&) const { return INVALID; }
    692681
    693682      /// \brief The running node of the iterator.
    694683      ///
    695       /// This function gives back the running node of the iterator.
    696       /// It is always the source node of the pointed arc.
     684      /// Gives back the running node of the iterator.
     685      /// It is always the source of the pointed arc.
    697686      Node runningNode(const InArcIt&) const { return INVALID; }
    698687
    699688      /// \brief The base node of the iterator.
    700689      ///
    701       /// This function gives back the base node of the iterator.
    702       /// It is always the source node of the pointed arc.
     690      /// Gives back the base node of the iterator.
     691      /// It is always the source of the pointed arc.
    703692      Node baseNode(const OutArcIt&) const { return INVALID; }
    704693
    705694      /// \brief The running node of the iterator.
    706695      ///
    707       /// This function gives back the running node of the iterator.
    708       /// It is always the target node of the pointed arc.
     696      /// Gives back the running node of the iterator.
     697      /// It is always the target of the pointed arc.
    709698      Node runningNode(const OutArcIt&) const { return INVALID; }
    710699
     
    748737
    749738            typename _Digraph::Node n;
    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);
     739            typename _Digraph::InArcIt ieit(INVALID);
     740            typename _Digraph::OutArcIt oeit(INVALID);
     741            n = digraph.baseNode(ieit);
     742            n = digraph.runningNode(ieit);
     743            n = digraph.baseNode(oeit);
     744            n = digraph.runningNode(oeit);
    756745            ignore_unused_variable_warning(n);
    757746          }
     
    759748
    760749        const _Digraph& digraph;
    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.
     750
     751      };
     752    };
     753
     754    /// \brief An empty iterable undirected graph class.
     755    ///
     756    /// This class provides beside the core graph features iterator
     757    /// based iterable interface for the undirected graph structure.
    769758    /// This concept is part of the Graph concept.
    770     template <typename BAS = BaseGraphComponent>
    771     class IterableGraphComponent : public IterableDigraphComponent<BAS> {
    772     public:
    773 
    774       typedef BAS Base;
     759    template <typename _Base = BaseGraphComponent>
     760    class IterableGraphComponent : public IterableDigraphComponent<_Base> {
     761    public:
     762
     763      typedef _Base Base;
    775764      typedef typename Base::Node Node;
    776765      typedef typename Base::Arc Arc;
     
    780769      typedef IterableGraphComponent Graph;
    781770
    782       /// \name Base Iteration
    783       ///
    784       /// This interface provides functions for iteration on edges.
    785       ///
     771      /// \name Base iteration
     772      ///
     773      /// This interface provides functions for iteration on graph items
    786774      /// @{
    787775
    788       using IterableDigraphComponent<Base>::first;
    789       using IterableDigraphComponent<Base>::next;
    790 
    791       /// \brief Return the first edge.
    792       ///
    793       /// This function gives back the first edge in the iteration order.
     776      using IterableDigraphComponent<_Base>::first;
     777      using IterableDigraphComponent<_Base>::next;
     778
     779      /// \brief Gives back the first edge in the iterating
     780      /// order.
     781      ///
     782      /// Gives back the first edge in the iterating order.
     783      ///
    794784      void first(Edge&) const {}
    795785
    796       /// \brief Return the next edge.
    797       ///
    798       /// This function gives back the next edge in the iteration order.
     786      /// \brief Gives back the next edge in the iterating
     787      /// order.
     788      ///
     789      /// Gives back the next edge in the iterating order.
     790      ///
    799791      void next(Edge&) const {}
    800792
    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
     793
     794      /// \brief Gives back the first of the edges from the
    806795      /// given node.
     796      ///
     797      /// Gives back the first of the edges from the given
     798      /// node. The bool parameter gives back that direction which
     799      /// gives a good direction of the edge so the source of the
     800      /// directed arc is the given node.
    807801      void firstInc(Edge&, bool&, const Node&) const {}
    808802
     
    810804      /// given node.
    811805      ///
    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.
     806      /// Gives back the next of the edges from the given
     807      /// node. The bool parameter should be used as the \c firstInc()
     808      /// use it.
    814809      void nextInc(Edge&, bool&) const {}
    815810
    816       using IterableDigraphComponent<Base>::baseNode;
    817       using IterableDigraphComponent<Base>::runningNode;
     811      using IterableDigraphComponent<_Base>::baseNode;
     812      using IterableDigraphComponent<_Base>::runningNode;
    818813
    819814      /// @}
    820815
    821       /// \name Class Based Iteration
    822       ///
    823       /// This interface provides iterator classes for edges.
     816      /// \name Class based iteration
     817      ///
     818      /// This interface provides functions for iteration on graph items
    824819      ///
    825820      /// @{
    826821
    827       /// \brief This iterator goes through each edge.
    828       ///
    829       /// This iterator goes through each edge.
     822      /// \brief This iterator goes through each node.
     823      ///
     824      /// This iterator goes through each node.
    830825      typedef GraphItemIt<Graph, Edge> EdgeIt;
    831 
    832       /// \brief This iterator goes trough the incident edges of a
     826      /// \brief This iterator goes trough the incident arcs of a
    833827      /// node.
    834828      ///
    835       /// This iterator goes trough the incident edges of a certain
     829      /// This iterator goes trough the incident arcs of a certain
    836830      /// node of a graph.
    837       typedef GraphIncIt<Graph, Edge, Node, 'e'> IncEdgeIt;
    838 
     831      typedef GraphIncIt<Graph, Edge, Node, 'u'> IncEdgeIt;
    839832      /// \brief The base node of the iterator.
    840833      ///
    841       /// This function gives back the base node of the iterator.
     834      /// Gives back the base node of the iterator.
    842835      Node baseNode(const IncEdgeIt&) const { return INVALID; }
    843836
    844837      /// \brief The running node of the iterator.
    845838      ///
    846       /// This function gives back the running node of the iterator.
     839      /// Gives back the running node of the iterator.
    847840      Node runningNode(const IncEdgeIt&) const { return INVALID; }
    848841
     
    873866              typename _Graph::EdgeIt >();
    874867            checkConcept<GraphIncIt<_Graph, typename _Graph::Edge,
    875               typename _Graph::Node, 'e'>, typename _Graph::IncEdgeIt>();
     868              typename _Graph::Node, 'u'>, typename _Graph::IncEdgeIt>();
    876869
    877870            typename _Graph::Node n;
    878             const typename _Graph::IncEdgeIt ieit(INVALID);
    879             n = graph.baseNode(ieit);
    880             n = graph.runningNode(ieit);
     871            typename _Graph::IncEdgeIt ueit(INVALID);
     872            n = graph.baseNode(ueit);
     873            n = graph.runningNode(ueit);
    881874          }
    882875        }
    883876
    884877        const _Graph& graph;
    885       };
    886     };
    887 
    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
     878
     879      };
     880    };
     881
     882    /// \brief An empty alteration notifier digraph class.
     883    ///
     884    /// This class provides beside the core digraph features alteration
     885    /// notifier interface for the digraph structure.  This implements
    893886    /// an observer-notifier pattern for each digraph item. More
    894887    /// obsevers can be registered into the notifier and whenever an
    895     /// alteration occured in the digraph all the observers will be
     888    /// alteration occured in the digraph all the observers will
    896889    /// notified about it.
    897     template <typename BAS = BaseDigraphComponent>
    898     class AlterableDigraphComponent : public BAS {
    899     public:
    900 
    901       typedef BAS Base;
     890    template <typename _Base = BaseDigraphComponent>
     891    class AlterableDigraphComponent : public _Base {
     892    public:
     893
     894      typedef _Base Base;
    902895      typedef typename Base::Node Node;
    903896      typedef typename Base::Arc Arc;
    904897
    905898
    906       /// Node alteration notifier class.
     899      /// The node observer registry.
    907900      typedef AlterationNotifier<AlterableDigraphComponent, Node>
    908901      NodeNotifier;
    909       /// Arc alteration notifier class.
     902      /// The arc observer registry.
    910903      typedef AlterationNotifier<AlterableDigraphComponent, Arc>
    911904      ArcNotifier;
    912905
    913       /// \brief Return the node alteration notifier.
    914       ///
    915       /// This function gives back the node alteration notifier.
     906      /// \brief Gives back the node alteration notifier.
     907      ///
     908      /// Gives back the node alteration notifier.
    916909      NodeNotifier& notifier(Node) const {
    917          return NodeNotifier();
     910        return NodeNotifier();
    918911      }
    919912
    920       /// \brief Return the arc alteration notifier.
    921       ///
    922       /// This function gives back the arc alteration notifier.
     913      /// \brief Gives back the arc alteration notifier.
     914      ///
     915      /// Gives back the arc alteration notifier.
    923916      ArcNotifier& notifier(Arc) const {
    924917        return ArcNotifier();
     
    940933
    941934        const _Digraph& digraph;
    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
     935
     936      };
     937
     938    };
     939
     940    /// \brief An empty alteration notifier undirected graph class.
     941    ///
     942    /// This class provides beside the core graph features alteration
     943    /// notifier interface for the graph structure.  This implements
     944    /// an observer-notifier pattern for each graph item. More
    951945    /// obsevers can be registered into the notifier and whenever an
    952     /// alteration occured in the graph all the observers will be
     946    /// alteration occured in the graph all the observers will
    953947    /// notified about it.
    954     template <typename BAS = BaseGraphComponent>
    955     class AlterableGraphComponent : public AlterableDigraphComponent<BAS> {
    956     public:
    957 
    958       typedef BAS Base;
     948    template <typename _Base = BaseGraphComponent>
     949    class AlterableGraphComponent : public AlterableDigraphComponent<_Base> {
     950    public:
     951
     952      typedef _Base Base;
    959953      typedef typename Base::Edge Edge;
    960954
    961955
    962       /// Edge alteration notifier class.
     956      /// The arc observer registry.
    963957      typedef AlterationNotifier<AlterableGraphComponent, Edge>
    964958      EdgeNotifier;
    965959
    966       /// \brief Return the edge alteration notifier.
    967       ///
    968       /// This function gives back the edge alteration notifier.
     960      /// \brief Gives back the arc alteration notifier.
     961      ///
     962      /// Gives back the arc alteration notifier.
    969963      EdgeNotifier& notifier(Edge) const {
    970964        return EdgeNotifier();
     
    974968      struct Constraints {
    975969        void constraints() {
    976           checkConcept<AlterableDigraphComponent<Base>, _Graph>();
     970          checkConcept<AlterableGraphComponent<Base>, _Graph>();
    977971          typename _Graph::EdgeNotifier& uen
    978972            = graph.notifier(typename _Graph::Edge());
     
    981975
    982976        const _Graph& graph;
    983       };
    984     };
    985 
    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.
    991     /// The standard graph maps must conform to the ReferenceMap concept.
    992     template <typename GR, typename K, typename V>
    993     class GraphMap : public ReferenceMap<K, V, V&, const V&> {
    994     public:
    995 
    996       typedef ReadWriteMap<K, V> Parent;
     977
     978      };
     979
     980    };
     981
     982    /// \brief Class describing the concept of graph maps
     983    ///
     984    /// This class describes the common interface of the graph maps
     985    /// (NodeMap, ArcMap), that is maps that can be used to
     986    /// associate data to graph descriptors (nodes or arcs).
     987    template <typename _Graph, typename _Item, typename _Value>
     988    class GraphMap : public ReadWriteMap<_Item, _Value> {
     989    public:
     990
     991      typedef ReadWriteMap<_Item, _Value> Parent;
    997992
    998993      /// The graph type of the map.
    999       typedef GR Graph;
     994      typedef _Graph Graph;
    1000995      /// The key type of the map.
    1001       typedef K Key;
     996      typedef _Item Key;
    1002997      /// The value type of the map.
    1003       typedef V Value;
    1004       /// The reference type of the map.
    1005       typedef Value& Reference;
    1006       /// The const reference type of the map.
    1007       typedef const Value& ConstReference;
    1008 
    1009       // The reference map tag.
    1010       typedef True ReferenceMapTag;
     998      typedef _Value Value;
    1011999
    10121000      /// \brief Construct a new map.
     
    10161004      /// \brief Construct a new map with default value.
    10171005      ///
    1018       /// Construct a new map for the graph and initalize the values.
     1006      /// Construct a new map for the graph and initalise the values.
    10191007      GraphMap(const Graph&, const Value&) {}
    10201008
     
    10251013      GraphMap(const GraphMap&) : Parent() {}
    10261014
    1027       /// \brief Assignment operator.
    1028       ///
    1029       /// Assignment operator. It does not mofify the underlying graph,
     1015      /// \brief Assign operator.
     1016      ///
     1017      /// Assign operator. It does not mofify the underlying graph,
    10301018      /// it just iterates on the current item set and set the  map
    10311019      /// with the value returned by the assigned map.
     
    10401028      struct Constraints {
    10411029        void constraints() {
    1042           checkConcept
    1043             <ReferenceMap<Key, Value, Value&, const Value&>, _Map>();
    1044           _Map m1(g);
    1045           _Map m2(g,t);
    1046          
    1047           // Copy constructor
    1048           // _Map m3(m);
    1049 
    1050           // Assignment operator
     1030          checkConcept<ReadWriteMap<Key, Value>, _Map >();
     1031          // Construction with a graph parameter
     1032          _Map a(g);
     1033          // Constructor with a graph and a default value parameter
     1034          _Map a2(g,t);
     1035          // Copy constructor.
     1036          // _Map b(c);
     1037
    10511038          // ReadMap<Key, Value> cmap;
    1052           // m3 = cmap;
    1053 
    1054           ignore_unused_variable_warning(m1);
    1055           ignore_unused_variable_warning(m2);
    1056           // ignore_unused_variable_warning(m3);
    1057         }
    1058 
    1059         const _Map &m;
     1039          // b = cmap;
     1040
     1041          ignore_unused_variable_warning(a);
     1042          ignore_unused_variable_warning(a2);
     1043          // ignore_unused_variable_warning(b);
     1044        }
     1045
     1046        const _Map &c;
    10601047        const Graph &g;
    10611048        const typename GraphMap::Value &t;
     
    10641051    };
    10651052
    1066     /// \brief Skeleton class for mappable directed graphs.
    1067     ///
    1068     /// This class describes the interface of mappable directed graphs.
    1069     /// It extends \ref BaseDigraphComponent with the standard digraph
    1070     /// map classes, namely \c NodeMap and \c ArcMap.
     1053    /// \brief An empty mappable digraph class.
     1054    ///
     1055    /// This class provides beside the core digraph features
     1056    /// map interface for the digraph structure.
    10711057    /// This concept is part of the Digraph concept.
    1072     template <typename BAS = BaseDigraphComponent>
    1073     class MappableDigraphComponent : public BAS  {
    1074     public:
    1075 
    1076       typedef BAS Base;
     1058    template <typename _Base = BaseDigraphComponent>
     1059    class MappableDigraphComponent : public _Base  {
     1060    public:
     1061
     1062      typedef _Base Base;
    10771063      typedef typename Base::Node Node;
    10781064      typedef typename Base::Arc Arc;
     
    10801066      typedef MappableDigraphComponent Digraph;
    10811067
    1082       /// \brief Standard graph map for the nodes.
    1083       ///
    1084       /// Standard graph map for the nodes.
    1085       /// It conforms to the ReferenceMap concept.
    1086       template <typename V>
    1087       class NodeMap : public GraphMap<MappableDigraphComponent, Node, V> {
     1068      /// \brief ReadWrite map of the nodes.
     1069      ///
     1070      /// ReadWrite map of the nodes.
     1071      ///
     1072      template <typename _Value>
     1073      class NodeMap : public GraphMap<Digraph, Node, _Value> {
    10881074      public:
    1089         typedef GraphMap<MappableDigraphComponent, Node, V> Parent;
     1075        typedef GraphMap<MappableDigraphComponent, Node, _Value> Parent;
    10901076
    10911077        /// \brief Construct a new map.
     
    10971083        /// \brief Construct a new map with default value.
    10981084        ///
    1099         /// Construct a new map for the digraph and initalize the values.
    1100         NodeMap(const MappableDigraphComponent& digraph, const V& value)
     1085        /// Construct a new map for the digraph and initalise the values.
     1086        NodeMap(const MappableDigraphComponent& digraph, const _Value& value)
    11011087          : Parent(digraph, value) {}
    11021088
     
    11071093        NodeMap(const NodeMap& nm) : Parent(nm) {}
    11081094
    1109         /// \brief Assignment operator.
    1110         ///
    1111         /// Assignment operator.
     1095        /// \brief Assign operator.
     1096        ///
     1097        /// Assign operator.
    11121098        template <typename CMap>
    11131099        NodeMap& operator=(const CMap&) {
    1114           checkConcept<ReadMap<Node, V>, CMap>();
     1100          checkConcept<ReadMap<Node, _Value>, CMap>();
    11151101          return *this;
    11161102        }
     
    11181104      };
    11191105
    1120       /// \brief Standard graph map for the arcs.
    1121       ///
    1122       /// Standard graph map for the arcs.
    1123       /// It conforms to the ReferenceMap concept.
    1124       template <typename V>
    1125       class ArcMap : public GraphMap<MappableDigraphComponent, Arc, V> {
     1106      /// \brief ReadWrite map of the arcs.
     1107      ///
     1108      /// ReadWrite map of the arcs.
     1109      ///
     1110      template <typename _Value>
     1111      class ArcMap : public GraphMap<Digraph, Arc, _Value> {
    11261112      public:
    1127         typedef GraphMap<MappableDigraphComponent, Arc, V> Parent;
     1113        typedef GraphMap<MappableDigraphComponent, Arc, _Value> Parent;
    11281114
    11291115        /// \brief Construct a new map.
     
    11351121        /// \brief Construct a new map with default value.
    11361122        ///
    1137         /// Construct a new map for the digraph and initalize the values.
    1138         ArcMap(const MappableDigraphComponent& digraph, const V& value)
     1123        /// Construct a new map for the digraph and initalise the values.
     1124        ArcMap(const MappableDigraphComponent& digraph, const _Value& value)
    11391125          : Parent(digraph, value) {}
    11401126
     
    11451131        ArcMap(const ArcMap& nm) : Parent(nm) {}
    11461132
    1147         /// \brief Assignment operator.
    1148         ///
    1149         /// Assignment operator.
     1133        /// \brief Assign operator.
     1134        ///
     1135        /// Assign operator.
    11501136        template <typename CMap>
    11511137        ArcMap& operator=(const CMap&) {
    1152           checkConcept<ReadMap<Arc, V>, CMap>();
     1138          checkConcept<ReadMap<Arc, _Value>, CMap>();
    11531139          return *this;
    11541140        }
     
    11971183        }
    11981184
    1199         const _Digraph& digraph;
    1200       };
    1201     };
    1202 
    1203     /// \brief Skeleton class for mappable undirected graphs.
    1204     ///
    1205     /// This class describes the interface of mappable undirected graphs.
    1206     /// It extends \ref MappableDigraphComponent with the standard graph
    1207     /// map class for edges (\c EdgeMap).
     1185        _Digraph& digraph;
     1186      };
     1187    };
     1188
     1189    /// \brief An empty mappable base bipartite graph class.
     1190    ///
     1191    /// This class provides beside the core graph features
     1192    /// map interface for the graph structure.
    12081193    /// This concept is part of the Graph concept.
    1209     template <typename BAS = BaseGraphComponent>
    1210     class MappableGraphComponent : public MappableDigraphComponent<BAS>  {
    1211     public:
    1212 
    1213       typedef BAS Base;
     1194    template <typename _Base = BaseGraphComponent>
     1195    class MappableGraphComponent : public MappableDigraphComponent<_Base>  {
     1196    public:
     1197
     1198      typedef _Base Base;
    12141199      typedef typename Base::Edge Edge;
    12151200
    12161201      typedef MappableGraphComponent Graph;
    12171202
    1218       /// \brief Standard graph map for the edges.
    1219       ///
    1220       /// Standard graph map for the edges.
    1221       /// It conforms to the ReferenceMap concept.
    1222       template <typename V>
    1223       class EdgeMap : public GraphMap<MappableGraphComponent, Edge, V> {
     1203      /// \brief ReadWrite map of the edges.
     1204      ///
     1205      /// ReadWrite map of the edges.
     1206      ///
     1207      template <typename _Value>
     1208      class EdgeMap : public GraphMap<Graph, Edge, _Value> {
    12241209      public:
    1225         typedef GraphMap<MappableGraphComponent, Edge, V> Parent;
     1210        typedef GraphMap<MappableGraphComponent, Edge, _Value> Parent;
    12261211
    12271212        /// \brief Construct a new map.
     
    12331218        /// \brief Construct a new map with default value.
    12341219        ///
    1235         /// Construct a new map for the graph and initalize the values.
    1236         EdgeMap(const MappableGraphComponent& graph, const V& value)
     1220        /// Construct a new map for the graph and initalise the values.
     1221        EdgeMap(const MappableGraphComponent& graph, const _Value& value)
    12371222          : Parent(graph, value) {}
    12381223
     
    12431228        EdgeMap(const EdgeMap& nm) : Parent(nm) {}
    12441229
    1245         /// \brief Assignment operator.
    1246         ///
    1247         /// Assignment operator.
     1230        /// \brief Assign operator.
     1231        ///
     1232        /// Assign operator.
    12481233        template <typename CMap>
    12491234        EdgeMap& operator=(const CMap&) {
    1250           checkConcept<ReadMap<Edge, V>, CMap>();
     1235          checkConcept<ReadMap<Edge, _Value>, CMap>();
    12511236          return *this;
    12521237        }
     
    12651250
    12661251        void constraints() {
    1267           checkConcept<MappableDigraphComponent<Base>, _Graph>();
     1252          checkConcept<MappableGraphComponent<Base>, _Graph>();
    12681253
    12691254          { // int map test
     
    12821267        }
    12831268
    1284         const _Graph& graph;
    1285       };
    1286     };
    1287 
    1288     /// \brief Skeleton class for extendable directed graphs.
    1289     ///
    1290     /// This class describes the interface of extendable directed graphs.
    1291     /// It extends \ref BaseDigraphComponent with functions for adding
    1292     /// nodes and arcs to the digraph.
    1293     /// This concept requires \ref AlterableDigraphComponent.
    1294     template <typename BAS = BaseDigraphComponent>
    1295     class ExtendableDigraphComponent : public BAS {
    1296     public:
    1297       typedef BAS Base;
    1298 
    1299       typedef typename Base::Node Node;
    1300       typedef typename Base::Arc Arc;
    1301 
    1302       /// \brief Add a new node to the digraph.
    1303       ///
    1304       /// This function adds a new node to the digraph.
     1269        _Graph& graph;
     1270      };
     1271    };
     1272
     1273    /// \brief An empty extendable digraph class.
     1274    ///
     1275    /// This class provides beside the core digraph features digraph
     1276    /// extendable interface for the digraph structure.  The main
     1277    /// difference between the base and this interface is that the
     1278    /// digraph alterations should handled already on this level.
     1279    template <typename _Base = BaseDigraphComponent>
     1280    class ExtendableDigraphComponent : public _Base {
     1281    public:
     1282      typedef _Base Base;
     1283
     1284      typedef typename _Base::Node Node;
     1285      typedef typename _Base::Arc Arc;
     1286
     1287      /// \brief Adds a new node to the digraph.
     1288      ///
     1289      /// Adds a new node to the digraph.
     1290      ///
    13051291      Node addNode() {
    13061292        return INVALID;
    13071293      }
    13081294
    1309       /// \brief Add a new arc connecting the given two nodes.
    1310       ///
    1311       /// This function adds a new arc connecting the given two nodes
    1312       /// of the digraph.
     1295      /// \brief Adds a new arc connects the given two nodes.
     1296      ///
     1297      /// Adds a new arc connects the the given two nodes.
    13131298      Arc addArc(const Node&, const Node&) {
    13141299        return INVALID;
     
    13301315    };
    13311316
    1332     /// \brief Skeleton class for extendable undirected graphs.
    1333     ///
    1334     /// This class describes the interface of extendable undirected graphs.
    1335     /// It extends \ref BaseGraphComponent with functions for adding
    1336     /// nodes and edges to the graph.
    1337     /// This concept requires \ref AlterableGraphComponent.
    1338     template <typename BAS = BaseGraphComponent>
    1339     class ExtendableGraphComponent : public BAS {
    1340     public:
    1341 
    1342       typedef BAS Base;
    1343       typedef typename Base::Node Node;
    1344       typedef typename Base::Edge Edge;
    1345 
    1346       /// \brief Add a new node to the digraph.
    1347       ///
    1348       /// This function adds a new node to the digraph.
     1317    /// \brief An empty extendable base undirected graph class.
     1318    ///
     1319    /// This class provides beside the core undirected graph features
     1320    /// core undircted graph extend interface for the graph structure.
     1321    /// The main difference between the base and this interface is
     1322    /// that the graph alterations should handled already on this
     1323    /// level.
     1324    template <typename _Base = BaseGraphComponent>
     1325    class ExtendableGraphComponent : public _Base {
     1326    public:
     1327
     1328      typedef _Base Base;
     1329      typedef typename _Base::Node Node;
     1330      typedef typename _Base::Edge Edge;
     1331
     1332      /// \brief Adds a new node to the graph.
     1333      ///
     1334      /// Adds a new node to the graph.
     1335      ///
    13491336      Node addNode() {
    13501337        return INVALID;
    13511338      }
    13521339
    1353       /// \brief Add a new edge connecting the given two nodes.
    1354       ///
    1355       /// This function adds a new edge connecting the given two nodes
    1356       /// of the graph.
    1357       Edge addEdge(const Node&, const Node&) {
     1340      /// \brief Adds a new arc connects the given two nodes.
     1341      ///
     1342      /// Adds a new arc connects the the given two nodes.
     1343      Edge addArc(const Node&, const Node&) {
    13581344        return INVALID;
    13591345      }
     
    13741360    };
    13751361
    1376     /// \brief Skeleton class for erasable directed graphs.
    1377     ///
    1378     /// This class describes the interface of erasable directed graphs.
    1379     /// It extends \ref BaseDigraphComponent with functions for removing
    1380     /// nodes and arcs from the digraph.
    1381     /// This concept requires \ref AlterableDigraphComponent.
    1382     template <typename BAS = BaseDigraphComponent>
    1383     class ErasableDigraphComponent : public BAS {
    1384     public:
    1385 
    1386       typedef BAS Base;
     1362    /// \brief An empty erasable digraph class.
     1363    ///
     1364    /// This class provides beside the core digraph features core erase
     1365    /// functions for the digraph structure. The main difference between
     1366    /// the base and this interface is that the digraph alterations
     1367    /// should handled already on this level.
     1368    template <typename _Base = BaseDigraphComponent>
     1369    class ErasableDigraphComponent : public _Base {
     1370    public:
     1371
     1372      typedef _Base Base;
    13871373      typedef typename Base::Node Node;
    13881374      typedef typename Base::Arc Arc;
     
    13901376      /// \brief Erase a node from the digraph.
    13911377      ///
    1392       /// This function erases the given node from the digraph and all arcs
    1393       /// connected to the node.
     1378      /// Erase a node from the digraph. This function should
     1379      /// erase all arcs connecting to the node.
    13941380      void erase(const Node&) {}
    13951381
    13961382      /// \brief Erase an arc from the digraph.
    13971383      ///
    1398       /// This function erases the given arc from the digraph.
     1384      /// Erase an arc from the digraph.
     1385      ///
    13991386      void erase(const Arc&) {}
    14001387
     
    14031390        void constraints() {
    14041391          checkConcept<Base, _Digraph>();
    1405           const typename _Digraph::Node node(INVALID);
     1392          typename _Digraph::Node node;
    14061393          digraph.erase(node);
    1407           const typename _Digraph::Arc arc(INVALID);
     1394          typename _Digraph::Arc arc;
    14081395          digraph.erase(arc);
    14091396        }
     
    14131400    };
    14141401
    1415     /// \brief Skeleton class for erasable undirected graphs.
    1416     ///
    1417     /// This class describes the interface of erasable undirected graphs.
    1418     /// It extends \ref BaseGraphComponent with functions for removing
    1419     /// nodes and edges from the graph.
    1420     /// This concept requires \ref AlterableGraphComponent.
    1421     template <typename BAS = BaseGraphComponent>
    1422     class ErasableGraphComponent : public BAS {
    1423     public:
    1424 
    1425       typedef BAS Base;
     1402    /// \brief An empty erasable base undirected graph class.
     1403    ///
     1404    /// This class provides beside the core undirected graph features
     1405    /// core erase functions for the undirceted graph structure. The
     1406    /// main difference between the base and this interface is that
     1407    /// the graph alterations should handled already on this level.
     1408    template <typename _Base = BaseGraphComponent>
     1409    class ErasableGraphComponent : public _Base {
     1410    public:
     1411
     1412      typedef _Base Base;
    14261413      typedef typename Base::Node Node;
    14271414      typedef typename Base::Edge Edge;
     
    14291416      /// \brief Erase a node from the graph.
    14301417      ///
    1431       /// This function erases the given node from the graph and all edges
    1432       /// connected to the node.
     1418      /// Erase a node from the graph. This function should erase
     1419      /// arcs connecting to the node.
    14331420      void erase(const Node&) {}
    14341421
    1435       /// \brief Erase an edge from the digraph.
    1436       ///
    1437       /// This function erases the given edge from the digraph.
     1422      /// \brief Erase an arc from the graph.
     1423      ///
     1424      /// Erase an arc from the graph.
     1425      ///
    14381426      void erase(const Edge&) {}
    14391427
     
    14421430        void constraints() {
    14431431          checkConcept<Base, _Graph>();
    1444           const typename _Graph::Node node(INVALID);
     1432          typename _Graph::Node node;
    14451433          graph.erase(node);
    1446           const typename _Graph::Edge edge(INVALID);
     1434          typename _Graph::Edge edge;
    14471435          graph.erase(edge);
    14481436        }
     
    14521440    };
    14531441
    1454     /// \brief Skeleton class for clearable directed graphs.
    1455     ///
    1456     /// This class describes the interface of clearable directed graphs.
    1457     /// It extends \ref BaseDigraphComponent with a function for clearing
    1458     /// the digraph.
    1459     /// This concept requires \ref AlterableDigraphComponent.
    1460     template <typename BAS = BaseDigraphComponent>
    1461     class ClearableDigraphComponent : public BAS {
    1462     public:
    1463 
    1464       typedef BAS Base;
     1442    /// \brief An empty clearable base digraph class.
     1443    ///
     1444    /// This class provides beside the core digraph features core clear
     1445    /// functions for the digraph structure. The main difference between
     1446    /// the base and this interface is that the digraph alterations
     1447    /// should handled already on this level.
     1448    template <typename _Base = BaseDigraphComponent>
     1449    class ClearableDigraphComponent : public _Base {
     1450    public:
     1451
     1452      typedef _Base Base;
    14651453
    14661454      /// \brief Erase all nodes and arcs from the digraph.
    14671455      ///
    1468       /// This function erases all nodes and arcs from the digraph.
     1456      /// Erase all nodes and arcs from the digraph.
     1457      ///
    14691458      void clear() {}
    14701459
     
    14761465        }
    14771466
    1478         _Digraph& digraph;
    1479       };
    1480     };
    1481 
    1482     /// \brief Skeleton class for clearable undirected graphs.
    1483     ///
    1484     /// This class describes the interface of clearable undirected graphs.
    1485     /// It extends \ref BaseGraphComponent with a function for clearing
    1486     /// the graph.
    1487     /// This concept requires \ref AlterableGraphComponent.
    1488     template <typename BAS = BaseGraphComponent>
    1489     class ClearableGraphComponent : public ClearableDigraphComponent<BAS> {
    1490     public:
    1491 
    1492       typedef BAS Base;
    1493 
    1494       /// \brief Erase all nodes and edges from the graph.
    1495       ///
    1496       /// This function erases all nodes and edges from the graph.
    1497       void clear() {}
     1467        _Digraph digraph;
     1468      };
     1469    };
     1470
     1471    /// \brief An empty clearable base undirected graph class.
     1472    ///
     1473    /// This class provides beside the core undirected graph features
     1474    /// core clear functions for the undirected graph structure. The
     1475    /// main difference between the base and this interface is that
     1476    /// the graph alterations should handled already on this level.
     1477    template <typename _Base = BaseGraphComponent>
     1478    class ClearableGraphComponent : public ClearableDigraphComponent<_Base> {
     1479    public:
     1480
     1481      typedef _Base Base;
    14981482
    14991483      template <typename _Graph>
    15001484      struct Constraints {
    15011485        void constraints() {
    1502           checkConcept<Base, _Graph>();
    1503           graph.clear();
    1504         }
    1505 
    1506         _Graph& graph;
     1486          checkConcept<ClearableGraphComponent<Base>, _Graph>();
     1487        }
     1488
     1489        _Graph graph;
    15071490      };
    15081491    };
Note: See TracChangeset for help on using the changeset viewer.