Changes in / [573:37216ca5b9c6:571:d5c39e9d1a4e] in lemon-main

Files:

• lemon/maps.h (modified) (14 diffs)
• test/graph_utils_test.cc (modified) (4 diffs)

lemon/maps.h

@@ -1833 +1833 @@
   /// \c GR::Edge).
   ///
-  /// \see RangeIdMap
+  /// \see DescriptorMap
   template <typename GR, typename K>
   class IdMap : public MapBase<K, int> {
@@ -1899 +1899 @@
 
 
-  /// \brief General cross reference graph map type.
+  /// \brief General invertable graph map type.
 
   /// This class provides simple invertable graph maps.
@@ -1916 +1916 @@
   /// \see IterableValueMap
   template <typename GR, typename K, typename V>
-  class CrossRefMap
+  class InvertableMap
     : protected ItemSetTraits<GR, K>::template Map<V>::Type {
   private:
@@ -1928 +1928 @@
   public:
 
-    /// The graph type of CrossRefMap.
+    /// The graph type of InvertableMap.
     typedef GR Graph;
-    /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
+    /// The key type of InvertableMap (\c Node, \c Arc or \c Edge).
     typedef K Item;
-    /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
+    /// The key type of InvertableMap (\c Node, \c Arc or \c Edge).
     typedef K Key;
-    /// The value type of CrossRefMap.
+    /// The value type of InvertableMap.
     typedef V Value;
 
     /// \brief Constructor.
     ///
-    /// Construct a new CrossRefMap for the given graph.
-    explicit CrossRefMap(const Graph& graph) : Map(graph) {}
+    /// Construct a new InvertableMap for the given graph.
+    explicit InvertableMap(const Graph& graph) : Map(graph) {}
 
     /// \brief Forward iterator for values.
@@ -1949 +1949 @@
     class ValueIterator
       : public std::iterator<std::forward_iterator_tag, Value> {
-      friend class CrossRefMap;
+      friend class InvertableMap;
     private:
       ValueIterator(typename Container::const_iterator _it)
@@ -2073 +2073 @@
       ///
       /// Constructor of the InverseMap.
-      explicit InverseMap(const CrossRefMap& inverted)
+      explicit InverseMap(const InvertableMap& inverted)
         : _inverted(inverted) {}
 
       /// The value type of the InverseMap.
-      typedef typename CrossRefMap::Key Value;
+      typedef typename InvertableMap::Key Value;
       /// The key type of the InverseMap.
-      typedef typename CrossRefMap::Value Key;
+      typedef typename InvertableMap::Value Key;
 
       /// \brief Subscript operator.
@@ -2090 +2090 @@
 
     private:
-      const CrossRefMap& _inverted;
+      const InvertableMap& _inverted;
     };
 
@@ -2102 +2102 @@
   };
 
-  /// \brief Provides continuous and unique ID for the
-  /// items of a graph.
-  ///
-  /// RangeIdMap provides a unique and continuous
-  /// ID for each item of a given type (\c Node, \c Arc or
+  /// \brief Provides a mutable, continuous and unique descriptor for each
+  /// item in a graph.
+  ///
+  /// DescriptorMap provides a unique and continuous (but mutable)
+  /// descriptor (id) for each item of the same type (\c Node, \c Arc or
   /// \c Edge) in a graph. This id is
   ///  - \b unique: different items get different ids,
   ///  - \b continuous: the range of the ids is the set of integers
   ///    between 0 and \c n-1, where \c n is the number of the items of
-  ///    this type (\c Node, \c Arc or \c Edge).
-  ///  - So, the ids can change when deleting an item of the same type.
+  ///    this type (\c Node, \c Arc or \c Edge). So the id of an item can
+  ///    change if you delete an other item of the same type, i.e. this
+  ///    id is mutable.
   ///
   /// Thus this id is not (necessarily) the same as what can get using
@@ -2125 +2126 @@
   /// \see IdMap
   template <typename GR, typename K>
-  class RangeIdMap
+  class DescriptorMap
     : protected ItemSetTraits<GR, K>::template Map<int>::Type {
 
@@ -2131 +2132 @@
 
   public:
-    /// The graph type of RangeIdMap.
+    /// The graph type of DescriptorMap.
     typedef GR Graph;
-    /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
+    /// The key type of DescriptorMap (\c Node, \c Arc or \c Edge).
     typedef K Item;
-    /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
+    /// The key type of DescriptorMap (\c Node, \c Arc or \c Edge).
     typedef K Key;
-    /// The value type of RangeIdMap.
+    /// The value type of DescriptorMap.
     typedef int Value;
 
     /// \brief Constructor.
     ///
-    /// Constructor.
-    explicit RangeIdMap(const Graph& gr) : Map(gr) {
+    /// Constructor for descriptor map.
+    explicit DescriptorMap(const Graph& gr) : Map(gr) {
       Item it;
       const typename Map::Notifier* nf = Map::notifier();
@@ -2244 +2245 @@
     }
 
-    /// \brief Gives back the \e RangeId of the item
-    ///
-    /// Gives back the \e RangeId of the item.
+    /// \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 item belonging to a \e RangeId
-    /// 
-    /// Gives back the item belonging to a \e RangeId.
+    /// \brief Gives back the item by its descriptor.
+    ///
+    /// Gives back th item by its descriptor.
     Item operator()(int id) const {
       return _inv_map[id];
@@ -2265 +2266 @@
   public:
 
-    /// \brief The inverse map type of RangeIdMap.
-    ///
-    /// The inverse map type of RangeIdMap.
+    /// \brief The inverse map type of DescriptorMap.
+    ///
+    /// The inverse map type of DescriptorMap.
     class InverseMap {
     public:
@@ -2273 +2274 @@
       ///
       /// Constructor of the InverseMap.
-      explicit InverseMap(const RangeIdMap& inverted)
+      explicit InverseMap(const DescriptorMap& inverted)
         : _inverted(inverted) {}
 
 
       /// The value type of the InverseMap.
-      typedef typename RangeIdMap::Key Value;
+      typedef typename DescriptorMap::Key Value;
       /// The key type of the InverseMap.
-      typedef typename RangeIdMap::Value Key;
+      typedef typename DescriptorMap::Value Key;
 
       /// \brief Subscript operator.
@@ -2298 +2299 @@
 
     private:
-      const RangeIdMap& _inverted;
+      const DescriptorMap& _inverted;
     };
 

test/graph_utils_test.cc

@@ -39 +39 @@
       digraph.addNode();
     }
-    RangeIdMap<Digraph, Node> nodes(digraph);
-    typename RangeIdMap<Digraph, Node>::InverseMap invNodes(nodes);
+    DescriptorMap<Digraph, Node> nodes(digraph);
+    typename DescriptorMap<Digraph, Node>::InverseMap invNodes(nodes);
     for (int i = 0; i < 100; ++i) {
       int src = rnd[invNodes.size()];
@@ -47 +47 @@
     }
     typename Digraph::template ArcMap<bool> found(digraph, false);
-    RangeIdMap<Digraph, Arc> arcs(digraph);
+    DescriptorMap<Digraph, Arc> arcs(digraph);
     for (NodeIt src(digraph); src != INVALID; ++src) {
       for (NodeIt trg(digraph); trg != INVALID; ++trg) {
@@ -114 +114 @@
     graph.addNode();
   }
-  RangeIdMap<Graph, Node> nodes(graph);
-  typename RangeIdMap<Graph, Node>::InverseMap invNodes(nodes);
+  DescriptorMap<Graph, Node> nodes(graph);
+  typename DescriptorMap<Graph, Node>::InverseMap invNodes(nodes);
   for (int i = 0; i < 100; ++i) {
     int src = rnd[invNodes.size()];
@@ -122 +122 @@
   }
   typename Graph::template EdgeMap<int> found(graph, 0);
-  RangeIdMap<Graph, Edge> edges(graph);
+  DescriptorMap<Graph, Edge> edges(graph);
   for (NodeIt src(graph); src != INVALID; ++src) {
     for (NodeIt trg(graph); trg != INVALID; ++trg) {