lemon/maps.h
changeset 167 d57ae6f0a335
parent 159 c7d30f7810e5
child 209 765619b7cbb2
     1.1 --- a/lemon/maps.h	Wed Jun 04 11:28:08 2008 +0100
     1.2 +++ b/lemon/maps.h	Sat Jun 14 19:34:15 2008 +0200
     1.3 @@ -1700,9 +1700,9 @@
     1.4    /// maps and most of them assign \c true at most once for each key.
     1.5    /// In these cases it is a natural request to store each \c true
     1.6    /// assigned elements (in order of the assignment), which can be
     1.7 -  /// easily done with StoreBoolMap.
     1.8 +  /// easily done with LoggerBoolMap.
     1.9    ///
    1.10 -  /// The simplest way of using this map is through the storeBoolMap()
    1.11 +  /// The simplest way of using this map is through the loggerBoolMap()
    1.12    /// function.
    1.13    ///
    1.14    /// \tparam It The type of the iterator.
    1.15 @@ -1717,7 +1717,7 @@
    1.16    template <typename It,
    1.17  	    typename Ke=typename _maps_bits::IteratorTraits<It>::Value>
    1.18  #endif
    1.19 -  class StoreBoolMap {
    1.20 +  class LoggerBoolMap {
    1.21    public:
    1.22      typedef It Iterator;
    1.23  
    1.24 @@ -1725,7 +1725,7 @@
    1.25      typedef bool Value;
    1.26  
    1.27      /// Constructor
    1.28 -    StoreBoolMap(Iterator it)
    1.29 +    LoggerBoolMap(Iterator it)
    1.30        : _begin(it), _end(it) {}
    1.31  
    1.32      /// Gives back the given iterator set for the first key
    1.33 @@ -1750,9 +1750,9 @@
    1.34      Iterator _end;
    1.35    };
    1.36    
    1.37 -  /// Returns a \ref StoreBoolMap class
    1.38 +  /// Returns a \ref LoggerBoolMap class
    1.39  
    1.40 -  /// This function just returns a \ref StoreBoolMap class.
    1.41 +  /// This function just returns a \ref LoggerBoolMap class.
    1.42    ///
    1.43    /// The most important usage of it is storing certain nodes or arcs
    1.44    /// that were marked \c true by an algorithm.
    1.45 @@ -1760,24 +1760,24 @@
    1.46    /// order of Dfs algorithm, as the following examples show.
    1.47    /// \code
    1.48    ///   std::vector<Node> v;
    1.49 -  ///   dfs(g,s).processedMap(storeBoolMap(std::back_inserter(v))).run();
    1.50 +  ///   dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();
    1.51    /// \endcode
    1.52    /// \code
    1.53    ///   std::vector<Node> v(countNodes(g));
    1.54 -  ///   dfs(g,s).processedMap(storeBoolMap(v.begin())).run();
    1.55 +  ///   dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();
    1.56    /// \endcode
    1.57    ///
    1.58    /// \note The container of the iterator must contain enough space
    1.59    /// for the elements or the iterator should be an inserter iterator.
    1.60    ///
    1.61 -  /// \note StoreBoolMap is just \ref concepts::WriteMap "writable", so
    1.62 +  /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
    1.63    /// it cannot be used when a readable map is needed, for example as
    1.64 -  /// \c ReachedMap for Bfs, Dfs and Dijkstra algorithms.
    1.65 +  /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
    1.66    ///
    1.67 -  /// \relates StoreBoolMap
    1.68 +  /// \relates LoggerBoolMap
    1.69    template<typename Iterator>
    1.70 -  inline StoreBoolMap<Iterator> storeBoolMap(Iterator it) {
    1.71 -    return StoreBoolMap<Iterator>(it);
    1.72 +  inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {
    1.73 +    return LoggerBoolMap<Iterator>(it);
    1.74    }
    1.75  
    1.76    /// @}