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