1.1 --- a/lemon/concepts/graph_components.h Wed Mar 17 12:35:52 2010 +0100
1.2 +++ b/lemon/concepts/graph_components.h Sat Mar 06 14:35:12 2010 +0000
1.3 @@ -2,7 +2,7 @@
1.4 *
1.5 * This file is a part of LEMON, a generic C++ optimization library.
1.6 *
1.7 - * Copyright (C) 2003-2009
1.8 + * Copyright (C) 2003-2010
1.9 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
1.10 * (Egervary Research Group on Combinatorial Optimization, EGRES).
1.11 *
1.12 @@ -38,7 +38,7 @@
1.13 ///
1.14 /// \note This class is a template class so that we can use it to
1.15 /// create graph skeleton classes. The reason for this is that \c Node
1.16 - /// and \c Arc (or \c Edge) types should \e not derive from the same
1.17 + /// and \c Arc (or \c Edge) types should \e not derive from the same
1.18 /// base class. For \c Node you should instantiate it with character
1.19 /// \c 'n', for \c Arc with \c 'a' and for \c Edge with \c 'e'.
1.20 #ifndef DOXYGEN
1.21 @@ -89,7 +89,7 @@
1.22 /// \brief Ordering operator.
1.23 ///
1.24 /// This operator defines an ordering of the items.
1.25 - /// It makes possible to use graph item types as key types in
1.26 + /// It makes possible to use graph item types as key types in
1.27 /// associative containers (e.g. \c std::map).
1.28 ///
1.29 /// \note This operator only has to define some strict ordering of
1.30 @@ -122,7 +122,7 @@
1.31 ///
1.32 /// This class describes the base interface of directed graph types.
1.33 /// All digraph %concepts have to conform to this class.
1.34 - /// It just provides types for nodes and arcs and functions
1.35 + /// It just provides types for nodes and arcs and functions
1.36 /// to get the source and the target nodes of arcs.
1.37 class BaseDigraphComponent {
1.38 public:
1.39 @@ -426,7 +426,7 @@
1.40
1.41 /// \brief Concept class for \c NodeIt, \c ArcIt and \c EdgeIt types.
1.42 ///
1.43 - /// This class describes the concept of \c NodeIt, \c ArcIt and
1.44 + /// This class describes the concept of \c NodeIt, \c ArcIt and
1.45 /// \c EdgeIt subtypes of digraph and graph types.
1.46 template <typename GR, typename Item>
1.47 class GraphItemIt : public Item {
1.48 @@ -466,7 +466,7 @@
1.49 /// This operator increments the iterator, i.e. assigns it to the
1.50 /// next item.
1.51 GraphItemIt& operator++() { return *this; }
1.52 -
1.53 +
1.54 /// \brief Equality operator
1.55 ///
1.56 /// Equality operator.
1.57 @@ -501,15 +501,15 @@
1.58 };
1.59 };
1.60
1.61 - /// \brief Concept class for \c InArcIt, \c OutArcIt and
1.62 + /// \brief Concept class for \c InArcIt, \c OutArcIt and
1.63 /// \c IncEdgeIt types.
1.64 ///
1.65 - /// This class describes the concept of \c InArcIt, \c OutArcIt
1.66 + /// This class describes the concept of \c InArcIt, \c OutArcIt
1.67 /// and \c IncEdgeIt subtypes of digraph and graph types.
1.68 ///
1.69 /// \note Since these iterator classes do not inherit from the same
1.70 /// base class, there is an additional template parameter (selector)
1.71 - /// \c sel. For \c InArcIt you should instantiate it with character
1.72 + /// \c sel. For \c InArcIt you should instantiate it with character
1.73 /// \c 'i', for \c OutArcIt with \c 'o' and for \c IncEdgeIt with \c 'e'.
1.74 template <typename GR,
1.75 typename Item = typename GR::Arc,
1.76 @@ -530,10 +530,10 @@
1.77 /// Copy constructor.
1.78 GraphIncIt(const GraphIncIt& it) : Item(it) {}
1.79
1.80 - /// \brief Constructor that sets the iterator to the first
1.81 + /// \brief Constructor that sets the iterator to the first
1.82 /// incoming or outgoing arc.
1.83 ///
1.84 - /// Constructor that sets the iterator to the first arc
1.85 + /// Constructor that sets the iterator to the first arc
1.86 /// incoming to or outgoing from the given node.
1.87 explicit GraphIncIt(const GR&, const Base&) {}
1.88
1.89 @@ -804,16 +804,16 @@
1.90
1.91 /// \brief Return the first edge incident to the given node.
1.92 ///
1.93 - /// This function gives back the first edge incident to the given
1.94 + /// This function gives back the first edge incident to the given
1.95 /// node. The bool parameter gives back the direction for which the
1.96 - /// source node of the directed arc representing the edge is the
1.97 + /// source node of the directed arc representing the edge is the
1.98 /// given node.
1.99 void firstInc(Edge&, bool&, const Node&) const {}
1.100
1.101 /// \brief Gives back the next of the edges from the
1.102 /// given node.
1.103 ///
1.104 - /// This function gives back the next edge incident to the given
1.105 + /// This function gives back the next edge incident to the given
1.106 /// node. The bool parameter should be used as \c firstInc() use it.
1.107 void nextInc(Edge&, bool&) const {}
1.108
1.109 @@ -990,7 +990,7 @@
1.110 /// \brief Concept class for standard graph maps.
1.111 ///
1.112 /// This class describes the concept of standard graph maps, i.e.
1.113 - /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and
1.114 + /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and
1.115 /// graph types, which can be used for associating data to graph items.
1.116 /// The standard graph maps must conform to the ReferenceMap concept.
1.117 template <typename GR, typename K, typename V>
1.118 @@ -1045,7 +1045,7 @@
1.119 <ReferenceMap<Key, Value, Value&, const Value&>, _Map>();
1.120 _Map m1(g);
1.121 _Map m2(g,t);
1.122 -
1.123 +
1.124 // Copy constructor
1.125 // _Map m3(m);
1.126
1.127 @@ -1068,7 +1068,7 @@
1.128 /// \brief Skeleton class for mappable directed graphs.
1.129 ///
1.130 /// This class describes the interface of mappable directed graphs.
1.131 - /// It extends \ref BaseDigraphComponent with the standard digraph
1.132 + /// It extends \ref BaseDigraphComponent with the standard digraph
1.133 /// map classes, namely \c NodeMap and \c ArcMap.
1.134 /// This concept is part of the Digraph concept.
1.135 template <typename BAS = BaseDigraphComponent>
1.136 @@ -1205,7 +1205,7 @@
1.137 /// \brief Skeleton class for mappable undirected graphs.
1.138 ///
1.139 /// This class describes the interface of mappable undirected graphs.
1.140 - /// It extends \ref MappableDigraphComponent with the standard graph
1.141 + /// It extends \ref MappableDigraphComponent with the standard graph
1.142 /// map class for edges (\c EdgeMap).
1.143 /// This concept is part of the Graph concept.
1.144 template <typename BAS = BaseGraphComponent>
1.145 @@ -1290,7 +1290,7 @@
1.146 /// \brief Skeleton class for extendable directed graphs.
1.147 ///
1.148 /// This class describes the interface of extendable directed graphs.
1.149 - /// It extends \ref BaseDigraphComponent with functions for adding
1.150 + /// It extends \ref BaseDigraphComponent with functions for adding
1.151 /// nodes and arcs to the digraph.
1.152 /// This concept requires \ref AlterableDigraphComponent.
1.153 template <typename BAS = BaseDigraphComponent>
1.154 @@ -1334,7 +1334,7 @@
1.155 /// \brief Skeleton class for extendable undirected graphs.
1.156 ///
1.157 /// This class describes the interface of extendable undirected graphs.
1.158 - /// It extends \ref BaseGraphComponent with functions for adding
1.159 + /// It extends \ref BaseGraphComponent with functions for adding
1.160 /// nodes and edges to the graph.
1.161 /// This concept requires \ref AlterableGraphComponent.
1.162 template <typename BAS = BaseGraphComponent>
1.163 @@ -1378,7 +1378,7 @@
1.164 /// \brief Skeleton class for erasable directed graphs.
1.165 ///
1.166 /// This class describes the interface of erasable directed graphs.
1.167 - /// It extends \ref BaseDigraphComponent with functions for removing
1.168 + /// It extends \ref BaseDigraphComponent with functions for removing
1.169 /// nodes and arcs from the digraph.
1.170 /// This concept requires \ref AlterableDigraphComponent.
1.171 template <typename BAS = BaseDigraphComponent>
1.172 @@ -1391,7 +1391,7 @@
1.173
1.174 /// \brief Erase a node from the digraph.
1.175 ///
1.176 - /// This function erases the given node from the digraph and all arcs
1.177 + /// This function erases the given node from the digraph and all arcs
1.178 /// connected to the node.
1.179 void erase(const Node&) {}
1.180
1.181 @@ -1417,7 +1417,7 @@
1.182 /// \brief Skeleton class for erasable undirected graphs.
1.183 ///
1.184 /// This class describes the interface of erasable undirected graphs.
1.185 - /// It extends \ref BaseGraphComponent with functions for removing
1.186 + /// It extends \ref BaseGraphComponent with functions for removing
1.187 /// nodes and edges from the graph.
1.188 /// This concept requires \ref AlterableGraphComponent.
1.189 template <typename BAS = BaseGraphComponent>