COIN-OR::LEMON - Graph Library

source: lemon/lemon/bits/vector_map.h @ 263:be8a861d3bb7

Last change on this file since 263:be8a861d3bb7 was 263:be8a861d3bb7, checked in by Peter Kovacs <kpeter@…>, 11 years ago

Make copy constr and op= of the default maps private (ticket #137)

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