COIN-OR::LEMON - Graph Library

Changeset 572:be6646ac5d89 in lemon-1.2 for lemon


Ignore:
Timestamp:
04/04/09 08:30:58 (11 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

DescriptorMap?->RangeIdMap?, InvertableMap?->CrossRefMap? (#160)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r559 r572  
    18331833  /// \c GR::Edge).
    18341834  ///
    1835   /// \see DescriptorMap
     1835  /// \see RangeIdMap
    18361836  template <typename GR, typename K>
    18371837  class IdMap : public MapBase<K, int> {
     
    18991899
    19001900
    1901   /// \brief General invertable graph map type.
     1901  /// \brief General cross reference graph map type.
    19021902
    19031903  /// This class provides simple invertable graph maps.
     
    19161916  /// \see IterableValueMap
    19171917  template <typename GR, typename K, typename V>
    1918   class InvertableMap
     1918  class CrossRefMap
    19191919    : protected ItemSetTraits<GR, K>::template Map<V>::Type {
    19201920  private:
     
    19281928  public:
    19291929
    1930     /// The graph type of InvertableMap.
     1930    /// The graph type of CrossRefMap.
    19311931    typedef GR Graph;
    1932     /// The key type of InvertableMap (\c Node, \c Arc or \c Edge).
     1932    /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
    19331933    typedef K Item;
    1934     /// The key type of InvertableMap (\c Node, \c Arc or \c Edge).
     1934    /// The key type of CrossRefMap (\c Node, \c Arc or \c Edge).
    19351935    typedef K Key;
    1936     /// The value type of InvertableMap.
     1936    /// The value type of CrossRefMap.
    19371937    typedef V Value;
    19381938
    19391939    /// \brief Constructor.
    19401940    ///
    1941     /// Construct a new InvertableMap for the given graph.
    1942     explicit InvertableMap(const Graph& graph) : Map(graph) {}
     1941    /// Construct a new CrossRefMap for the given graph.
     1942    explicit CrossRefMap(const Graph& graph) : Map(graph) {}
    19431943
    19441944    /// \brief Forward iterator for values.
     
    19491949    class ValueIterator
    19501950      : public std::iterator<std::forward_iterator_tag, Value> {
    1951       friend class InvertableMap;
     1951      friend class CrossRefMap;
    19521952    private:
    19531953      ValueIterator(typename Container::const_iterator _it)
     
    20732073      ///
    20742074      /// Constructor of the InverseMap.
    2075       explicit InverseMap(const InvertableMap& inverted)
     2075      explicit InverseMap(const CrossRefMap& inverted)
    20762076        : _inverted(inverted) {}
    20772077
    20782078      /// The value type of the InverseMap.
    2079       typedef typename InvertableMap::Key Value;
     2079      typedef typename CrossRefMap::Key Value;
    20802080      /// The key type of the InverseMap.
    2081       typedef typename InvertableMap::Value Key;
     2081      typedef typename CrossRefMap::Value Key;
    20822082
    20832083      /// \brief Subscript operator.
     
    20902090
    20912091    private:
    2092       const InvertableMap& _inverted;
     2092      const CrossRefMap& _inverted;
    20932093    };
    20942094
     
    21022102  };
    21032103
    2104   /// \brief Provides a mutable, continuous and unique descriptor for each
    2105   /// item in a graph.
    2106   ///
    2107   /// DescriptorMap provides a unique and continuous (but mutable)
    2108   /// descriptor (id) for each item of the same type (\c Node, \c Arc or
     2104  /// \brief Provides continuous and unique ID for the
     2105  /// items of a graph.
     2106  ///
     2107  /// RangeIdMap provides a unique and continuous
     2108  /// ID for each item of a given type (\c Node, \c Arc or
    21092109  /// \c Edge) in a graph. This id is
    21102110  ///  - \b unique: different items get different ids,
    21112111  ///  - \b continuous: the range of the ids is the set of integers
    21122112  ///    between 0 and \c n-1, where \c n is the number of the items of
    2113   ///    this type (\c Node, \c Arc or \c Edge). So the id of an item can
    2114   ///    change if you delete an other item of the same type, i.e. this
    2115   ///    id is mutable.
     2113  ///    this type (\c Node, \c Arc or \c Edge).
     2114  ///  - So, the ids can change when deleting an item of the same type.
    21162115  ///
    21172116  /// Thus this id is not (necessarily) the same as what can get using
     
    21262125  /// \see IdMap
    21272126  template <typename GR, typename K>
    2128   class DescriptorMap
     2127  class RangeIdMap
    21292128    : protected ItemSetTraits<GR, K>::template Map<int>::Type {
    21302129
     
    21322131
    21332132  public:
    2134     /// The graph type of DescriptorMap.
     2133    /// The graph type of RangeIdMap.
    21352134    typedef GR Graph;
    2136     /// The key type of DescriptorMap (\c Node, \c Arc or \c Edge).
     2135    /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
    21372136    typedef K Item;
    2138     /// The key type of DescriptorMap (\c Node, \c Arc or \c Edge).
     2137    /// The key type of RangeIdMap (\c Node, \c Arc or \c Edge).
    21392138    typedef K Key;
    2140     /// The value type of DescriptorMap.
     2139    /// The value type of RangeIdMap.
    21412140    typedef int Value;
    21422141
    21432142    /// \brief Constructor.
    21442143    ///
    2145     /// Constructor for descriptor map.
    2146     explicit DescriptorMap(const Graph& gr) : Map(gr) {
     2144    /// Constructor.
     2145    explicit RangeIdMap(const Graph& gr) : Map(gr) {
    21472146      Item it;
    21482147      const typename Map::Notifier* nf = Map::notifier();
     
    22452244    }
    22462245
    2247     /// \brief Gives back the \e descriptor of the item.
    2248     ///
    2249     /// Gives back the mutable and unique \e descriptor of the map.
     2246    /// \brief Gives back the \e RangeId of the item
     2247    ///
     2248    /// Gives back the \e RangeId of the item.
    22502249    int operator[](const Item& item) const {
    22512250      return Map::operator[](item);
    22522251    }
    22532252
    2254     /// \brief Gives back the item by its descriptor.
    2255     ///
    2256     /// Gives back th item by its descriptor.
     2253    /// \brief Gives back the item belonging to a \e RangeId
     2254    /// 
     2255    /// Gives back the item belonging to a \e RangeId.
    22572256    Item operator()(int id) const {
    22582257      return _inv_map[id];
     
    22662265  public:
    22672266
    2268     /// \brief The inverse map type of DescriptorMap.
    2269     ///
    2270     /// The inverse map type of DescriptorMap.
     2267    /// \brief The inverse map type of RangeIdMap.
     2268    ///
     2269    /// The inverse map type of RangeIdMap.
    22712270    class InverseMap {
    22722271    public:
     
    22742273      ///
    22752274      /// Constructor of the InverseMap.
    2276       explicit InverseMap(const DescriptorMap& inverted)
     2275      explicit InverseMap(const RangeIdMap& inverted)
    22772276        : _inverted(inverted) {}
    22782277
    22792278
    22802279      /// The value type of the InverseMap.
    2281       typedef typename DescriptorMap::Key Value;
     2280      typedef typename RangeIdMap::Key Value;
    22822281      /// The key type of the InverseMap.
    2283       typedef typename DescriptorMap::Value Key;
     2282      typedef typename RangeIdMap::Value Key;
    22842283
    22852284      /// \brief Subscript operator.
     
    22992298
    23002299    private:
    2301       const DescriptorMap& _inverted;
     2300      const RangeIdMap& _inverted;
    23022301    };
    23032302
Note: See TracChangeset for help on using the changeset viewer.