Changeset 937:d4e911acef3d in lemon-0.x for src/lemon/vector_map.h

Timestamp:

10/04/04 19:13:21 (20 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1264

Message:

Revert backport changes -r1230.

File:

• src/lemon/vector_map.h (modified) (9 diffs)

src/lemon/vector_map.h

@@ -32 +32 @@
   /// @{
   
-  /** The ArrayMap template class is graph map structure what
+  /** The VectorMap template class is graph map structure what
    *  automatically updates the map when a key is added to or erased from
    *  the map. This map factory uses the allocators to implement 
@@ -38 +38 @@
    *  uses the std::vector to implement the container function.
    *
-   *  The template parameter is the MapRegistry that the maps
-   *  will belong to and the ValueType.
+   *  \param MapRegistry The MapRegistry that the maps will belong to.
+   *  \param Value The value type of the map.
    * 
-   * \todo It should use a faster initialization using the maxNodeId() or
-   * maxEdgeId() function of the graph instead of iterating through each
-   * edge/node.
+   *  \author Balazs Dezso
    */
         
@@ -85 +83 @@
     typedef typename Container::const_pointer ConstPointerType;
 
-    /** Graph and Registry initialized map constructor.
+    /// Constructor to attach the new map into a registry.
+
+    /** Constructor to attach the new map into a registry.
+     *  It adds all the nodes or edges of the graph to the map.
      */
     VectorMap(const Graph& g, MapRegistry& r) 
       : MapBase(g, r), container(KeyInfo<Graph, KeyIt>::maxId(g)+1) {}
 
-    /** Constructor to use default value to initialize the map. 
+    /// Constructor uses given value to initialize the map. 
+
+    /** Constructor uses given value to initialize the map. 
+     *  It adds all the nodes or edges of the graph to the map.
      */
     VectorMap(const Graph& g, MapRegistry& r, const Value& v) 
       : MapBase(g, r), container(KeyInfo<Graph, KeyIt>::maxId(g)+1, v) {}
 
+    /// Assign operator to copy a map of an other map type.
+
     /** Assign operator to copy a map of an other map type.
+     *  This map's value type must be assignable by the other
+     *  map type's value type.
      */
     template <typename TT>
@@ -106 +114 @@
     }
 
+    /// Assign operator to copy a map of an other map type.
+
     /** Assign operator to copy a map of an other map type.
+     *  This map's value type must be assignable by the other
+     *  map type's value type.
      */
     template <typename TT>
@@ -120 +132 @@
       return *this;
     }
+
+    /// The subcript operator.
+
     /**
      * The subscript operator. The map can be subscripted by the
@@ -129 +144 @@
     } 
                 
+    /// The const subcript operator.
+
     /**
      * The const subscript operator. The map can be subscripted by the
@@ -138 +155 @@
     }
 
+    ///Setter function of the map.
+
     /** Setter function of the map. Equivalent with map[key] = val.
      *  This is a compatibility feature with the not dereferable maps.
@@ -145 +164 @@
       container[id] = val;
     }
-                
-    /** Add a new key to the map. It called by the map registry.
+    /// Adds a new key to the map.
+                
+    /** Adds a new key to the map. It called by the map registry
+     *  and it overrides the \ref MapRegistry::MapBase MapBase's
+     *  add() member function.
      */
     void add(const KeyType& key) {
@@ -154 +176 @@
       }
     }
-                
-    /** Erase a key from the map. It called by the map registry.
+
+    /// Erases a key from the map.
+                
+    /** Erase a key from the map. It called by the map registry 
+     *  and it overrides the \ref MapRegistry::MapBase MapBase's
+     *  erase() member function.
      */
     void erase(const KeyType& key) {}
 
-    /** Clear the data structure.
-     */
+    /// Makes empty the map.
+
+    /** Makes empty the map. It called by the map registry 
+     *  and it overrides the \ref MapRegistry::MapBase MapBase's
+     *  clear() member function.
+     */
+
     void clear() { 
       container.clear();