alpar@209
|
1 |
/* -*- mode: C++; indent-tabs-mode: nil; -*-
|
deba@57
|
2 |
*
|
alpar@209
|
3 |
* This file is a part of LEMON, a generic C++ optimization library.
|
deba@57
|
4 |
*
|
alpar@107
|
5 |
* Copyright (C) 2003-2008
|
deba@57
|
6 |
* Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
|
deba@57
|
7 |
* (Egervary Research Group on Combinatorial Optimization, EGRES).
|
deba@57
|
8 |
*
|
deba@57
|
9 |
* Permission to use, modify and distribute this software is granted
|
deba@57
|
10 |
* provided that this copyright notice appears in all copies. For
|
deba@57
|
11 |
* precise terms see the accompanying LICENSE file.
|
deba@57
|
12 |
*
|
deba@57
|
13 |
* This software is provided "AS IS" with no warranty of any kind,
|
deba@57
|
14 |
* express or implied, and with no claim as to its suitability for any
|
deba@57
|
15 |
* purpose.
|
deba@57
|
16 |
*
|
deba@57
|
17 |
*/
|
deba@57
|
18 |
|
deba@57
|
19 |
#ifndef LEMON_BITS_VECTOR_MAP_H
|
deba@57
|
20 |
#define LEMON_BITS_VECTOR_MAP_H
|
deba@57
|
21 |
|
deba@57
|
22 |
#include <vector>
|
deba@57
|
23 |
#include <algorithm>
|
deba@57
|
24 |
|
deba@220
|
25 |
#include <lemon/core.h>
|
deba@57
|
26 |
#include <lemon/bits/alteration_notifier.h>
|
deba@57
|
27 |
|
deba@57
|
28 |
#include <lemon/concept_check.h>
|
deba@57
|
29 |
#include <lemon/concepts/maps.h>
|
deba@57
|
30 |
|
deba@57
|
31 |
///\ingroup graphbits
|
deba@57
|
32 |
///
|
deba@57
|
33 |
///\file
|
deba@57
|
34 |
///\brief Vector based graph maps.
|
deba@57
|
35 |
namespace lemon {
|
deba@57
|
36 |
|
deba@57
|
37 |
/// \ingroup graphbits
|
deba@57
|
38 |
///
|
deba@57
|
39 |
/// \brief Graph map based on the std::vector storage.
|
deba@57
|
40 |
///
|
deba@57
|
41 |
/// The VectorMap template class is graph map structure what
|
deba@57
|
42 |
/// automatically updates the map when a key is added to or erased from
|
deba@57
|
43 |
/// the map. This map type uses the std::vector to store the values.
|
deba@57
|
44 |
///
|
kpeter@157
|
45 |
/// \tparam _Notifier The AlterationNotifier that will notify this map.
|
kpeter@157
|
46 |
/// \tparam _Item The item type of the graph items.
|
kpeter@157
|
47 |
/// \tparam _Value The value type of the map.
|
kpeter@157
|
48 |
/// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
|
deba@57
|
49 |
template <typename _Graph, typename _Item, typename _Value>
|
alpar@209
|
50 |
class VectorMap
|
deba@57
|
51 |
: public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
|
deba@57
|
52 |
private:
|
alpar@209
|
53 |
|
deba@57
|
54 |
/// The container type of the map.
|
alpar@209
|
55 |
typedef std::vector<_Value> Container;
|
deba@57
|
56 |
|
deba@57
|
57 |
public:
|
deba@57
|
58 |
|
alpar@209
|
59 |
/// The graph type of the map.
|
deba@57
|
60 |
typedef _Graph Graph;
|
deba@57
|
61 |
/// The item type of the map.
|
deba@57
|
62 |
typedef _Item Item;
|
deba@57
|
63 |
/// The reference map tag.
|
deba@57
|
64 |
typedef True ReferenceMapTag;
|
deba@57
|
65 |
|
deba@57
|
66 |
/// The key type of the map.
|
deba@57
|
67 |
typedef _Item Key;
|
deba@57
|
68 |
/// The value type of the map.
|
deba@57
|
69 |
typedef _Value Value;
|
deba@57
|
70 |
|
deba@57
|
71 |
/// The notifier type.
|
deba@57
|
72 |
typedef typename ItemSetTraits<_Graph, _Item>::ItemNotifier Notifier;
|
deba@57
|
73 |
|
deba@57
|
74 |
/// The map type.
|
deba@57
|
75 |
typedef VectorMap Map;
|
deba@57
|
76 |
/// The base class of the map.
|
deba@57
|
77 |
typedef typename Notifier::ObserverBase Parent;
|
deba@57
|
78 |
|
deba@57
|
79 |
/// The reference type of the map;
|
deba@57
|
80 |
typedef typename Container::reference Reference;
|
deba@57
|
81 |
/// The const reference type of the map;
|
deba@57
|
82 |
typedef typename Container::const_reference ConstReference;
|
deba@57
|
83 |
|
deba@57
|
84 |
|
deba@57
|
85 |
/// \brief Constructor to attach the new map into the notifier.
|
deba@57
|
86 |
///
|
deba@57
|
87 |
/// It constructs a map and attachs it into the notifier.
|
deba@57
|
88 |
/// It adds all the items of the graph to the map.
|
deba@57
|
89 |
VectorMap(const Graph& graph) {
|
deba@57
|
90 |
Parent::attach(graph.notifier(Item()));
|
deba@57
|
91 |
container.resize(Parent::notifier()->maxId() + 1);
|
deba@57
|
92 |
}
|
deba@57
|
93 |
|
alpar@209
|
94 |
/// \brief Constructor uses given value to initialize the map.
|
deba@57
|
95 |
///
|
alpar@209
|
96 |
/// It constructs a map uses a given value to initialize the map.
|
deba@57
|
97 |
/// It adds all the items of the graph to the map.
|
deba@57
|
98 |
VectorMap(const Graph& graph, const Value& value) {
|
deba@57
|
99 |
Parent::attach(graph.notifier(Item()));
|
deba@57
|
100 |
container.resize(Parent::notifier()->maxId() + 1, value);
|
deba@57
|
101 |
}
|
deba@57
|
102 |
|
deba@57
|
103 |
/// \brief Copy constructor
|
deba@57
|
104 |
///
|
deba@57
|
105 |
/// Copy constructor.
|
deba@57
|
106 |
VectorMap(const VectorMap& _copy) : Parent() {
|
deba@57
|
107 |
if (_copy.attached()) {
|
alpar@209
|
108 |
Parent::attach(*_copy.notifier());
|
alpar@209
|
109 |
container = _copy.container;
|
deba@57
|
110 |
}
|
deba@57
|
111 |
}
|
deba@57
|
112 |
|
deba@57
|
113 |
/// \brief Assign operator.
|
deba@57
|
114 |
///
|
deba@57
|
115 |
/// This operator assigns for each item in the map the
|
alpar@209
|
116 |
/// value mapped to the same item in the copied map.
|
deba@57
|
117 |
/// The parameter map should be indiced with the same
|
deba@57
|
118 |
/// itemset because this assign operator does not change
|
alpar@209
|
119 |
/// the container of the map.
|
deba@57
|
120 |
VectorMap& operator=(const VectorMap& cmap) {
|
deba@57
|
121 |
return operator=<VectorMap>(cmap);
|
deba@57
|
122 |
}
|
deba@57
|
123 |
|
deba@57
|
124 |
|
deba@57
|
125 |
/// \brief Template assign operator.
|
deba@57
|
126 |
///
|
deba@57
|
127 |
/// The given parameter should be conform to the ReadMap
|
deba@57
|
128 |
/// concecpt and could be indiced by the current item set of
|
deba@57
|
129 |
/// the NodeMap. In this case the value for each item
|
alpar@209
|
130 |
/// is assigned by the value of the given ReadMap.
|
deba@57
|
131 |
template <typename CMap>
|
deba@57
|
132 |
VectorMap& operator=(const CMap& cmap) {
|
deba@57
|
133 |
checkConcept<concepts::ReadMap<Key, _Value>, CMap>();
|
deba@57
|
134 |
const typename Parent::Notifier* nf = Parent::notifier();
|
deba@57
|
135 |
Item it;
|
deba@57
|
136 |
for (nf->first(it); it != INVALID; nf->next(it)) {
|
deba@57
|
137 |
set(it, cmap[it]);
|
deba@57
|
138 |
}
|
deba@57
|
139 |
return *this;
|
deba@57
|
140 |
}
|
alpar@209
|
141 |
|
deba@57
|
142 |
public:
|
deba@57
|
143 |
|
deba@57
|
144 |
/// \brief The subcript operator.
|
deba@57
|
145 |
///
|
deba@57
|
146 |
/// The subscript operator. The map can be subscripted by the
|
alpar@209
|
147 |
/// actual items of the graph.
|
deba@57
|
148 |
Reference operator[](const Key& key) {
|
deba@57
|
149 |
return container[Parent::notifier()->id(key)];
|
alpar@209
|
150 |
}
|
alpar@209
|
151 |
|
deba@57
|
152 |
/// \brief The const subcript operator.
|
deba@57
|
153 |
///
|
deba@57
|
154 |
/// The const subscript operator. The map can be subscripted by the
|
alpar@209
|
155 |
/// actual items of the graph.
|
deba@57
|
156 |
ConstReference operator[](const Key& key) const {
|
deba@57
|
157 |
return container[Parent::notifier()->id(key)];
|
deba@57
|
158 |
}
|
deba@57
|
159 |
|
deba@57
|
160 |
|
deba@57
|
161 |
/// \brief The setter function of the map.
|
deba@57
|
162 |
///
|
deba@57
|
163 |
/// It the same as operator[](key) = value expression.
|
deba@57
|
164 |
void set(const Key& key, const Value& value) {
|
deba@57
|
165 |
(*this)[key] = value;
|
deba@57
|
166 |
}
|
deba@57
|
167 |
|
deba@57
|
168 |
protected:
|
deba@57
|
169 |
|
deba@57
|
170 |
/// \brief Adds a new key to the map.
|
alpar@209
|
171 |
///
|
deba@57
|
172 |
/// It adds a new key to the map. It called by the observer notifier
|
alpar@209
|
173 |
/// and it overrides the add() member function of the observer base.
|
deba@57
|
174 |
virtual void add(const Key& key) {
|
deba@57
|
175 |
int id = Parent::notifier()->id(key);
|
deba@57
|
176 |
if (id >= int(container.size())) {
|
alpar@209
|
177 |
container.resize(id + 1);
|
deba@57
|
178 |
}
|
deba@57
|
179 |
}
|
deba@57
|
180 |
|
deba@57
|
181 |
/// \brief Adds more new keys to the map.
|
alpar@209
|
182 |
///
|
deba@57
|
183 |
/// It adds more new keys to the map. It called by the observer notifier
|
alpar@209
|
184 |
/// and it overrides the add() member function of the observer base.
|
deba@57
|
185 |
virtual void add(const std::vector<Key>& keys) {
|
deba@57
|
186 |
int max = container.size() - 1;
|
deba@57
|
187 |
for (int i = 0; i < int(keys.size()); ++i) {
|
deba@57
|
188 |
int id = Parent::notifier()->id(keys[i]);
|
deba@57
|
189 |
if (id >= max) {
|
deba@57
|
190 |
max = id;
|
deba@57
|
191 |
}
|
deba@57
|
192 |
}
|
deba@57
|
193 |
container.resize(max + 1);
|
deba@57
|
194 |
}
|
deba@57
|
195 |
|
deba@57
|
196 |
/// \brief Erase a key from the map.
|
deba@57
|
197 |
///
|
deba@57
|
198 |
/// Erase a key from the map. It called by the observer notifier
|
alpar@209
|
199 |
/// and it overrides the erase() member function of the observer base.
|
deba@57
|
200 |
virtual void erase(const Key& key) {
|
deba@57
|
201 |
container[Parent::notifier()->id(key)] = Value();
|
deba@57
|
202 |
}
|
deba@57
|
203 |
|
deba@57
|
204 |
/// \brief Erase more keys from the map.
|
deba@57
|
205 |
///
|
deba@57
|
206 |
/// Erase more keys from the map. It called by the observer notifier
|
alpar@209
|
207 |
/// and it overrides the erase() member function of the observer base.
|
deba@57
|
208 |
virtual void erase(const std::vector<Key>& keys) {
|
deba@57
|
209 |
for (int i = 0; i < int(keys.size()); ++i) {
|
alpar@209
|
210 |
container[Parent::notifier()->id(keys[i])] = Value();
|
deba@57
|
211 |
}
|
deba@57
|
212 |
}
|
alpar@209
|
213 |
|
deba@57
|
214 |
/// \brief Buildes the map.
|
alpar@209
|
215 |
///
|
deba@57
|
216 |
/// It buildes the map. It called by the observer notifier
|
deba@57
|
217 |
/// and it overrides the build() member function of the observer base.
|
alpar@209
|
218 |
virtual void build() {
|
deba@57
|
219 |
int size = Parent::notifier()->maxId() + 1;
|
deba@57
|
220 |
container.reserve(size);
|
deba@57
|
221 |
container.resize(size);
|
deba@57
|
222 |
}
|
deba@57
|
223 |
|
deba@57
|
224 |
/// \brief Clear the map.
|
deba@57
|
225 |
///
|
deba@57
|
226 |
/// It erase all items from the map. It called by the observer notifier
|
alpar@209
|
227 |
/// and it overrides the clear() member function of the observer base.
|
alpar@209
|
228 |
virtual void clear() {
|
deba@57
|
229 |
container.clear();
|
deba@57
|
230 |
}
|
alpar@209
|
231 |
|
deba@57
|
232 |
private:
|
alpar@209
|
233 |
|
deba@57
|
234 |
Container container;
|
deba@57
|
235 |
|
deba@57
|
236 |
};
|
deba@57
|
237 |
|
deba@57
|
238 |
}
|
deba@57
|
239 |
|
deba@57
|
240 |
#endif
|