Changeset 799:3393abe30678 in lemon-0.x for src/hugo/default_map_factory.h

Timestamp:

09/03/04 17:32:03 (20 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

 

File:

• src/hugo/default_map_factory.h (modified) (5 diffs)

src/hugo/default_map_factory.h

@@ -7 +7 @@
 #include <hugo/vector_map_factory.h>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Graph maps that construates and destruates
+///their elements dynamically.
+
 namespace hugo {
+
+/// \addtogroup graphmapfactory
+/// @{
 
 #define DEFAULT_MAP_BODY(Factory, Val) \
@@ -16 +24 @@
   \
     typedef typename MapRegistry::Graph Graph; \
-    typedef typename MapRegistry::Key Key; \
+    typedef typename MapRegistry::KeyType KeyType; \
     typedef typename MapRegistry::KeyIt KeyIt; \
     typedef Val Value; \
@@ -96 +104 @@
   DEFAULT_MAP_BODY(VectorMapFactory, Type*);
 
+
+  /** The DefaultMapFactory template class is a factory class
+   *  to create maps for the edge and nodes. This map factory
+   *  uses the VectorMapFactory if the ValueType is a primitive
+   *  type and the ArrayMapFactory for the other cases.
+   *
+   *  The template parameter is the MapRegistry that the maps
+   *  will belong to.
+   */
+
   template <typename MapRegistry>
   class DefaultMapFactory {
                 
   public:
-                
+    /// The graph type of the maps. 
     typedef typename MapRegistry::Graph Graph;
-    typedef typename MapRegistry::Key Key;
+    /// The key type of the maps.
+    typedef typename MapRegistry::KeyType KeyType;
+    /// The iterator to iterate on the keys.
     typedef typename MapRegistry::KeyIt KeyIt;
 
+    /// The MapBase of the Map which imlements the core regisitry function.
     typedef typename MapRegistry::MapBase MapBase;
+                
 
+    /** The template Map type.
+     */
     template <typename V> 
     class Map : public DefaultMap<MapRegistry, V> {
@@ -116 +140 @@
       typedef V Value;
 
+      /** Default constructor for the map.
+       */
       Map() : MapImpl() {}
 
+      /** Graph and Registry initialized map constructor.
+       */
       Map(const Graph& g, MapRegistry& r) : MapImpl(g, r) {}
 
+      /** Constructor to use default value to initialize the map. 
+       */
       Map(const Graph& g, MapRegistry& r, const Value& v) : MapImpl(g, r, v) {}
 
+      /** Constructor to copy a map of the same map type.
+       */
       Map(const Map& copy) : MapImpl(static_cast<const MapImpl&>(copy)) {}
 
+      /** Constructor to copy a map of an other map type.
+       */
       template <typename CMap> Map(const CMap& copy) : MapImpl(copy) {}
 
+      /** Assign operator to copy a map of the same map type.
+       */
       Map& operator=(const Map& copy) {
         MapImpl::operator=(static_cast<const MapImpl&>(copy));
@@ -131 +167 @@
       }
 
+      /** Assign operator to copy a map an other map type.
+       */
       template <typename CMap> Map& operator=(const CMap& copy) {
         MapImpl::operator=(copy);