Changeset 167:d57ae6f0a335 in lemon for lemon/maps.h

Timestamp:

06/14/08 19:34:15 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Rename StoreBoolMap? to LoggerBoolMap? (ticket #34).

File:

• lemon/maps.h (modified) (6 diffs)

lemon/maps.h

@@ -1701 +1701 @@
   /// In these cases it is a natural request to store each \c true
   /// assigned elements (in order of the assignment), which can be
-  /// easily done with StoreBoolMap.
-  ///
-  /// The simplest way of using this map is through the storeBoolMap()
+  /// easily done with LoggerBoolMap.
+  ///
+  /// The simplest way of using this map is through the loggerBoolMap()
   /// function.
   ///
@@ -1718 +1718 @@
             typename Ke=typename _maps_bits::IteratorTraits<It>::Value>
 #endif
-  class StoreBoolMap {
+  class LoggerBoolMap {
   public:
     typedef It Iterator;
@@ -1726 +1726 @@
 
     /// Constructor
-    StoreBoolMap(Iterator it)
+    LoggerBoolMap(Iterator it)
       : _begin(it), _end(it) {}
 
@@ -1751 +1751 @@
   };
   
-  /// Returns a \ref StoreBoolMap class
-
-  /// This function just returns a \ref StoreBoolMap class.
+  /// Returns a \ref LoggerBoolMap class
+
+  /// This function just returns a \ref LoggerBoolMap class.
   ///
   /// The most important usage of it is storing certain nodes or arcs
@@ -1761 +1761 @@
   /// \code
   ///   std::vector<Node> v;
-  ///   dfs(g,s).processedMap(storeBoolMap(std::back_inserter(v))).run();
+  ///   dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();
   /// \endcode
   /// \code
   ///   std::vector<Node> v(countNodes(g));
-  ///   dfs(g,s).processedMap(storeBoolMap(v.begin())).run();
+  ///   dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();
   /// \endcode
   ///
@@ -1771 +1771 @@
   /// for the elements or the iterator should be an inserter iterator.
   ///
-  /// \note StoreBoolMap is just \ref concepts::WriteMap "writable", so
+  /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
   /// it cannot be used when a readable map is needed, for example as
-  /// \c ReachedMap for Bfs, Dfs and Dijkstra algorithms.
-  ///
-  /// \relates StoreBoolMap
+  /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
+  ///
+  /// \relates LoggerBoolMap
   template<typename Iterator>
-  inline StoreBoolMap<Iterator> storeBoolMap(Iterator it) {
-    return StoreBoolMap<Iterator>(it);
+  inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {
+    return LoggerBoolMap<Iterator>(it);
   }