lemon/maps.h
changeset 788 c92296660262
parent 726 3fc2a801c39e
child 792 a2d5fd4c309a
     1.1 --- a/lemon/maps.h	Sun Nov 15 19:57:02 2009 +0100
     1.2 +++ b/lemon/maps.h	Wed Nov 18 14:38:02 2009 +0100
     1.3 @@ -230,10 +230,10 @@
     1.4    ///
     1.5    /// This map is essentially a wrapper for \c std::vector. It assigns
     1.6    /// values to integer keys from the range <tt>[0..size-1]</tt>.
     1.7 -  /// It can be used with some data structures, for example
     1.8 -  /// \c UnionFind, \c BinHeap, when the used items are small
     1.9 +  /// It can be used together with some data structures, e.g.
    1.10 +  /// heap types and \c UnionFind, when the used items are small
    1.11    /// integers. This map conforms to the \ref concepts::ReferenceMap
    1.12 -  /// "ReferenceMap" concept.
    1.13 +  /// "ReferenceMap" concept. 
    1.14    ///
    1.15    /// The simplest way of using this map is through the rangeMap()
    1.16    /// function.
    1.17 @@ -348,9 +348,9 @@
    1.18    /// keys (i.e. the map is "sparse").
    1.19    /// The name of this type also refers to this important usage.
    1.20    ///
    1.21 -  /// Apart form that this map can be used in many other cases since it
    1.22 +  /// Apart form that, this map can be used in many other cases since it
    1.23    /// is based on \c std::map, which is a general associative container.
    1.24 -  /// However keep in mind that it is usually not as efficient as other
    1.25 +  /// However, keep in mind that it is usually not as efficient as other
    1.26    /// maps.
    1.27    ///
    1.28    /// The simplest way of using this map is through the sparseMap()
    1.29 @@ -1785,7 +1785,7 @@
    1.30    ///
    1.31    /// The most important usage of it is storing certain nodes or arcs
    1.32    /// that were marked \c true by an algorithm.
    1.33 -  /// For example it makes easier to store the nodes in the processing
    1.34 +  /// For example, it makes easier to store the nodes in the processing
    1.35    /// order of Dfs algorithm, as the following examples show.
    1.36    /// \code
    1.37    ///   std::vector<Node> v;
    1.38 @@ -1800,7 +1800,7 @@
    1.39    /// for the elements or the iterator should be an inserter iterator.
    1.40    ///
    1.41    /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
    1.42 -  /// it cannot be used when a readable map is needed, for example as
    1.43 +  /// it cannot be used when a readable map is needed, for example, as
    1.44    /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
    1.45    ///
    1.46    /// \relates LoggerBoolMap
    1.47 @@ -1922,7 +1922,7 @@
    1.48    /// items with the same value.
    1.49    /// Otherwise consider to use \c IterableValueMap, which is more 
    1.50    /// suitable and more efficient for such cases. It provides iterators
    1.51 -  /// to traverse the items with the same associated value, however
    1.52 +  /// to traverse the items with the same associated value, but
    1.53    /// it does not have \c InverseMap.
    1.54    ///
    1.55    /// This type is not reference map, so it cannot be modified with
    1.56 @@ -3466,7 +3466,7 @@
    1.57    /// \warning Besides \c addNode() and \c addArc(), a digraph structure
    1.58    /// may provide alternative ways to modify the digraph.
    1.59    /// The correct behavior of InDegMap is not guarantied if these additional
    1.60 -  /// features are used. For example the functions
    1.61 +  /// features are used. For example, the functions
    1.62    /// \ref ListDigraph::changeSource() "changeSource()",
    1.63    /// \ref ListDigraph::changeTarget() "changeTarget()" and
    1.64    /// \ref ListDigraph::reverseArc() "reverseArc()"
    1.65 @@ -3596,7 +3596,7 @@
    1.66    /// \warning Besides \c addNode() and \c addArc(), a digraph structure
    1.67    /// may provide alternative ways to modify the digraph.
    1.68    /// The correct behavior of OutDegMap is not guarantied if these additional
    1.69 -  /// features are used. For example the functions
    1.70 +  /// features are used. For example, the functions
    1.71    /// \ref ListDigraph::changeSource() "changeSource()",
    1.72    /// \ref ListDigraph::changeTarget() "changeTarget()" and
    1.73    /// \ref ListDigraph::reverseArc() "reverseArc()"