COIN-OR::LEMON - Graph Library

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


Ignore:
Timestamp:
06/14/08 19:34:15 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r159 r167  
    17011701  /// In these cases it is a natural request to store each \c true
    17021702  /// assigned elements (in order of the assignment), which can be
    1703   /// easily done with StoreBoolMap.
    1704   ///
    1705   /// The simplest way of using this map is through the storeBoolMap()
     1703  /// easily done with LoggerBoolMap.
     1704  ///
     1705  /// The simplest way of using this map is through the loggerBoolMap()
    17061706  /// function.
    17071707  ///
     
    17181718            typename Ke=typename _maps_bits::IteratorTraits<It>::Value>
    17191719#endif
    1720   class StoreBoolMap {
     1720  class LoggerBoolMap {
    17211721  public:
    17221722    typedef It Iterator;
     
    17261726
    17271727    /// Constructor
    1728     StoreBoolMap(Iterator it)
     1728    LoggerBoolMap(Iterator it)
    17291729      : _begin(it), _end(it) {}
    17301730
     
    17511751  };
    17521752 
    1753   /// Returns a \ref StoreBoolMap class
    1754 
    1755   /// This function just returns a \ref StoreBoolMap class.
     1753  /// Returns a \ref LoggerBoolMap class
     1754
     1755  /// This function just returns a \ref LoggerBoolMap class.
    17561756  ///
    17571757  /// The most important usage of it is storing certain nodes or arcs
     
    17611761  /// \code
    17621762  ///   std::vector<Node> v;
    1763   ///   dfs(g,s).processedMap(storeBoolMap(std::back_inserter(v))).run();
     1763  ///   dfs(g,s).processedMap(loggerBoolMap(std::back_inserter(v))).run();
    17641764  /// \endcode
    17651765  /// \code
    17661766  ///   std::vector<Node> v(countNodes(g));
    1767   ///   dfs(g,s).processedMap(storeBoolMap(v.begin())).run();
     1767  ///   dfs(g,s).processedMap(loggerBoolMap(v.begin())).run();
    17681768  /// \endcode
    17691769  ///
     
    17711771  /// for the elements or the iterator should be an inserter iterator.
    17721772  ///
    1773   /// \note StoreBoolMap is just \ref concepts::WriteMap "writable", so
     1773  /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
    17741774  /// it cannot be used when a readable map is needed, for example as
    1775   /// \c ReachedMap for Bfs, Dfs and Dijkstra algorithms.
    1776   ///
    1777   /// \relates StoreBoolMap
     1775  /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
     1776  ///
     1777  /// \relates LoggerBoolMap
    17781778  template<typename Iterator>
    1779   inline StoreBoolMap<Iterator> storeBoolMap(Iterator it) {
    1780     return StoreBoolMap<Iterator>(it);
     1779  inline LoggerBoolMap<Iterator> loggerBoolMap(Iterator it) {
     1780    return LoggerBoolMap<Iterator>(it);
    17811781  }
    17821782
Note: See TracChangeset for help on using the changeset viewer.