1.1 --- a/lemon/concepts/graph_components.h Fri Aug 09 11:07:27 2013 +0200
1.2 +++ b/lemon/concepts/graph_components.h Sun Aug 11 15:28:12 2013 +0200
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 @@ -18,7 +18,7 @@
1.13
1.14 ///\ingroup graph_concepts
1.15 ///\file
1.16 -///\brief The concept of graph components.
1.17 +///\brief The concepts of graph components.
1.18
1.19 #ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H
1.20 #define LEMON_CONCEPTS_GRAPH_COMPONENTS_H
1.21 @@ -38,7 +38,7 @@
1.22 ///
1.23 /// \note This class is a template class so that we can use it to
1.24 /// create graph skeleton classes. The reason for this is that \c Node
1.25 - /// and \c Arc (or \c Edge) types should \e not derive from the same
1.26 + /// and \c Arc (or \c Edge) types should \e not derive from the same
1.27 /// base class. For \c Node you should instantiate it with character
1.28 /// \c 'n', for \c Arc with \c 'a' and for \c Edge with \c 'e'.
1.29 #ifndef DOXYGEN
1.30 @@ -89,10 +89,10 @@
1.31 /// \brief Ordering operator.
1.32 ///
1.33 /// This operator defines an ordering of the items.
1.34 - /// It makes possible to use graph item types as key types in
1.35 + /// It makes possible to use graph item types as key types in
1.36 /// associative containers (e.g. \c std::map).
1.37 ///
1.38 - /// \note This operator only have to define some strict ordering of
1.39 + /// \note This operator only has to define some strict ordering of
1.40 /// the items; this order has nothing to do with the iteration
1.41 /// ordering of the items.
1.42 bool operator<(const GraphItem&) const { return false; }
1.43 @@ -125,7 +125,7 @@
1.44 ///
1.45 /// This class describes the base interface of directed graph types.
1.46 /// All digraph %concepts have to conform to this class.
1.47 - /// It just provides types for nodes and arcs and functions
1.48 + /// It just provides types for nodes and arcs and functions
1.49 /// to get the source and the target nodes of arcs.
1.50 class BaseDigraphComponent {
1.51 public:
1.52 @@ -433,7 +433,7 @@
1.53
1.54 /// \brief Concept class for \c NodeIt, \c ArcIt and \c EdgeIt types.
1.55 ///
1.56 - /// This class describes the concept of \c NodeIt, \c ArcIt and
1.57 + /// This class describes the concept of \c NodeIt, \c ArcIt and
1.58 /// \c EdgeIt subtypes of digraph and graph types.
1.59 template <typename GR, typename Item>
1.60 class GraphItemIt : public Item {
1.61 @@ -473,7 +473,7 @@
1.62 /// This operator increments the iterator, i.e. assigns it to the
1.63 /// next item.
1.64 GraphItemIt& operator++() { return *this; }
1.65 -
1.66 +
1.67 /// \brief Equality operator
1.68 ///
1.69 /// Equality operator.
1.70 @@ -511,15 +511,15 @@
1.71 };
1.72 };
1.73
1.74 - /// \brief Concept class for \c InArcIt, \c OutArcIt and
1.75 + /// \brief Concept class for \c InArcIt, \c OutArcIt and
1.76 /// \c IncEdgeIt types.
1.77 ///
1.78 - /// This class describes the concept of \c InArcIt, \c OutArcIt
1.79 + /// This class describes the concept of \c InArcIt, \c OutArcIt
1.80 /// and \c IncEdgeIt subtypes of digraph and graph types.
1.81 ///
1.82 /// \note Since these iterator classes do not inherit from the same
1.83 /// base class, there is an additional template parameter (selector)
1.84 - /// \c sel. For \c InArcIt you should instantiate it with character
1.85 + /// \c sel. For \c InArcIt you should instantiate it with character
1.86 /// \c 'i', for \c OutArcIt with \c 'o' and for \c IncEdgeIt with \c 'e'.
1.87 template <typename GR,
1.88 typename Item = typename GR::Arc,
1.89 @@ -540,10 +540,10 @@
1.90 /// Copy constructor.
1.91 GraphIncIt(const GraphIncIt& it) : Item(it) {}
1.92
1.93 - /// \brief Constructor that sets the iterator to the first
1.94 + /// \brief Constructor that sets the iterator to the first
1.95 /// incoming or outgoing arc.
1.96 ///
1.97 - /// Constructor that sets the iterator to the first arc
1.98 + /// Constructor that sets the iterator to the first arc
1.99 /// incoming to or outgoing from the given node.
1.100 explicit GraphIncIt(const GR&, const Base&) {}
1.101
1.102 @@ -818,16 +818,16 @@
1.103
1.104 /// \brief Return the first edge incident to the given node.
1.105 ///
1.106 - /// This function gives back the first edge incident to the given
1.107 + /// This function gives back the first edge incident to the given
1.108 /// node. The bool parameter gives back the direction for which the
1.109 - /// source node of the directed arc representing the edge is the
1.110 + /// source node of the directed arc representing the edge is the
1.111 /// given node.
1.112 void firstInc(Edge&, bool&, const Node&) const {}
1.113
1.114 /// \brief Gives back the next of the edges from the
1.115 /// given node.
1.116 ///
1.117 - /// This function gives back the next edge incident to the given
1.118 + /// This function gives back the next edge incident to the given
1.119 /// node. The bool parameter should be used as \c firstInc() use it.
1.120 void nextInc(Edge&, bool&) const {}
1.121
1.122 @@ -1007,7 +1007,7 @@
1.123 /// \brief Concept class for standard graph maps.
1.124 ///
1.125 /// This class describes the concept of standard graph maps, i.e.
1.126 - /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and
1.127 + /// the \c NodeMap, \c ArcMap and \c EdgeMap subtypes of digraph and
1.128 /// graph types, which can be used for associating data to graph items.
1.129 /// The standard graph maps must conform to the ReferenceMap concept.
1.130 template <typename GR, typename K, typename V>
1.131 @@ -1062,7 +1062,7 @@
1.132 <ReferenceMap<Key, Value, Value&, const Value&>, _Map>();
1.133 _Map m1(g);
1.134 _Map m2(g,t);
1.135 -
1.136 +
1.137 // Copy constructor
1.138 // _Map m3(m);
1.139
1.140 @@ -1086,7 +1086,7 @@
1.141 /// \brief Skeleton class for mappable directed graphs.
1.142 ///
1.143 /// This class describes the interface of mappable directed graphs.
1.144 - /// It extends \ref BaseDigraphComponent with the standard digraph
1.145 + /// It extends \ref BaseDigraphComponent with the standard digraph
1.146 /// map classes, namely \c NodeMap and \c ArcMap.
1.147 /// This concept is part of the Digraph concept.
1.148 template <typename BAS = BaseDigraphComponent>
1.149 @@ -1224,7 +1224,7 @@
1.150 /// \brief Skeleton class for mappable undirected graphs.
1.151 ///
1.152 /// This class describes the interface of mappable undirected graphs.
1.153 - /// It extends \ref MappableDigraphComponent with the standard graph
1.154 + /// It extends \ref MappableDigraphComponent with the standard graph
1.155 /// map class for edges (\c EdgeMap).
1.156 /// This concept is part of the Graph concept.
1.157 template <typename BAS = BaseGraphComponent>
1.158 @@ -1310,7 +1310,7 @@
1.159 /// \brief Skeleton class for extendable directed graphs.
1.160 ///
1.161 /// This class describes the interface of extendable directed graphs.
1.162 - /// It extends \ref BaseDigraphComponent with functions for adding
1.163 + /// It extends \ref BaseDigraphComponent with functions for adding
1.164 /// nodes and arcs to the digraph.
1.165 /// This concept requires \ref AlterableDigraphComponent.
1.166 template <typename BAS = BaseDigraphComponent>
1.167 @@ -1355,7 +1355,7 @@
1.168 /// \brief Skeleton class for extendable undirected graphs.
1.169 ///
1.170 /// This class describes the interface of extendable undirected graphs.
1.171 - /// It extends \ref BaseGraphComponent with functions for adding
1.172 + /// It extends \ref BaseGraphComponent with functions for adding
1.173 /// nodes and edges to the graph.
1.174 /// This concept requires \ref AlterableGraphComponent.
1.175 template <typename BAS = BaseGraphComponent>
1.176 @@ -1400,7 +1400,7 @@
1.177 /// \brief Skeleton class for erasable directed graphs.
1.178 ///
1.179 /// This class describes the interface of erasable directed graphs.
1.180 - /// It extends \ref BaseDigraphComponent with functions for removing
1.181 + /// It extends \ref BaseDigraphComponent with functions for removing
1.182 /// nodes and arcs from the digraph.
1.183 /// This concept requires \ref AlterableDigraphComponent.
1.184 template <typename BAS = BaseDigraphComponent>
1.185 @@ -1413,7 +1413,7 @@
1.186
1.187 /// \brief Erase a node from the digraph.
1.188 ///
1.189 - /// This function erases the given node from the digraph and all arcs
1.190 + /// This function erases the given node from the digraph and all arcs
1.191 /// connected to the node.
1.192 void erase(const Node&) {}
1.193
1.194 @@ -1440,7 +1440,7 @@
1.195 /// \brief Skeleton class for erasable undirected graphs.
1.196 ///
1.197 /// This class describes the interface of erasable undirected graphs.
1.198 - /// It extends \ref BaseGraphComponent with functions for removing
1.199 + /// It extends \ref BaseGraphComponent with functions for removing
1.200 /// nodes and edges from the graph.
1.201 /// This concept requires \ref AlterableGraphComponent.
1.202 template <typename BAS = BaseGraphComponent>