author | deba |
Fri, 24 Feb 2006 11:13:09 +0000 | |
changeset 1984 | d4cbd10e1256 |
parent 1956 | a055123339d5 |
child 1989 | d276e88aa48a |
permissions | -rw-r--r-- |
klao@946 | 1 |
/* -*- C++ -*- |
klao@946 | 2 |
* |
alpar@1956 | 3 |
* This file is a part of LEMON, a generic C++ optimization library |
alpar@1956 | 4 |
* |
alpar@1956 | 5 |
* Copyright (C) 2003-2006 |
alpar@1956 | 6 |
* Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
alpar@1956 | 7 |
* (Egervary Research Group on Combinatorial Optimization, EGRES). |
klao@946 | 8 |
* |
klao@946 | 9 |
* Permission to use, modify and distribute this software is granted |
klao@946 | 10 |
* provided that this copyright notice appears in all copies. For |
klao@946 | 11 |
* precise terms see the accompanying LICENSE file. |
klao@946 | 12 |
* |
klao@946 | 13 |
* This software is provided "AS IS" with no warranty of any kind, |
klao@946 | 14 |
* express or implied, and with no claim as to its suitability for any |
klao@946 | 15 |
* purpose. |
klao@946 | 16 |
* |
klao@946 | 17 |
*/ |
klao@946 | 18 |
|
klao@946 | 19 |
#ifndef LEMON_ALTERATION_OBSERVER_REGISTRY_H |
klao@946 | 20 |
#define LEMON_ALTERATION_OBSERVER_REGISTRY_H |
klao@946 | 21 |
|
klao@946 | 22 |
#include <vector> |
klao@946 | 23 |
#include <algorithm> |
klao@946 | 24 |
|
alpar@1946 | 25 |
///\ingroup graphmapfactory |
klao@946 | 26 |
///\file |
klao@946 | 27 |
///\brief Observer registry for graph alteration observers. |
klao@946 | 28 |
|
klao@946 | 29 |
namespace lemon { |
klao@946 | 30 |
|
deba@1910 | 31 |
/// \addtogroin graphmapfactory |
klao@946 | 32 |
/// @{ |
klao@946 | 33 |
|
deba@1414 | 34 |
/// \brief Registry class to register objects observes alterations in |
deba@1414 | 35 |
/// the graph. |
deba@1414 | 36 |
/// |
klao@946 | 37 |
/// This class is a registry for the objects which observe the |
klao@946 | 38 |
/// alterations in a container. The alteration observers can be attached |
klao@946 | 39 |
/// to and detached from the registry. The observers have to inherit |
deba@1038 | 40 |
/// from the \ref AlterationNotifier::ObserverBase and override |
klao@946 | 41 |
/// the virtual functions in that. |
klao@946 | 42 |
/// |
klao@946 | 43 |
/// The most important application of the alteration observing is the |
deba@1414 | 44 |
/// dynamic map implementation. |
klao@946 | 45 |
/// |
klao@946 | 46 |
/// \param _Item The item type what the observers are observing, usually |
klao@946 | 47 |
/// edge or node. |
klao@946 | 48 |
/// |
klao@946 | 49 |
/// \author Balazs Dezso |
klao@946 | 50 |
|
klao@946 | 51 |
template <typename _Item> |
deba@1038 | 52 |
class AlterationNotifier { |
klao@946 | 53 |
public: |
klao@946 | 54 |
typedef _Item Item; |
klao@946 | 55 |
|
klao@946 | 56 |
/// ObserverBase is the base class for the observers. |
klao@946 | 57 |
|
klao@946 | 58 |
/// ObserverBase is the abstract base class for the observers. |
klao@946 | 59 |
/// It will be notified about an item was inserted into or |
klao@946 | 60 |
/// erased from the graph. |
klao@946 | 61 |
/// |
klao@946 | 62 |
/// The observer interface contains some pure virtual functions |
klao@946 | 63 |
/// to override. The add() and erase() functions are |
klao@946 | 64 |
/// to notify the oberver when one item is added or |
klao@946 | 65 |
/// erased. |
klao@946 | 66 |
/// |
klao@946 | 67 |
/// The build() and clear() members are to notify the observer |
alpar@1204 | 68 |
/// about the container is built from an empty container or |
klao@946 | 69 |
/// is cleared to an empty container. |
klao@946 | 70 |
/// |
klao@946 | 71 |
/// \author Balazs Dezso |
klao@946 | 72 |
|
klao@946 | 73 |
class ObserverBase { |
klao@946 | 74 |
protected: |
deba@1038 | 75 |
typedef AlterationNotifier Registry; |
klao@946 | 76 |
|
deba@1038 | 77 |
friend class AlterationNotifier; |
klao@946 | 78 |
|
deba@1414 | 79 |
/// \brief Default constructor. |
deba@1414 | 80 |
/// |
klao@946 | 81 |
/// Default constructor for ObserverBase. |
klao@946 | 82 |
/// |
klao@946 | 83 |
ObserverBase() : registry(0) {} |
klao@946 | 84 |
|
deba@1685 | 85 |
ObserverBase(const ObserverBase& copy) { |
deba@1685 | 86 |
if (copy.attached()) { |
deba@1685 | 87 |
copy.getRegistry()->attach(*this); |
deba@1685 | 88 |
} |
deba@1685 | 89 |
} |
deba@1685 | 90 |
|
klao@946 | 91 |
virtual ~ObserverBase() {} |
klao@946 | 92 |
|
deba@1414 | 93 |
/// \brief Attaches the observer into an AlterationNotifier. |
deba@1414 | 94 |
/// |
deba@1038 | 95 |
/// This member attaches the observer into an AlterationNotifier. |
klao@946 | 96 |
/// |
deba@1038 | 97 |
void attach(AlterationNotifier& r) { |
klao@946 | 98 |
registry = &r; |
klao@946 | 99 |
registry->attach(*this); |
klao@946 | 100 |
} |
klao@946 | 101 |
|
deba@1414 | 102 |
/// \brief Detaches the observer into an AlterationNotifier. |
deba@1414 | 103 |
/// |
deba@1038 | 104 |
/// This member detaches the observer from an AlterationNotifier. |
klao@946 | 105 |
/// |
klao@946 | 106 |
void detach() { |
klao@946 | 107 |
if (registry) { |
klao@946 | 108 |
registry->detach(*this); |
klao@946 | 109 |
} |
klao@946 | 110 |
} |
klao@946 | 111 |
|
klao@946 | 112 |
|
klao@946 | 113 |
/// Gives back a pointer to the registry what the map attached into. |
klao@946 | 114 |
|
klao@946 | 115 |
/// This function gives back a pointer to the registry what the map |
klao@946 | 116 |
/// attached into. |
klao@946 | 117 |
/// |
klao@946 | 118 |
Registry* getRegistry() const { return const_cast<Registry*>(registry); } |
klao@946 | 119 |
|
klao@946 | 120 |
/// Gives back true when the observer is attached into a registry. |
klao@946 | 121 |
bool attached() const { return registry != 0; } |
deba@1685 | 122 |
|
klao@946 | 123 |
private: |
klao@946 | 124 |
|
klao@946 | 125 |
ObserverBase& operator=(const ObserverBase& copy); |
klao@946 | 126 |
|
klao@946 | 127 |
protected: |
klao@946 | 128 |
|
klao@946 | 129 |
Registry* registry; |
klao@946 | 130 |
int registry_index; |
klao@946 | 131 |
|
klao@946 | 132 |
/// \brief The member function to notificate the observer about an |
klao@946 | 133 |
/// item is added to the container. |
klao@946 | 134 |
/// |
klao@946 | 135 |
/// The add() member function notificates the observer about an item |
klao@946 | 136 |
/// is added to the container. It have to be overrided in the |
klao@946 | 137 |
/// subclasses. |
klao@946 | 138 |
|
deba@1414 | 139 |
virtual void add(const Item&) = 0; |
klao@946 | 140 |
|
deba@1414 | 141 |
/// \brief The member function to notificate the observer about |
deba@1718 | 142 |
/// more item is added to the container. |
deba@1414 | 143 |
/// |
deba@1718 | 144 |
/// The add() member function notificates the observer about more item |
deba@1414 | 145 |
/// is added to the container. It have to be overrided in the |
deba@1414 | 146 |
/// subclasses. |
deba@1414 | 147 |
|
deba@1414 | 148 |
virtual void add(const std::vector<Item>& items) { |
deba@1414 | 149 |
for (int i = 0; i < (int)items.size(); ++i) { |
deba@1414 | 150 |
add(items[i]); |
deba@1414 | 151 |
} |
deba@1414 | 152 |
} |
klao@946 | 153 |
|
klao@946 | 154 |
/// \brief The member function to notificate the observer about an |
klao@946 | 155 |
/// item is erased from the container. |
klao@946 | 156 |
/// |
klao@946 | 157 |
/// The erase() member function notificates the observer about an |
klao@946 | 158 |
/// item is erased from the container. It have to be overrided in |
klao@946 | 159 |
/// the subclasses. |
klao@946 | 160 |
|
klao@946 | 161 |
virtual void erase(const Item&) = 0; |
klao@946 | 162 |
|
deba@1718 | 163 |
/// \brief The member function to notificate the observer about |
deba@1718 | 164 |
/// more item is erased from the container. |
deba@1718 | 165 |
/// |
deba@1718 | 166 |
/// The erase() member function notificates the observer about more item |
deba@1718 | 167 |
/// is erased from the container. It have to be overrided in the |
deba@1718 | 168 |
/// subclasses. |
deba@1414 | 169 |
virtual void erase(const std::vector<Item>& items) { |
deba@1414 | 170 |
for (int i = 0; i < (int)items.size(); ++i) { |
deba@1701 | 171 |
erase(items[i]); |
deba@1414 | 172 |
} |
deba@1414 | 173 |
} |
deba@1414 | 174 |
|
klao@946 | 175 |
/// \brief The member function to notificate the observer about the |
alpar@1204 | 176 |
/// container is built. |
klao@946 | 177 |
/// |
klao@946 | 178 |
/// The build() member function notificates the observer about the |
alpar@1204 | 179 |
/// container is built from an empty container. It have to be |
klao@946 | 180 |
/// overrided in the subclasses. |
klao@946 | 181 |
|
klao@946 | 182 |
virtual void build() = 0; |
klao@946 | 183 |
|
klao@946 | 184 |
/// \brief The member function to notificate the observer about all |
klao@946 | 185 |
/// items are erased from the container. |
klao@946 | 186 |
/// |
klao@946 | 187 |
/// The clear() member function notificates the observer about all |
klao@946 | 188 |
/// items are erased from the container. It have to be overrided in |
klao@946 | 189 |
/// the subclasses. |
klao@946 | 190 |
|
klao@946 | 191 |
virtual void clear() = 0; |
klao@946 | 192 |
|
klao@946 | 193 |
}; |
klao@946 | 194 |
|
klao@946 | 195 |
protected: |
klao@946 | 196 |
|
klao@946 | 197 |
|
klao@946 | 198 |
typedef std::vector<ObserverBase*> Container; |
klao@946 | 199 |
|
klao@946 | 200 |
Container container; |
klao@946 | 201 |
|
klao@946 | 202 |
|
klao@946 | 203 |
public: |
klao@946 | 204 |
|
klao@946 | 205 |
/// Default constructor. |
klao@946 | 206 |
|
klao@946 | 207 |
/// |
deba@1038 | 208 |
/// The default constructor of the AlterationNotifier. |
klao@946 | 209 |
/// It creates an empty registry. |
deba@1038 | 210 |
AlterationNotifier() {} |
klao@946 | 211 |
|
deba@1038 | 212 |
/// Copy Constructor of the AlterationNotifier. |
klao@946 | 213 |
|
deba@1038 | 214 |
/// Copy constructor of the AlterationNotifier. |
klao@946 | 215 |
/// It creates only an empty registry because the copiable |
klao@946 | 216 |
/// registry's observers have to be registered still into that registry. |
deba@1039 | 217 |
AlterationNotifier(const AlterationNotifier&) {} |
klao@946 | 218 |
|
klao@946 | 219 |
/// Assign operator. |
klao@946 | 220 |
|
deba@1038 | 221 |
/// Assign operator for the AlterationNotifier. |
deba@1040 | 222 |
/// It makes the notifier only empty because the copiable |
deba@1040 | 223 |
/// notifier's observers have to be registered still into that registry. |
deba@1039 | 224 |
AlterationNotifier& operator=(const AlterationNotifier&) { |
klao@946 | 225 |
typename Container::iterator it; |
klao@946 | 226 |
for (it = container.begin(); it != container.end(); ++it) { |
klao@946 | 227 |
(*it)->registry = 0; |
klao@946 | 228 |
} |
klao@946 | 229 |
} |
klao@946 | 230 |
|
klao@946 | 231 |
/// Destructor. |
klao@946 | 232 |
|
deba@1038 | 233 |
/// Destructor of the AlterationNotifier. |
klao@946 | 234 |
/// |
deba@1038 | 235 |
~AlterationNotifier() { |
klao@946 | 236 |
typename Container::iterator it; |
klao@946 | 237 |
for (it = container.begin(); it != container.end(); ++it) { |
klao@946 | 238 |
(*it)->registry = 0; |
klao@946 | 239 |
} |
klao@946 | 240 |
} |
klao@946 | 241 |
|
klao@946 | 242 |
|
klao@946 | 243 |
protected: |
klao@946 | 244 |
|
klao@946 | 245 |
void attach(ObserverBase& observer) { |
klao@946 | 246 |
container.push_back(&observer); |
klao@946 | 247 |
observer.registry = this; |
klao@946 | 248 |
observer.registry_index = container.size()-1; |
klao@946 | 249 |
} |
klao@946 | 250 |
|
klao@946 | 251 |
void detach(ObserverBase& base) { |
klao@946 | 252 |
container.back()->registry_index = base.registry_index; |
klao@946 | 253 |
container[base.registry_index] = container.back(); |
klao@946 | 254 |
container.pop_back(); |
klao@946 | 255 |
base.registry = 0; |
klao@946 | 256 |
} |
klao@946 | 257 |
|
klao@946 | 258 |
public: |
klao@946 | 259 |
|
deba@1414 | 260 |
/// \brief Notifies all the registered observers about an Item added to |
deba@1414 | 261 |
/// the container. |
deba@1414 | 262 |
/// |
deba@1414 | 263 |
/// It notifies all the registered observers about an Item added to |
deba@1414 | 264 |
/// the container. |
klao@946 | 265 |
/// |
deba@1414 | 266 |
void add(const Item& item) { |
klao@946 | 267 |
typename Container::iterator it; |
deba@1979 | 268 |
try { |
deba@1979 | 269 |
for (it = container.begin(); it != container.end(); ++it) { |
deba@1979 | 270 |
(*it)->add(item); |
deba@1979 | 271 |
} |
deba@1979 | 272 |
} catch (...) { |
deba@1979 | 273 |
typename Container::iterator jt; |
deba@1979 | 274 |
for (jt = container.begin(); jt != it; ++it) { |
deba@1979 | 275 |
(*it)->erase(item); |
deba@1979 | 276 |
} |
deba@1979 | 277 |
throw; |
klao@946 | 278 |
} |
klao@946 | 279 |
} |
klao@946 | 280 |
|
deba@1414 | 281 |
/// \brief Notifies all the registered observers about more Item added to |
deba@1414 | 282 |
/// the container. |
deba@1414 | 283 |
/// |
deba@1414 | 284 |
/// It notifies all the registered observers about more Item added to |
deba@1414 | 285 |
/// the container. |
deba@1414 | 286 |
/// |
deba@1414 | 287 |
void add(const std::vector<Item>& items) { |
deba@1414 | 288 |
typename Container::iterator it; |
deba@1979 | 289 |
try { |
deba@1979 | 290 |
for (it = container.begin(); it != container.end(); ++it) { |
deba@1979 | 291 |
(*it)->add(items); |
deba@1979 | 292 |
} |
deba@1979 | 293 |
} catch (...) { |
deba@1979 | 294 |
typename Container::iterator jt; |
deba@1979 | 295 |
for (jt = container.begin(); jt != it; ++it) { |
deba@1979 | 296 |
(*it)->erase(items); |
deba@1979 | 297 |
} |
deba@1979 | 298 |
throw; |
deba@1414 | 299 |
} |
deba@1414 | 300 |
} |
deba@1414 | 301 |
|
deba@1414 | 302 |
/// \brief Notifies all the registered observers about an Item erased from |
deba@1414 | 303 |
/// the container. |
deba@1414 | 304 |
/// |
deba@1414 | 305 |
/// It notifies all the registered observers about an Item erased from |
deba@1414 | 306 |
/// the container. |
klao@946 | 307 |
/// |
klao@946 | 308 |
void erase(const Item& key) { |
klao@946 | 309 |
typename Container::iterator it; |
klao@946 | 310 |
for (it = container.begin(); it != container.end(); ++it) { |
klao@946 | 311 |
(*it)->erase(key); |
klao@946 | 312 |
} |
klao@946 | 313 |
} |
deba@1414 | 314 |
|
deba@1414 | 315 |
/// \brief Notifies all the registered observers about more Item erased |
deba@1414 | 316 |
/// from the container. |
deba@1414 | 317 |
/// |
deba@1414 | 318 |
/// It notifies all the registered observers about more Item erased from |
deba@1414 | 319 |
/// the container. |
deba@1414 | 320 |
/// |
deba@1414 | 321 |
void erase(const std::vector<Item>& items) { |
deba@1414 | 322 |
typename Container::iterator it; |
deba@1414 | 323 |
for (it = container.begin(); it != container.end(); ++it) { |
deba@1414 | 324 |
(*it)->erase(items); |
deba@1414 | 325 |
} |
deba@1414 | 326 |
} |
klao@946 | 327 |
|
deba@1414 | 328 |
/// \brief Notifies all the registered observers about the container is |
deba@1414 | 329 |
/// built. |
deba@1414 | 330 |
/// |
alpar@1204 | 331 |
/// Notifies all the registered observers about the container is built |
klao@946 | 332 |
/// from an empty container. |
klao@946 | 333 |
void build() { |
klao@946 | 334 |
typename Container::iterator it; |
deba@1979 | 335 |
try { |
deba@1979 | 336 |
for (it = container.begin(); it != container.end(); ++it) { |
deba@1979 | 337 |
(*it)->build(); |
deba@1979 | 338 |
} |
deba@1979 | 339 |
} catch (...) { |
deba@1979 | 340 |
typename Container::iterator jt; |
deba@1979 | 341 |
for (jt = container.begin(); jt != it; ++it) { |
deba@1979 | 342 |
(*it)->clear(); |
deba@1979 | 343 |
} |
deba@1979 | 344 |
throw; |
klao@946 | 345 |
} |
klao@946 | 346 |
} |
klao@946 | 347 |
|
klao@946 | 348 |
|
deba@1414 | 349 |
/// \brief Notifies all the registered observers about all Items are |
deba@1414 | 350 |
/// erased. |
deba@1414 | 351 |
/// |
klao@946 | 352 |
/// Notifies all the registered observers about all Items are erased |
klao@946 | 353 |
/// from the container. |
klao@946 | 354 |
void clear() { |
klao@946 | 355 |
typename Container::iterator it; |
klao@946 | 356 |
for (it = container.begin(); it != container.end(); ++it) { |
klao@946 | 357 |
(*it)->clear(); |
klao@946 | 358 |
} |
klao@946 | 359 |
} |
klao@946 | 360 |
}; |
klao@946 | 361 |
|
klao@946 | 362 |
|
klao@946 | 363 |
/// @} |
klao@946 | 364 |
|
klao@946 | 365 |
|
klao@946 | 366 |
} |
klao@946 | 367 |
|
klao@946 | 368 |
#endif |