[906] | 1 | /* -*- C++ -*- |
---|
[1435] | 2 | * lemon/vector_map.h - Part of LEMON, a generic C++ optimization library |
---|
[906] | 3 | * |
---|
[1164] | 4 | * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
[1359] | 5 | * (Egervary Research Group 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_VECTOR_MAP_H |
---|
| 18 | #define LEMON_VECTOR_MAP_H |
---|
[822] | 19 | |
---|
| 20 | #include <vector> |
---|
[946] | 21 | #include <algorithm> |
---|
[822] | 22 | |
---|
[1267] | 23 | #include <lemon/utility.h> |
---|
[1307] | 24 | #include <lemon/bits/map_iterator.h> |
---|
| 25 | #include <lemon/bits/alteration_notifier.h> |
---|
[1669] | 26 | #include <lemon/concept_check.h> |
---|
| 27 | #include <lemon/concept/maps.h> |
---|
[822] | 28 | |
---|
[1669] | 29 | /// \ingroup graphmapfactory |
---|
| 30 | /// |
---|
[822] | 31 | ///\file |
---|
| 32 | ///\brief Vector based graph maps. |
---|
| 33 | |
---|
[921] | 34 | namespace lemon { |
---|
[1669] | 35 | |
---|
| 36 | /// \ingroup graphmapfactory |
---|
| 37 | /// |
---|
| 38 | /// \brief Graph map based on the std::vector storage. |
---|
| 39 | /// |
---|
[946] | 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 | /// |
---|
[1039] | 46 | /// \param Registry The AlterationNotifier that will notify this map. |
---|
[1703] | 47 | /// \param Item The item type of the graph items. |
---|
[946] | 48 | /// \param Value The value type of the map. |
---|
| 49 | /// |
---|
| 50 | /// \author Balazs Dezso |
---|
| 51 | |
---|
[1267] | 52 | template < |
---|
| 53 | typename _Graph, |
---|
| 54 | typename _Item, |
---|
| 55 | typename _Value |
---|
| 56 | > |
---|
[1039] | 57 | class VectorMap : public AlterationNotifier<_Item>::ObserverBase { |
---|
[1719] | 58 | private: |
---|
| 59 | |
---|
| 60 | /// The container type of the map. |
---|
| 61 | typedef std::vector<_Value> Container; |
---|
| 62 | |
---|
[822] | 63 | public: |
---|
[1703] | 64 | |
---|
[946] | 65 | /// The graph type of the map. |
---|
| 66 | typedef _Graph Graph; |
---|
[1719] | 67 | /// The reference map tag. |
---|
| 68 | typedef True ReferenceMapTag; |
---|
| 69 | |
---|
[946] | 70 | /// The key type of the map. |
---|
[987] | 71 | typedef _Item Key; |
---|
[946] | 72 | /// The value type of the map. |
---|
| 73 | typedef _Value Value; |
---|
[1719] | 74 | /// The const reference type of the map. |
---|
| 75 | typedef typename Container::const_reference ConstReference; |
---|
| 76 | /// The reference type of the map. |
---|
| 77 | typedef typename Container::reference Reference; |
---|
| 78 | |
---|
| 79 | typedef const Value ConstValue; |
---|
| 80 | typedef Value* Pointer; |
---|
| 81 | typedef const Value* ConstPointer; |
---|
| 82 | |
---|
| 83 | typedef AlterationNotifier<_Item> Registry; |
---|
[822] | 84 | |
---|
| 85 | /// The map type. |
---|
| 86 | typedef VectorMap Map; |
---|
[946] | 87 | /// The base class of the map. |
---|
| 88 | typedef typename Registry::ObserverBase Parent; |
---|
[822] | 89 | |
---|
| 90 | /// The reference type of the map; |
---|
[987] | 91 | typedef typename Container::reference Reference; |
---|
[822] | 92 | /// The pointer type of the map; |
---|
[987] | 93 | typedef typename Container::pointer Pointer; |
---|
[822] | 94 | |
---|
| 95 | /// The const value type of the map. |
---|
[987] | 96 | typedef const Value ConstValue; |
---|
[822] | 97 | /// The const reference type of the map; |
---|
[987] | 98 | typedef typename Container::const_reference ConstReference; |
---|
[822] | 99 | /// The pointer type of the map; |
---|
[987] | 100 | typedef typename Container::const_pointer ConstPointer; |
---|
[822] | 101 | |
---|
[1267] | 102 | typedef True FullTypeTag; |
---|
| 103 | |
---|
[1703] | 104 | /// \brief Constructor to attach the new map into the registry. |
---|
| 105 | /// |
---|
| 106 | /// It constructs a map and attachs it into the registry. |
---|
[946] | 107 | /// It adds all the items of the graph to the map. |
---|
[980] | 108 | VectorMap(const Graph& _g) : graph(&_g) { |
---|
[1039] | 109 | attach(_g.getNotifier(_Item())); |
---|
[946] | 110 | build(); |
---|
| 111 | } |
---|
[822] | 112 | |
---|
[1703] | 113 | /// \brief Constructor uses given value to initialize the map. |
---|
| 114 | /// |
---|
| 115 | /// It constructs a map uses a given value to initialize the map. |
---|
[946] | 116 | /// It adds all the items of the graph to the map. |
---|
[980] | 117 | VectorMap(const Graph& _g, const Value& _v) : graph(&_g) { |
---|
[1039] | 118 | attach(_g.getNotifier(_Item())); |
---|
[980] | 119 | container.resize(graph->maxId(_Item()) + 1, _v); |
---|
[946] | 120 | } |
---|
[822] | 121 | |
---|
[1703] | 122 | /// \brief Copy constructor |
---|
| 123 | /// |
---|
| 124 | /// Copy constructor. |
---|
[1374] | 125 | VectorMap(const VectorMap& _copy) |
---|
| 126 | : Parent(), graph(_copy.getGraph()) { |
---|
[980] | 127 | if (_copy.attached()) { |
---|
| 128 | attach(*_copy.getRegistry()); |
---|
| 129 | container = _copy.container; |
---|
[822] | 130 | } |
---|
| 131 | } |
---|
| 132 | |
---|
[1703] | 133 | /// \brief Destrcutor |
---|
| 134 | /// |
---|
| 135 | /// Destructor. |
---|
[946] | 136 | virtual ~VectorMap() { |
---|
| 137 | if (attached()) { |
---|
| 138 | detach(); |
---|
[822] | 139 | } |
---|
[946] | 140 | } |
---|
| 141 | |
---|
[1669] | 142 | |
---|
| 143 | private: |
---|
| 144 | |
---|
| 145 | VectorMap& operator=(const VectorMap&); |
---|
| 146 | |
---|
| 147 | protected: |
---|
| 148 | |
---|
| 149 | using Parent::attach; |
---|
| 150 | using Parent::detach; |
---|
| 151 | using Parent::attached; |
---|
| 152 | |
---|
[946] | 153 | const Graph* getGraph() const { |
---|
| 154 | return graph; |
---|
[822] | 155 | } |
---|
[937] | 156 | |
---|
[1669] | 157 | public: |
---|
| 158 | |
---|
[1703] | 159 | /// \brief The subcript operator. |
---|
| 160 | /// |
---|
[946] | 161 | /// The subscript operator. The map can be subscripted by the |
---|
[1703] | 162 | /// actual items of the graph. |
---|
[987] | 163 | Reference operator[](const Key& key) { |
---|
[980] | 164 | return container[graph->id(key)]; |
---|
[822] | 165 | } |
---|
| 166 | |
---|
[1703] | 167 | /// \brief The const subcript operator. |
---|
| 168 | /// |
---|
[946] | 169 | /// The const subscript operator. The map can be subscripted by the |
---|
| 170 | /// actual items of the graph. |
---|
[987] | 171 | ConstReference operator[](const Key& key) const { |
---|
[980] | 172 | return container[graph->id(key)]; |
---|
[822] | 173 | } |
---|
| 174 | |
---|
[937] | 175 | |
---|
[1703] | 176 | /// \brief The setter function of the map. |
---|
| 177 | /// |
---|
[946] | 178 | /// It the same as operator[](key) = value expression. |
---|
[987] | 179 | void set(const Key& key, const Value& value) { |
---|
[946] | 180 | (*this)[key] = value; |
---|
[822] | 181 | } |
---|
[946] | 182 | |
---|
[1669] | 183 | protected: |
---|
| 184 | |
---|
| 185 | /// \brief Adds a new key to the map. |
---|
| 186 | /// |
---|
[946] | 187 | /// It adds a new key to the map. It called by the observer registry |
---|
[1703] | 188 | /// and it overrides the add() member function of the observer base. |
---|
| 189 | virtual void add(const Key& key) { |
---|
[980] | 190 | int id = graph->id(key); |
---|
[822] | 191 | if (id >= (int)container.size()) { |
---|
| 192 | container.resize(id + 1); |
---|
| 193 | } |
---|
| 194 | } |
---|
[937] | 195 | |
---|
[1703] | 196 | /// \brief Erase a key from the map. |
---|
| 197 | /// |
---|
[946] | 198 | /// Erase a key from the map. It called by the observer registry |
---|
| 199 | /// and it overrides the erase() member function of the observer base. |
---|
[1703] | 200 | virtual void erase(const Key&) {} |
---|
[822] | 201 | |
---|
[1703] | 202 | /// \brief Buildes the map. |
---|
| 203 | /// |
---|
[946] | 204 | /// It buildes the map. It called by the observer registry |
---|
| 205 | /// and it overrides the build() member function of the observer base. |
---|
[1703] | 206 | virtual void build() { |
---|
[980] | 207 | container.resize(graph->maxId(_Item()) + 1); |
---|
[946] | 208 | } |
---|
[937] | 209 | |
---|
[1703] | 210 | /// \brief Clear the map. |
---|
| 211 | /// |
---|
[946] | 212 | /// It erase all items from the map. It called by the observer registry |
---|
| 213 | /// and it overrides the clear() member function of the observer base. |
---|
[1703] | 214 | virtual void clear() { |
---|
[822] | 215 | container.clear(); |
---|
| 216 | } |
---|
[1267] | 217 | |
---|
[822] | 218 | private: |
---|
| 219 | |
---|
| 220 | Container container; |
---|
[946] | 221 | const Graph *graph; |
---|
[822] | 222 | |
---|
[946] | 223 | }; |
---|
| 224 | |
---|
[822] | 225 | } |
---|
| 226 | |
---|
| 227 | #endif |
---|