Changeset 1115:444f69240539 in lemon-0.x for src/work/deba/map_utils.h

Timestamp:

02/01/05 16:56:37 (20 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Some changes in the IO and map utilities.

File:

• src/work/deba/map_utils.h (modified) (6 diffs)

src/work/deba/map_utils.h

@@ -15 +15 @@
  */
 
-///\ingroup gutils
+///\ingroup mutils
 ///\file
 ///\brief Map utilities.
@@ -50 +50 @@
     typedef typename _Map::ConstReference ConstReference;
 
-    /// Constructor.
-
+    /// \brief Constructor.
+    ///
     /// Construct a new InversableMap for the graph.
     ///
     InversableMap(const Graph& graph) : Map(graph) {} 
     
-    /// The setter function of the map.
-
-    /// It sets the map and the inverse map 
+    /// \brief The setter function of the map.
+    ///
+    /// It sets the map and the inverse map to given key-value pair.
     void set(const Key& key, const Value& val) {
       Value oldval = Map::operator[](key);
@@ -96 +96 @@
 
 
-  // unique, continous, mutable
+  
+  /// \brief Provides a mutable, continous and unique descriptor for each 
+  /// item in the graph.
+  ///
+  /// The DescriptorMap class provides a mutable, continous and immutable
+  /// mapping for each item in the graph.
+  ///
+  /// \param _Graph The graph class the \c DescriptorMap belongs to.
+  /// \param _Item The Item is the Key of the Map. It may be Node, Edge or 
+  /// UndirEdge.
+  /// \param _Map A ReadWriteMap mapping from the item type to integer.
 
   template <
     typename _Graph,   
     typename _Item,
-    typename _ItemIt,
     typename _Map
   >
   class DescriptorMap : protected _Map {
+
+    typedef _Item Item;
+    typedef _Map Map;
+
   public:
+    /// The graph class of DescriptorMap.
     typedef _Graph Graph;
-    typedef _Item Item;
-    typedef _ItemIt ItemIt;
-    typedef _Map Map;
-
-
+
+    /// The key type of DescriptorMap (Node, Edge, UndirEdge).
     typedef typename _Map::Key Key;
+    /// The value type of DescriptorMap.
     typedef typename _Map::Value Value;
 
-    typedef vector<Item> InverseMap;
-
+    typedef std::vector<Item> InverseMap;
+
+    /// \brief Constructor.
+    ///
+    /// Constructor for creating descriptor map.
     DescriptorMap(const Graph& _graph) : Map(_graph) {
       build();
@@ -135 +150 @@
     virtual void build() {
       Map::build();
-      for (ItemIt it(*Map::getGraph()); it != INVALID; ++it) {
+      Item it;
+      for (getGraph()->first(it); it != INVALID; getGraph()->next(it)) {
         Map::set(it, inv_map.size());
         inv_map.push_back(it);  
@@ -146 +162 @@
     }
 
+    /// \brief Gives back the \e descriptor of the item.
+    ///
+    /// Gives back the mutable and unique \e descriptor of the map.
     int operator[](const Item& item) const {
       return Map::operator[](item);
     }
-
-    
+    
+    /// \brief Gives back the inverse of the map.
+    ///
+    /// Gives back the inverse of the map.
     const InverseMap inverse() const {
       return inv_map;
@@ -158 +179 @@
     vector<Item> inv_map;
   };
-
-  // unique, immutable => IDMap
   
-  
+  /// Provides an immutable and unique id for each item in the graph.
+
+  /// The IdMap class provides an unique and immutable mapping for each item
+  /// in the graph.
+  ///
+  template <typename _Graph, typename _Item>
+  class IdMap {
+  public:
+    typedef _Graph Graph;
+    typedef int Value;
+    typedef _Item Item;
+
+    /// \brief The class represents the inverse of the map.
+    ///
+    /// The class represents the inverse of the map.
+    /// \see inverse()
+    class InverseMap {
+    protected:
+      InverseMap(const Graph& _graph) : graph(_graph) {}
+    public:
+      /// \brief Gives back the given item by its id.
+      ///
+      /// Gives back the given item by its id.
+      /// 
+      Item operator[](int id) const { return graph->fromId(id, Item());}
+    private:
+      Graph* graph;
+    };
+
+    /// \brief Constructor.
+    ///
+    /// Constructor for creating id map.
+    IdMap(const Graph& _graph) : graph(&_graph) {}
+
+    /// \brief Gives back the \e id of the item.
+    ///
+    /// Gives back the immutable and unique \e id of the map.
+    int operator[](const Item& item) const { return graph->id(item);}
+
+    /// \brief Gives back the inverse of the map.
+    ///
+    /// Gives back the inverse of the map.
+    InverseMap inverse() const { return InverseMap(*graph);} 
+
+  private:
+    const Graph* graph;
+
+  };
+
+
 
 }