Changeset 724:d8073df341f6 in lemon-main

Timestamp:

09/25/09 12:22:42 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Rename ValueIterator? to ValueIt? in graph maps (#302)
but keep ValueIterator? as an alias in CrossRefMap?
(only for reverse compatibility).

Files:

• lemon/maps.h (modified) (14 diffs)
• test/maps_test.cc (modified) (3 diffs)

lemon/maps.h

@@ -1908 +1908 @@
   /// The graph items can be accessed by their values either using
   /// \c InverseMap or \c operator()(), and the values of the map can be
-  /// accessed with an STL compatible forward iterator (\c ValueIterator).
+  /// accessed with an STL compatible forward iterator (\c ValueIt).
   /// 
   /// This map is intended to be used when all associated values are
@@ -1962 +1962 @@
     /// They are considered with multiplicity, so each value is
     /// traversed for each item it is assigned to.
-    class ValueIterator
+    class ValueIt
       : public std::iterator<std::forward_iterator_tag, Value> {
       friend class CrossRefMap;
     private:
-      ValueIterator(typename Container::const_iterator _it)
+      ValueIt(typename Container::const_iterator _it)
         : it(_it) {}
     public:
 
       /// Constructor
-      ValueIterator() {}
+      ValueIt() {}
 
       /// \e
-      ValueIterator& operator++() { ++it; return *this; }
+      ValueIt& operator++() { ++it; return *this; }
       /// \e
-      ValueIterator operator++(int) {
-        ValueIterator tmp(*this);
+      ValueIt operator++(int) {
+        ValueIt tmp(*this);
         operator++();
         return tmp;
@@ -1988 +1988 @@
 
       /// \e
-      bool operator==(ValueIterator jt) const { return it == jt.it; }
+      bool operator==(ValueIt jt) const { return it == jt.it; }
       /// \e
-      bool operator!=(ValueIterator jt) const { return it != jt.it; }
+      bool operator!=(ValueIt jt) const { return it != jt.it; }
 
     private:
       typename Container::const_iterator it;
     };
+    
+    /// Alias for \c ValueIt
+    typedef ValueIt ValueIterator;
 
     /// \brief Returns an iterator to the first value.
@@ -2002 +2005 @@
     /// map can be accessed in the <tt>[beginValue, endValue)</tt>
     /// range.
-    ValueIterator beginValue() const {
-      return ValueIterator(_inv_map.begin());
+    ValueIt beginValue() const {
+      return ValueIt(_inv_map.begin());
     }
 
@@ -2012 +2015 @@
     /// map can be accessed in the <tt>[beginValue, endValue)</tt>
     /// range.
-    ValueIterator endValue() const {
-      return ValueIterator(_inv_map.end());
+    ValueIt endValue() const {
+      return ValueIt(_inv_map.end());
     }
 
@@ -3024 +3027 @@
   /// For each value it is possible to iterate on the keys mapped to
   /// the value (\c ItemIt), and the values of the map can be accessed
-  /// with an STL compatible forward iterator (\c ValueIterator).
+  /// with an STL compatible forward iterator (\c ValueIt).
   /// The map stores a linked list for each value, which contains
   /// the items mapped to the value, and the used values are stored
@@ -3112 +3115 @@
     /// iterator on the values of the map. The values can
     /// be accessed in the <tt>[beginValue, endValue)</tt> range.
-    class ValueIterator
+    class ValueIt
       : public std::iterator<std::forward_iterator_tag, Value> {
       friend class IterableValueMap;
     private:
-      ValueIterator(typename std::map<Value, Key>::const_iterator _it)
+      ValueIt(typename std::map<Value, Key>::const_iterator _it)
         : it(_it) {}
     public:
 
       /// Constructor
-      ValueIterator() {}
+      ValueIt() {}
 
       /// \e
-      ValueIterator& operator++() { ++it; return *this; }
+      ValueIt& operator++() { ++it; return *this; }
       /// \e
-      ValueIterator operator++(int) {
-        ValueIterator tmp(*this);
+      ValueIt operator++(int) {
+        ValueIt tmp(*this);
         operator++();
         return tmp;
@@ -3138 +3141 @@
 
       /// \e
-      bool operator==(ValueIterator jt) const { return it == jt.it; }
+      bool operator==(ValueIt jt) const { return it == jt.it; }
       /// \e
-      bool operator!=(ValueIterator jt) const { return it != jt.it; }
+      bool operator!=(ValueIt jt) const { return it != jt.it; }
 
     private:
@@ -3152 +3155 @@
     /// map can be accessed in the <tt>[beginValue, endValue)</tt>
     /// range.
-    ValueIterator beginValue() const {
-      return ValueIterator(_first.begin());
+    ValueIt beginValue() const {
+      return ValueIt(_first.begin());
     }
 
@@ -3162 +3165 @@
     /// map can be accessed in the <tt>[beginValue, endValue)</tt>
     /// range.
-    ValueIterator endValue() const {
-      return ValueIterator(_first.end());
+    ValueIt endValue() const {
+      return ValueIt(_first.end());
     }
 
@@ -3281 +3284 @@
   public:
 
-    ///\e
+    /// The key type (the \c Arc type of the digraph).
     typedef typename GR::Arc Key;
-    ///\e
+    /// The value type (the \c Node type of the digraph).
     typedef typename GR::Node Value;
 
@@ -3322 +3325 @@
   public:
 
-    ///\e
+    /// The key type (the \c Arc type of the digraph).
     typedef typename GR::Arc Key;
-    ///\e
+    /// The value type (the \c Node type of the digraph).
     typedef typename GR::Node Value;
 
@@ -3364 +3367 @@
   public:
 
+    /// The key type (the \c Edge type of the digraph).
+    typedef typename GR::Edge Key;
+    /// The value type (the \c Arc type of the digraph).
     typedef typename GR::Arc Value;
-    typedef typename GR::Edge Key;
 
     /// \brief Constructor
@@ -3404 +3409 @@
   public:
 
+    /// The key type (the \c Edge type of the digraph).
+    typedef typename GR::Edge Key;
+    /// The value type (the \c Arc type of the digraph).
     typedef typename GR::Arc Value;
-    typedef typename GR::Edge Key;
 
     /// \brief Constructor

test/maps_test.cc

@@ -527 +527 @@
     Graph gr;
     typedef CrossRefMap<Graph, Node, char> CRMap;
-    typedef CRMap::ValueIterator ValueIt;
     CRMap map(gr);
     
@@ -547 +546 @@
           "Wrong CrossRefMap::count()");
     
-    ValueIt it = map.beginValue();
+    CRMap::ValueIt it = map.beginValue();
     check(*it++ == 'A' && *it++ == 'B' && *it++ == 'C' &&
           it == map.endValue(), "Wrong value iterator");
@@ -743 +742 @@
     }
 
-    for (Ivm::ValueIterator vit = map1.beginValue();
+    for (Ivm::ValueIt vit = map1.beginValue();
          vit != map1.endValue(); ++vit) {
       check(map1[static_cast<Item>(Ivm::ItemIt(map1, *vit))] == *vit,
-            "Wrong ValueIterator");
+            "Wrong ValueIt");
     }