[906] | 1 | /* -*- C++ -*- |
---|
[1435] | 2 | * lemon/bits/array_map.h - Part of LEMON, a generic C++ optimization library |
---|
[906] | 3 | * |
---|
[1875] | 4 | * Copyright (C) 2006 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
[1910] | 5 | * (Egervary Research Groin on Combinatorial Optimization, EGRES). |
---|
[906] | 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 | |
---|
[921] | 17 | #ifndef LEMON_ARRAY_MAP_H |
---|
| 18 | #define LEMON_ARRAY_MAP_H |
---|
[822] | 19 | |
---|
| 20 | #include <memory> |
---|
[1810] | 21 | #include <lemon/bits/map_extender.h> |
---|
[1813] | 22 | #include <lemon/bits/alteration_notifier.h> |
---|
[1669] | 23 | #include <lemon/concept_check.h> |
---|
| 24 | #include <lemon/concept/maps.h> |
---|
[822] | 25 | |
---|
[1946] | 26 | /// \ingroup graphmapfactory |
---|
[1669] | 27 | /// \file |
---|
| 28 | /// \brief Graph maps that construct and destruct |
---|
| 29 | /// their elements dynamically. |
---|
[822] | 30 | |
---|
[921] | 31 | namespace lemon { |
---|
[822] | 32 | |
---|
[1946] | 33 | /// \ingroup graphmapfactory |
---|
[1669] | 34 | /// |
---|
| 35 | /// \brief Graph map based on the array storage. |
---|
| 36 | /// |
---|
[1414] | 37 | /// The ArrayMap template class is graph map structure what |
---|
[1910] | 38 | /// automatically indates the map when a key is added to or erased from |
---|
[1669] | 39 | /// the map. This map uses the allocators to implement |
---|
[1414] | 40 | /// the container functionality. |
---|
| 41 | /// |
---|
| 42 | /// The template parameter is the AlterationNotifier that the maps |
---|
| 43 | /// will belong to and the Value. |
---|
[822] | 44 | |
---|
[946] | 45 | template <typename _Graph, |
---|
| 46 | typename _Item, |
---|
| 47 | typename _Value> |
---|
[1039] | 48 | class ArrayMap : public AlterationNotifier<_Item>::ObserverBase { |
---|
[897] | 49 | |
---|
[1267] | 50 | typedef _Item Item; |
---|
[822] | 51 | public: |
---|
| 52 | /// The graph type of the maps. |
---|
[946] | 53 | typedef _Graph Graph; |
---|
[1719] | 54 | /// The reference map tag. |
---|
| 55 | typedef True ReferenceMapTag; |
---|
| 56 | |
---|
[822] | 57 | /// The key type of the maps. |
---|
[987] | 58 | typedef _Item Key; |
---|
[1719] | 59 | /// The value type of the map. |
---|
| 60 | typedef _Value Value; |
---|
| 61 | /// The const reference type of the map. |
---|
| 62 | typedef const _Value& ConstReference; |
---|
| 63 | /// The reference type of the map. |
---|
| 64 | typedef _Value& Reference; |
---|
| 65 | |
---|
| 66 | typedef const Value ConstValue; |
---|
| 67 | typedef Value* Pointer; |
---|
| 68 | typedef const Value* ConstPointer; |
---|
[946] | 69 | |
---|
[1039] | 70 | typedef AlterationNotifier<_Item> Registry; |
---|
[946] | 71 | |
---|
[822] | 72 | /// The MapBase of the Map which imlements the core regisitry function. |
---|
[946] | 73 | typedef typename Registry::ObserverBase Parent; |
---|
[822] | 74 | |
---|
| 75 | |
---|
| 76 | |
---|
[946] | 77 | private: |
---|
[822] | 78 | typedef std::allocator<Value> Allocator; |
---|
| 79 | |
---|
[946] | 80 | |
---|
| 81 | public: |
---|
| 82 | |
---|
[1719] | 83 | /// \brief Graph initialized map constructor. |
---|
[1703] | 84 | /// |
---|
[1719] | 85 | /// Graph initialized map constructor. |
---|
[980] | 86 | ArrayMap(const Graph& _g) : graph(&_g) { |
---|
[1267] | 87 | Item it; |
---|
| 88 | attach(_g.getNotifier(Item())); |
---|
[822] | 89 | allocate_memory(); |
---|
[1267] | 90 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[980] | 91 | int id = graph->id(it);; |
---|
[822] | 92 | allocator.construct(&(values[id]), Value()); |
---|
| 93 | } |
---|
| 94 | } |
---|
| 95 | |
---|
[1703] | 96 | /// \brief Constructor to use default value to initialize the map. |
---|
| 97 | /// |
---|
| 98 | /// It constructs a map and initialize all of the the map. |
---|
[980] | 99 | ArrayMap(const Graph& _g, const Value& _v) : graph(&_g) { |
---|
[1267] | 100 | Item it; |
---|
[1039] | 101 | attach(_g.getNotifier(_Item())); |
---|
[822] | 102 | allocate_memory(); |
---|
[1267] | 103 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[980] | 104 | int id = graph->id(it);; |
---|
[946] | 105 | allocator.construct(&(values[id]), _v); |
---|
[822] | 106 | } |
---|
| 107 | } |
---|
| 108 | |
---|
[1703] | 109 | /// \brief Constructor to copy a map of the same map type. |
---|
| 110 | /// |
---|
| 111 | /// Constructor to copy a map of the same map type. |
---|
[1613] | 112 | ArrayMap(const ArrayMap& copy) : Parent(), graph(copy.graph) { |
---|
[946] | 113 | if (copy.attached()) { |
---|
| 114 | attach(*copy.getRegistry()); |
---|
| 115 | } |
---|
[822] | 116 | capacity = copy.capacity; |
---|
| 117 | if (capacity == 0) return; |
---|
| 118 | values = allocator.allocate(capacity); |
---|
[1267] | 119 | Item it; |
---|
| 120 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[980] | 121 | int id = graph->id(it);; |
---|
[891] | 122 | allocator.construct(&(values[id]), copy.values[id]); |
---|
[822] | 123 | } |
---|
| 124 | } |
---|
| 125 | |
---|
[1669] | 126 | /// \brief The destructor of the map. |
---|
| 127 | /// |
---|
[1414] | 128 | /// The destructor of the map. |
---|
[946] | 129 | virtual ~ArrayMap() { |
---|
| 130 | if (attached()) { |
---|
| 131 | clear(); |
---|
| 132 | detach(); |
---|
[822] | 133 | } |
---|
| 134 | } |
---|
[1669] | 135 | |
---|
| 136 | private: |
---|
| 137 | |
---|
| 138 | ArrayMap& operator=(const ArrayMap&); |
---|
| 139 | |
---|
| 140 | protected: |
---|
| 141 | |
---|
| 142 | using Parent::attach; |
---|
| 143 | using Parent::detach; |
---|
| 144 | using Parent::attached; |
---|
| 145 | |
---|
| 146 | const Graph* getGraph() { |
---|
| 147 | return graph; |
---|
| 148 | } |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | public: |
---|
| 152 | |
---|
[1703] | 153 | /// \brief The subscript operator. |
---|
| 154 | /// |
---|
| 155 | /// The subscript operator. The map can be subscripted by the |
---|
| 156 | /// actual keys of the graph. |
---|
[1267] | 157 | Value& operator[](const Key& key) { |
---|
[980] | 158 | int id = graph->id(key); |
---|
[822] | 159 | return values[id]; |
---|
| 160 | } |
---|
| 161 | |
---|
[1703] | 162 | /// \brief The const subscript operator. |
---|
| 163 | /// |
---|
| 164 | /// The const subscript operator. The map can be subscripted by the |
---|
| 165 | /// actual keys of the graph. |
---|
[1267] | 166 | const Value& operator[](const Key& key) const { |
---|
[980] | 167 | int id = graph->id(key); |
---|
[822] | 168 | return values[id]; |
---|
| 169 | } |
---|
[1703] | 170 | |
---|
| 171 | /// \brief Setter function of the map. |
---|
| 172 | /// |
---|
[1414] | 173 | /// Setter function of the map. Equivalent with map[key] = val. |
---|
| 174 | /// This is a compatibility feature with the not dereferable maps. |
---|
[987] | 175 | void set(const Key& key, const Value& val) { |
---|
[946] | 176 | (*this)[key] = val; |
---|
[822] | 177 | } |
---|
[1669] | 178 | |
---|
| 179 | protected: |
---|
[1703] | 180 | |
---|
[1414] | 181 | /// Add a new key to the map. It called by the map registry. |
---|
[1703] | 182 | |
---|
| 183 | virtual void add(const Key& key) { |
---|
[980] | 184 | int id = graph->id(key); |
---|
[822] | 185 | if (id >= capacity) { |
---|
| 186 | int new_capacity = (capacity == 0 ? 1 : capacity); |
---|
| 187 | while (new_capacity <= id) { |
---|
| 188 | new_capacity <<= 1; |
---|
| 189 | } |
---|
[946] | 190 | Value* new_values = allocator.allocate(new_capacity); |
---|
[1267] | 191 | Item it; |
---|
| 192 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[980] | 193 | int jd = graph->id(it);; |
---|
[822] | 194 | if (id != jd) { |
---|
| 195 | allocator.construct(&(new_values[jd]), values[jd]); |
---|
| 196 | allocator.destroy(&(values[jd])); |
---|
| 197 | } |
---|
| 198 | } |
---|
| 199 | if (capacity != 0) allocator.deallocate(values, capacity); |
---|
| 200 | values = new_values; |
---|
| 201 | capacity = new_capacity; |
---|
| 202 | } |
---|
| 203 | allocator.construct(&(values[id]), Value()); |
---|
| 204 | } |
---|
[1414] | 205 | |
---|
[1703] | 206 | virtual void add(const std::vector<Key>& keys) { |
---|
[1414] | 207 | int max_id = -1; |
---|
| 208 | for (int i = 0; i < (int)keys.size(); ++i) { |
---|
| 209 | int id = graph->id(keys[i]); |
---|
| 210 | if (id > max_id) { |
---|
| 211 | max_id = id; |
---|
| 212 | } |
---|
| 213 | } |
---|
| 214 | if (max_id >= capacity) { |
---|
| 215 | int new_capacity = (capacity == 0 ? 1 : capacity); |
---|
| 216 | while (new_capacity <= max_id) { |
---|
| 217 | new_capacity <<= 1; |
---|
| 218 | } |
---|
| 219 | Value* new_values = allocator.allocate(new_capacity); |
---|
| 220 | Item it; |
---|
| 221 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
| 222 | int id = graph->id(it); |
---|
| 223 | bool found = false; |
---|
| 224 | for (int i = 0; i < (int)keys.size(); ++i) { |
---|
| 225 | int jd = graph->id(keys[i]); |
---|
| 226 | if (id == jd) { |
---|
| 227 | found = true; |
---|
| 228 | break; |
---|
| 229 | } |
---|
| 230 | } |
---|
| 231 | if (found) continue; |
---|
| 232 | allocator.construct(&(new_values[id]), values[id]); |
---|
| 233 | allocator.destroy(&(values[id])); |
---|
| 234 | } |
---|
| 235 | if (capacity != 0) allocator.deallocate(values, capacity); |
---|
| 236 | values = new_values; |
---|
| 237 | capacity = new_capacity; |
---|
| 238 | } |
---|
| 239 | for (int i = 0; i < (int)keys.size(); ++i) { |
---|
| 240 | int id = graph->id(keys[i]); |
---|
| 241 | allocator.construct(&(values[id]), Value()); |
---|
| 242 | } |
---|
| 243 | } |
---|
[822] | 244 | |
---|
[1414] | 245 | /// Erase a key from the map. It called by the map registry. |
---|
| 246 | |
---|
[1703] | 247 | virtual void erase(const Key& key) { |
---|
[980] | 248 | int id = graph->id(key); |
---|
[822] | 249 | allocator.destroy(&(values[id])); |
---|
| 250 | } |
---|
| 251 | |
---|
[1703] | 252 | virtual void erase(const std::vector<Key>& keys) { |
---|
[1414] | 253 | for (int i = 0; i < (int)keys.size(); ++i) { |
---|
| 254 | int id = graph->id(keys[i]); |
---|
| 255 | allocator.destroy(&(values[id])); |
---|
| 256 | } |
---|
| 257 | } |
---|
| 258 | |
---|
[1703] | 259 | virtual void build() { |
---|
[946] | 260 | allocate_memory(); |
---|
[1267] | 261 | Item it; |
---|
| 262 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[980] | 263 | int id = graph->id(it);; |
---|
[946] | 264 | allocator.construct(&(values[id]), Value()); |
---|
| 265 | } |
---|
| 266 | } |
---|
| 267 | |
---|
[1703] | 268 | virtual void clear() { |
---|
[822] | 269 | if (capacity != 0) { |
---|
[1267] | 270 | Item it; |
---|
| 271 | for (graph->first(it); it != INVALID; graph->next(it)) { |
---|
[1414] | 272 | int id = graph->id(it); |
---|
[946] | 273 | allocator.destroy(&(values[id])); |
---|
| 274 | } |
---|
[822] | 275 | allocator.deallocate(values, capacity); |
---|
| 276 | capacity = 0; |
---|
| 277 | } |
---|
| 278 | } |
---|
| 279 | |
---|
| 280 | private: |
---|
| 281 | |
---|
| 282 | void allocate_memory() { |
---|
[980] | 283 | int max_id = graph->maxId(_Item()); |
---|
[822] | 284 | if (max_id == -1) { |
---|
| 285 | capacity = 0; |
---|
| 286 | values = 0; |
---|
| 287 | return; |
---|
| 288 | } |
---|
| 289 | capacity = 1; |
---|
| 290 | while (capacity <= max_id) { |
---|
| 291 | capacity <<= 1; |
---|
| 292 | } |
---|
| 293 | values = allocator.allocate(capacity); |
---|
| 294 | } |
---|
| 295 | |
---|
[946] | 296 | const Graph* graph; |
---|
[822] | 297 | int capacity; |
---|
| 298 | Value* values; |
---|
| 299 | Allocator allocator; |
---|
[844] | 300 | |
---|
[822] | 301 | }; |
---|
| 302 | |
---|
| 303 | } |
---|
| 304 | |
---|
[921] | 305 | #endif //LEMON_ARRAY_MAP_H |
---|