Changeset 2564:3250756f5add in lemon-0.x for lemon/concepts/maps.h

Timestamp:

02/05/08 13:41:05 (16 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

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

Message:

Several doc improvements and fixes in maps.h and concepts/maps.h.

File:

• lemon/concepts/maps.h (modified) (8 diffs)

lemon/concepts/maps.h

@@ -35 +35 @@
 
     /// Readable map concept
+
+    /// Readable map concept.
+    ///
     template<typename K, typename T>
     class ReadMap
     {
     public:
-      /// Map's key type.
-      typedef K Key;    
-      /// Map's value type. (The type of objects associated with the keys).
-      typedef T Value;
-
-      // \bug Value don't need to be default constructible.
+      /// The key type of the map.
+      typedef K Key;    
+      /// The value type of the map. (The type of objects associated with the keys).
+      typedef T Value;
+
       /// Returns the value associated with a key.
+
+      /// Returns the value associated with a key.
+      /// \bug Value shouldn't need to be default constructible.
+      ///
       Value operator[](const Key &) const {return Value();}
 
@@ -70 +76 @@
 
     /// Writable map concept
+    
+    /// Writable map concept.
+    ///
     template<typename K, typename T>
     class WriteMap
     {
     public:
-      /// Map's key type.
-      typedef K Key;    
-      /// Map's value type. (The type of objects associated with the keys).
+      /// The key type of the map.
+      typedef K Key;    
+      /// The value type of the map. (The type of objects associated with the keys).
       typedef T Value;
 
@@ -106 +115 @@
     };
 
-    ///Read/Writable map concept
+    /// Read/writable map concept
+    
+    /// Read/writable map concept.
+    ///
     template<typename K, typename T>
     class ReadWriteMap : public ReadMap<K,T>,
-                            public WriteMap<K,T>
-    {
-    public:
-      /// Map's key type.
-      typedef K Key;    
-      /// Map's value type. (The type of objects associated with the keys).
+                         public WriteMap<K,T>
+    {
+    public:
+      /// The key type of the map.
+      typedef K Key;    
+      /// The value type of the map. (The type of objects associated with the keys).
       typedef T Value;
 
@@ -133 +145 @@
   
     ///Dereferable map concept
+    
+    /// Dereferable map concept.
+    ///
+    /// \todo Rethink this concept.
     template<typename K, typename T, typename R, typename CR>
     class ReferenceMap : public ReadWriteMap<K,T>
@@ -139 +155 @@
       /// Tag for reference maps.
       typedef True ReferenceMapTag;
-      /// Map's key type.
-      typedef K Key;    
-      /// Map's value type. (The type of objects associated with the keys).
-      typedef T Value;
-      /// Map's reference type.
+      /// The key type of the map.
+      typedef K Key;    
+      /// The value type of the map. (The type of objects associated with the keys).
+      typedef T Value;
+      /// The reference type of the map.
       typedef R Reference;
-      /// Map's const reference type.
+      /// The const reference type of the map.
       typedef CR ConstReference;
 
@@ -152 +168 @@
     public:
 
-      ///Returns a reference to the value associated to a key.
+      ///Returns a reference to the value associated with a key.
       Reference operator[](const Key &) { return tmp; }
-      ///Returns a const reference to the value associated to a key.
-      ConstReference operator[](const Key &) const
-      { return tmp; }
+      ///Returns a const reference to the value associated with a key.
+      ConstReference operator[](const Key &) const { return tmp; }
       /// Sets the value associated with a key.
       void set(const Key &k,const Value &t) { operator[](k)=t; }
 
-      // \todo rethink this concept
       template<typename _ReferenceMap>
-      struct ReferenceMapConcept {
-
-        void constraints() {
-          checkConcept<ReadWriteMap, _ReferenceMap >();
+      struct Constraints {
+
+        void constraints() {
+          checkConcept<ReadWriteMap<K, T>, _ReferenceMap >();
           m[key] = val;
           val  = m[key];
@@ -178 +192 @@
         typename _ReferenceMap::Key& own_key;
         typename _ReferenceMap::Value& own_val;
-        typename _ReferenceMap::Reference& own_ref;
+        typename _ReferenceMap::Reference own_ref;
         Key& key;
         Value& val;
-        Reference& ref;
+        Reference ref;
         _ReferenceMap& m;
       };
@@ -189 +203 @@
 
   } //namespace concepts
+
 } //namespace lemon
+
 #endif // LEMON_CONCEPT_MAPS_H