lemon-1.2: comparison lemon/maps.h

equal deleted inserted replaced

-:50dbf6892c00
+:b3d7d2637835
 /// \brief Map for storing values for integer keys from the range
 /// <tt>[0..size-1]</tt>.
 ///
 /// This map is essentially a wrapper for \c std::vector. It assigns
 /// values to integer keys from the range <tt>[0..size-1]</tt>.
-/// It can be used with some data structures, for example
+/// It can be used together with some data structures, e.g.
-/// \c UnionFind, \c BinHeap, when the used items are small
+/// heap types and \c UnionFind, when the used items are small
 /// integers. This map conforms to the \ref concepts::ReferenceMap
 /// "ReferenceMap" concept.
 ///
 /// The simplest way of using this map is through the rangeMap()
 /// function.
 template <typename V>
 class RangeMap : public MapBase<int, V> {
 /// This map is useful if a default value should be assigned to most of
 /// the keys and different values should be assigned only to a few
 /// keys (i.e. the map is "sparse").
 /// The name of this type also refers to this important usage.
 ///
-/// Apart form that this map can be used in many other cases since it
+/// Apart form that, this map can be used in many other cases since it
 /// is based on \c std::map, which is a general associative container.
-/// However keep in mind that it is usually not as efficient as other
+/// However, keep in mind that it is usually not as efficient as other
 /// maps.
 ///
 /// The simplest way of using this map is through the sparseMap()
 /// function.
 template <typename K, typename V, typename Comp = std::less<K> >
 /// This function just returns a \c LoggerBoolMap class.
 ///
 /// The most important usage of it is storing certain nodes or arcs
 /// that were marked \c true by an algorithm.
-/// For example it makes easier to store the nodes in the processing
+/// For example, it makes easier to store the nodes in the processing
 /// order of Dfs algorithm, as the following examples show.
 /// \code
 ///   std::vector<Node> v;
 ///   dfs(g).processedMap(loggerBoolMap(std::back_inserter(v))).run(s);
 /// \endcode
 ///
 /// \note The container of the iterator must contain enough space
 /// for the elements or the iterator should be an inserter iterator.
 ///
 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
-/// it cannot be used when a readable map is needed, for example as
+/// it cannot be used when a readable map is needed, for example, as
 /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
 ///
 /// \relates LoggerBoolMap
 template<typename Iterator>
 inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {
 /// This map is intended to be used when all associated values are
 /// different (the map is actually invertable) or there are only a few
 /// items with the same value.
 /// Otherwise consider to use \c IterableValueMap, which is more
 /// suitable and more efficient for such cases. It provides iterators
-/// to traverse the items with the same associated value, however
+/// to traverse the items with the same associated value, but
 /// it does not have \c InverseMap.
 ///
 /// This type is not reference map, so it cannot be modified with
 /// the subscript operator.
 ///
 /// whenever the digraph changes.
 ///
 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
 /// may provide alternative ways to modify the digraph.
 /// The correct behavior of InDegMap is not guarantied if these additional
-/// features are used. For example the functions
+/// features are used. For example, the functions
 /// \ref ListDigraph::changeSource() "changeSource()",
 /// \ref ListDigraph::changeTarget() "changeTarget()" and
 /// \ref ListDigraph::reverseArc() "reverseArc()"
 /// of \ref ListDigraph will \e not update the degree values correctly.
 ///
 /// whenever the digraph changes.
 ///
 /// \warning Besides \c addNode() and \c addArc(), a digraph structure
 /// may provide alternative ways to modify the digraph.
 /// The correct behavior of OutDegMap is not guarantied if these additional
-/// features are used. For example the functions
+/// features are used. For example, the functions
 /// \ref ListDigraph::changeSource() "changeSource()",
 /// \ref ListDigraph::changeTarget() "changeTarget()" and
 /// \ref ListDigraph::reverseArc() "reverseArc()"
 /// of \ref ListDigraph will \e not update the degree values correctly.
 ///

changeset 788	c92296660262
parent 726	3fc2a801c39e
child 792	a2d5fd4c309a