COIN-OR::LEMON - Graph Library

source: lemon-0.x/lemon/bits/vector_map.h @ 1703:eb90e3d6bddc

Last change on this file since 1703:eb90e3d6bddc was 1703:eb90e3d6bddc, checked in by Balazs Dezso, 14 years ago

Proper sized map type

File size: 5.8 KB
Line 
1/* -*- C++ -*-
2 * lemon/vector_map.h - Part of LEMON, a generic C++ optimization library
3 *
4 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Research Group on Combinatorial Optimization, EGRES).
6 *
7 * Permission to use, modify and distribute this software is granted
8 * provided that this copyright notice appears in all copies. For
9 * precise terms see the accompanying LICENSE file.
10 *
11 * This software is provided "AS IS" with no warranty of any kind,
12 * express or implied, and with no claim as to its suitability for any
13 * purpose.
14 *
15 */
16
17#ifndef LEMON_VECTOR_MAP_H
18#define LEMON_VECTOR_MAP_H
19
20#include <vector>
21#include <algorithm>
22
23#include <lemon/utility.h>
24#include <lemon/bits/map_iterator.h>
25#include <lemon/bits/alteration_notifier.h>
26#include <lemon/concept_check.h>
27#include <lemon/concept/maps.h>
28
29/// \ingroup graphmapfactory
30///
31///\file
32///\brief Vector based graph maps.
33
34namespace lemon {
35
36  /// \ingroup graphmapfactory
37  ///
38  /// \brief Graph map based on the std::vector storage.
39  ///
40  /// The VectorMap template class is graph map structure what
41  /// automatically updates the map when a key is added to or erased from
42  /// the map. This map factory uses the allocators to implement
43  /// the container functionality. This map factory
44  /// uses the std::vector to implement the container function.
45  ///
46  /// \param Registry The AlterationNotifier that will notify this map.
47  /// \param Item The item type of the graph items.
48  /// \param Value The value type of the map.
49  ///
50  /// \author Balazs Dezso
51       
52  template <
53    typename _Graph,
54    typename _Item,   
55    typename _Value
56    >
57  class VectorMap : public AlterationNotifier<_Item>::ObserverBase {
58  public:
59
60    typedef True AdaptibleTag;
61               
62    /// The graph type of the map.
63    typedef _Graph Graph;
64    /// The key type of the map.
65    typedef _Item Key;
66    /// The id map type of the map.
67    typedef AlterationNotifier<_Item> Registry;
68    /// The value type of the map.
69    typedef _Value Value;
70
71    /// The map type.
72    typedef VectorMap Map;
73    /// The base class of the map.
74    typedef typename Registry::ObserverBase Parent;
75
76  private:
77               
78    /// The container type of the map.
79    typedef std::vector<Value> Container;       
80
81  public:
82
83    /// The reference type of the map;
84    typedef typename Container::reference Reference;
85    /// The pointer type of the map;
86    typedef typename Container::pointer Pointer;
87
88    /// The const value type of the map.
89    typedef const Value ConstValue;
90    /// The const reference type of the map;
91    typedef typename Container::const_reference ConstReference;
92    /// The pointer type of the map;
93    typedef typename Container::const_pointer ConstPointer;
94
95    typedef True FullTypeTag;
96
97    /// \brief Constructor to attach the new map into the registry.
98    ///
99    /// It constructs a map and attachs it into the registry.
100    /// It adds all the items of the graph to the map.
101    VectorMap(const Graph& _g) : graph(&_g) {
102      attach(_g.getNotifier(_Item()));
103      build();
104    }
105
106    /// \brief Constructor uses given value to initialize the map.
107    ///
108    /// It constructs a map uses a given value to initialize the map.
109    /// It adds all the items of the graph to the map.
110    VectorMap(const Graph& _g, const Value& _v) : graph(&_g) {
111      attach(_g.getNotifier(_Item()));
112      container.resize(graph->maxId(_Item()) + 1, _v);
113    }
114
115    /// \brief Copy constructor
116    ///
117    /// Copy constructor.
118    VectorMap(const VectorMap& _copy)
119      : Parent(), graph(_copy.getGraph()) {
120      if (_copy.attached()) {
121        attach(*_copy.getRegistry());
122        container = _copy.container;
123      }
124    }
125
126    /// \brief Destrcutor
127    ///
128    /// Destructor.
129    virtual ~VectorMap() {
130      if (attached()) {
131        detach();
132      }
133    }
134
135
136  private:
137
138    VectorMap& operator=(const VectorMap&);
139
140  protected:
141
142    using Parent::attach;
143    using Parent::detach;
144    using Parent::attached;
145
146    const Graph* getGraph() const {
147      return graph;
148    }
149
150  public:
151
152    /// \brief The subcript operator.
153    ///
154    /// The subscript operator. The map can be subscripted by the
155    /// actual items of the graph.     
156    Reference operator[](const Key& key) {
157      return container[graph->id(key)];
158    }
159               
160    /// \brief The const subcript operator.
161    ///
162    /// The const subscript operator. The map can be subscripted by the
163    /// actual items of the graph.
164    ConstReference operator[](const Key& key) const {
165      return container[graph->id(key)];
166    }
167
168
169    /// \brief The setter function of the map.
170    ///
171    /// It the same as operator[](key) = value expression.
172    void set(const Key& key, const Value& value) {
173      (*this)[key] = value;
174    }
175
176  protected:
177
178    /// \brief Adds a new key to the map.
179    ///         
180    /// It adds a new key to the map. It called by the observer registry
181    /// and it overrides the add() member function of the observer base.     
182    virtual void add(const Key& key) {
183      int id = graph->id(key);
184      if (id >= (int)container.size()) {
185        container.resize(id + 1);
186      }
187    }
188
189    /// \brief Erase a key from the map.
190    ///
191    /// Erase a key from the map. It called by the observer registry
192    /// and it overrides the erase() member function of the observer base.     
193    virtual void erase(const Key&) {}
194
195    /// \brief Buildes the map.
196    ///
197    /// It buildes the map. It called by the observer registry
198    /// and it overrides the build() member function of the observer base.
199    virtual void build() {
200      container.resize(graph->maxId(_Item()) + 1);
201    }
202
203    /// \brief Clear the map.
204    ///
205    /// It erase all items from the map. It called by the observer registry
206    /// and it overrides the clear() member function of the observer base.     
207    virtual void clear() {
208      container.clear();
209    }
210   
211  private:
212               
213    Container container;
214    const Graph *graph;
215
216  };
217
218}
219
220#endif
Note: See TracBrowser for help on using the repository browser.