lemon/list_graph.h
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 02 Sep 2008 22:27:19 +0200
changeset 256 c760d691fe3c
parent 238 79643f6e8c52
parent 235 b46d2787e9c2
child 280 e7f8647ce760
permissions -rw-r--r--
Bug fix + doc improvement in UndirDigraphExtender (ticket #141)
alpar@209
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@39
     2
 *
alpar@209
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@39
     4
 *
alpar@39
     5
 * Copyright (C) 2003-2008
alpar@39
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@39
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@39
     8
 *
alpar@39
     9
 * Permission to use, modify and distribute this software is granted
alpar@39
    10
 * provided that this copyright notice appears in all copies. For
alpar@39
    11
 * precise terms see the accompanying LICENSE file.
alpar@39
    12
 *
alpar@39
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@39
    14
 * express or implied, and with no claim as to its suitability for any
alpar@39
    15
 * purpose.
alpar@39
    16
 *
alpar@39
    17
 */
alpar@39
    18
deba@57
    19
#ifndef LEMON_LIST_GRAPH_H
deba@57
    20
#define LEMON_LIST_GRAPH_H
deba@57
    21
deba@57
    22
///\ingroup graphs
deba@57
    23
///\file
deba@57
    24
///\brief ListDigraph, ListGraph classes.
deba@57
    25
deba@220
    26
#include <lemon/core.h>
deba@220
    27
#include <lemon/error.h>
deba@57
    28
#include <lemon/bits/graph_extender.h>
deba@57
    29
deba@57
    30
#include <vector>
deba@57
    31
#include <list>
deba@57
    32
deba@57
    33
namespace lemon {
deba@57
    34
deba@57
    35
  class ListDigraphBase {
deba@57
    36
deba@57
    37
  protected:
deba@57
    38
    struct NodeT {
deba@57
    39
      int first_in, first_out;
deba@57
    40
      int prev, next;
deba@57
    41
    };
alpar@209
    42
deba@57
    43
    struct ArcT {
deba@57
    44
      int target, source;
deba@57
    45
      int prev_in, prev_out;
deba@57
    46
      int next_in, next_out;
deba@57
    47
    };
deba@57
    48
deba@57
    49
    std::vector<NodeT> nodes;
deba@57
    50
deba@57
    51
    int first_node;
deba@57
    52
deba@57
    53
    int first_free_node;
deba@57
    54
deba@57
    55
    std::vector<ArcT> arcs;
deba@57
    56
deba@57
    57
    int first_free_arc;
alpar@209
    58
deba@57
    59
  public:
alpar@209
    60
deba@57
    61
    typedef ListDigraphBase Digraph;
alpar@209
    62
deba@57
    63
    class Node {
deba@57
    64
      friend class ListDigraphBase;
deba@57
    65
    protected:
deba@57
    66
deba@57
    67
      int id;
deba@57
    68
      explicit Node(int pid) { id = pid;}
deba@57
    69
deba@57
    70
    public:
deba@57
    71
      Node() {}
deba@57
    72
      Node (Invalid) { id = -1; }
deba@57
    73
      bool operator==(const Node& node) const {return id == node.id;}
deba@57
    74
      bool operator!=(const Node& node) const {return id != node.id;}
deba@57
    75
      bool operator<(const Node& node) const {return id < node.id;}
deba@57
    76
    };
deba@57
    77
deba@57
    78
    class Arc {
deba@57
    79
      friend class ListDigraphBase;
deba@57
    80
    protected:
deba@57
    81
deba@57
    82
      int id;
deba@57
    83
      explicit Arc(int pid) { id = pid;}
deba@57
    84
deba@57
    85
    public:
deba@57
    86
      Arc() {}
deba@57
    87
      Arc (Invalid) { id = -1; }
deba@57
    88
      bool operator==(const Arc& arc) const {return id == arc.id;}
deba@57
    89
      bool operator!=(const Arc& arc) const {return id != arc.id;}
deba@57
    90
      bool operator<(const Arc& arc) const {return id < arc.id;}
deba@57
    91
    };
deba@57
    92
deba@57
    93
deba@57
    94
deba@57
    95
    ListDigraphBase()
deba@57
    96
      : nodes(), first_node(-1),
alpar@209
    97
        first_free_node(-1), arcs(), first_free_arc(-1) {}
deba@57
    98
alpar@209
    99
alpar@209
   100
    int maxNodeId() const { return nodes.size()-1; }
deba@57
   101
    int maxArcId() const { return arcs.size()-1; }
deba@57
   102
deba@57
   103
    Node source(Arc e) const { return Node(arcs[e.id].source); }
deba@57
   104
    Node target(Arc e) const { return Node(arcs[e.id].target); }
deba@57
   105
deba@57
   106
alpar@209
   107
    void first(Node& node) const {
deba@57
   108
      node.id = first_node;
deba@57
   109
    }
deba@57
   110
deba@57
   111
    void next(Node& node) const {
deba@57
   112
      node.id = nodes[node.id].next;
deba@57
   113
    }
deba@57
   114
deba@57
   115
alpar@209
   116
    void first(Arc& arc) const {
deba@57
   117
      int n;
alpar@209
   118
      for(n = first_node;
alpar@209
   119
          n!=-1 && nodes[n].first_in == -1;
alpar@209
   120
          n = nodes[n].next) {}
kpeter@73
   121
      arc.id = (n == -1) ? -1 : nodes[n].first_in;
deba@57
   122
    }
deba@57
   123
deba@57
   124
    void next(Arc& arc) const {
deba@57
   125
      if (arcs[arc.id].next_in != -1) {
alpar@209
   126
        arc.id = arcs[arc.id].next_in;
deba@57
   127
      } else {
alpar@209
   128
        int n;
alpar@209
   129
        for(n = nodes[arcs[arc.id].target].next;
alpar@209
   130
            n!=-1 && nodes[n].first_in == -1;
alpar@209
   131
            n = nodes[n].next) {}
alpar@209
   132
        arc.id = (n == -1) ? -1 : nodes[n].first_in;
alpar@209
   133
      }
deba@57
   134
    }
deba@57
   135
deba@57
   136
    void firstOut(Arc &e, const Node& v) const {
deba@57
   137
      e.id = nodes[v.id].first_out;
deba@57
   138
    }
deba@57
   139
    void nextOut(Arc &e) const {
deba@57
   140
      e.id=arcs[e.id].next_out;
deba@57
   141
    }
deba@57
   142
deba@57
   143
    void firstIn(Arc &e, const Node& v) const {
deba@57
   144
      e.id = nodes[v.id].first_in;
deba@57
   145
    }
deba@57
   146
    void nextIn(Arc &e) const {
deba@57
   147
      e.id=arcs[e.id].next_in;
deba@57
   148
    }
deba@57
   149
alpar@209
   150
deba@57
   151
    static int id(Node v) { return v.id; }
deba@57
   152
    static int id(Arc e) { return e.id; }
deba@57
   153
deba@57
   154
    static Node nodeFromId(int id) { return Node(id);}
deba@57
   155
    static Arc arcFromId(int id) { return Arc(id);}
deba@57
   156
alpar@209
   157
    bool valid(Node n) const {
alpar@209
   158
      return n.id >= 0 && n.id < static_cast<int>(nodes.size()) &&
alpar@209
   159
        nodes[n.id].prev != -2;
deba@149
   160
    }
deba@149
   161
alpar@209
   162
    bool valid(Arc a) const {
alpar@209
   163
      return a.id >= 0 && a.id < static_cast<int>(arcs.size()) &&
alpar@209
   164
        arcs[a.id].prev_in != -2;
deba@149
   165
    }
deba@149
   166
alpar@209
   167
    Node addNode() {
deba@57
   168
      int n;
alpar@209
   169
deba@57
   170
      if(first_free_node==-1) {
alpar@209
   171
        n = nodes.size();
alpar@209
   172
        nodes.push_back(NodeT());
deba@57
   173
      } else {
alpar@209
   174
        n = first_free_node;
alpar@209
   175
        first_free_node = nodes[n].next;
deba@57
   176
      }
alpar@209
   177
deba@57
   178
      nodes[n].next = first_node;
deba@57
   179
      if(first_node != -1) nodes[first_node].prev = n;
deba@57
   180
      first_node = n;
deba@57
   181
      nodes[n].prev = -1;
alpar@209
   182
deba@57
   183
      nodes[n].first_in = nodes[n].first_out = -1;
alpar@209
   184
deba@57
   185
      return Node(n);
deba@57
   186
    }
alpar@209
   187
deba@57
   188
    Arc addArc(Node u, Node v) {
alpar@209
   189
      int n;
deba@57
   190
deba@57
   191
      if (first_free_arc == -1) {
alpar@209
   192
        n = arcs.size();
alpar@209
   193
        arcs.push_back(ArcT());
deba@57
   194
      } else {
alpar@209
   195
        n = first_free_arc;
alpar@209
   196
        first_free_arc = arcs[n].next_in;
deba@57
   197
      }
alpar@209
   198
alpar@209
   199
      arcs[n].source = u.id;
deba@57
   200
      arcs[n].target = v.id;
deba@57
   201
deba@57
   202
      arcs[n].next_out = nodes[u.id].first_out;
deba@57
   203
      if(nodes[u.id].first_out != -1) {
alpar@209
   204
        arcs[nodes[u.id].first_out].prev_out = n;
deba@57
   205
      }
alpar@209
   206
deba@57
   207
      arcs[n].next_in = nodes[v.id].first_in;
deba@57
   208
      if(nodes[v.id].first_in != -1) {
alpar@209
   209
        arcs[nodes[v.id].first_in].prev_in = n;
deba@57
   210
      }
alpar@209
   211
deba@57
   212
      arcs[n].prev_in = arcs[n].prev_out = -1;
alpar@209
   213
deba@57
   214
      nodes[u.id].first_out = nodes[v.id].first_in = n;
deba@57
   215
deba@57
   216
      return Arc(n);
deba@57
   217
    }
alpar@209
   218
deba@57
   219
    void erase(const Node& node) {
deba@57
   220
      int n = node.id;
alpar@209
   221
deba@57
   222
      if(nodes[n].next != -1) {
alpar@209
   223
        nodes[nodes[n].next].prev = nodes[n].prev;
deba@57
   224
      }
alpar@209
   225
deba@57
   226
      if(nodes[n].prev != -1) {
alpar@209
   227
        nodes[nodes[n].prev].next = nodes[n].next;
deba@57
   228
      } else {
alpar@209
   229
        first_node = nodes[n].next;
deba@57
   230
      }
alpar@209
   231
deba@57
   232
      nodes[n].next = first_free_node;
deba@57
   233
      first_free_node = n;
deba@149
   234
      nodes[n].prev = -2;
deba@57
   235
deba@57
   236
    }
alpar@209
   237
deba@57
   238
    void erase(const Arc& arc) {
deba@57
   239
      int n = arc.id;
alpar@209
   240
deba@57
   241
      if(arcs[n].next_in!=-1) {
alpar@209
   242
        arcs[arcs[n].next_in].prev_in = arcs[n].prev_in;
deba@57
   243
      }
deba@57
   244
deba@57
   245
      if(arcs[n].prev_in!=-1) {
alpar@209
   246
        arcs[arcs[n].prev_in].next_in = arcs[n].next_in;
deba@57
   247
      } else {
alpar@209
   248
        nodes[arcs[n].target].first_in = arcs[n].next_in;
deba@57
   249
      }
deba@57
   250
alpar@209
   251
deba@57
   252
      if(arcs[n].next_out!=-1) {
alpar@209
   253
        arcs[arcs[n].next_out].prev_out = arcs[n].prev_out;
alpar@209
   254
      }
deba@57
   255
deba@57
   256
      if(arcs[n].prev_out!=-1) {
alpar@209
   257
        arcs[arcs[n].prev_out].next_out = arcs[n].next_out;
deba@57
   258
      } else {
alpar@209
   259
        nodes[arcs[n].source].first_out = arcs[n].next_out;
deba@57
   260
      }
alpar@209
   261
deba@57
   262
      arcs[n].next_in = first_free_arc;
deba@149
   263
      first_free_arc = n;
deba@149
   264
      arcs[n].prev_in = -2;
deba@57
   265
    }
deba@57
   266
deba@57
   267
    void clear() {
deba@57
   268
      arcs.clear();
deba@57
   269
      nodes.clear();
deba@57
   270
      first_node = first_free_node = first_free_arc = -1;
deba@57
   271
    }
deba@57
   272
deba@57
   273
  protected:
alpar@209
   274
    void changeTarget(Arc e, Node n)
deba@57
   275
    {
deba@57
   276
      if(arcs[e.id].next_in != -1)
alpar@209
   277
        arcs[arcs[e.id].next_in].prev_in = arcs[e.id].prev_in;
deba@57
   278
      if(arcs[e.id].prev_in != -1)
alpar@209
   279
        arcs[arcs[e.id].prev_in].next_in = arcs[e.id].next_in;
deba@57
   280
      else nodes[arcs[e.id].target].first_in = arcs[e.id].next_in;
deba@57
   281
      if (nodes[n.id].first_in != -1) {
alpar@209
   282
        arcs[nodes[n.id].first_in].prev_in = e.id;
deba@57
   283
      }
deba@57
   284
      arcs[e.id].target = n.id;
deba@57
   285
      arcs[e.id].prev_in = -1;
deba@57
   286
      arcs[e.id].next_in = nodes[n.id].first_in;
deba@57
   287
      nodes[n.id].first_in = e.id;
deba@57
   288
    }
alpar@209
   289
    void changeSource(Arc e, Node n)
deba@57
   290
    {
deba@57
   291
      if(arcs[e.id].next_out != -1)
alpar@209
   292
        arcs[arcs[e.id].next_out].prev_out = arcs[e.id].prev_out;
deba@57
   293
      if(arcs[e.id].prev_out != -1)
alpar@209
   294
        arcs[arcs[e.id].prev_out].next_out = arcs[e.id].next_out;
deba@57
   295
      else nodes[arcs[e.id].source].first_out = arcs[e.id].next_out;
deba@57
   296
      if (nodes[n.id].first_out != -1) {
alpar@209
   297
        arcs[nodes[n.id].first_out].prev_out = e.id;
deba@57
   298
      }
deba@57
   299
      arcs[e.id].source = n.id;
deba@57
   300
      arcs[e.id].prev_out = -1;
deba@57
   301
      arcs[e.id].next_out = nodes[n.id].first_out;
deba@57
   302
      nodes[n.id].first_out = e.id;
deba@57
   303
    }
deba@57
   304
deba@57
   305
  };
deba@57
   306
deba@57
   307
  typedef DigraphExtender<ListDigraphBase> ExtendedListDigraphBase;
deba@57
   308
kpeter@73
   309
  /// \addtogroup graphs
deba@57
   310
  /// @{
deba@57
   311
alpar@209
   312
  ///A general directed graph structure.
deba@57
   313
alpar@209
   314
  ///\ref ListDigraph is a simple and fast <em>directed graph</em>
alpar@209
   315
  ///implementation based on static linked lists that are stored in
alpar@209
   316
  ///\c std::vector structures.
deba@57
   317
  ///
deba@57
   318
  ///It conforms to the \ref concepts::Digraph "Digraph concept" and it
kpeter@73
   319
  ///also provides several useful additional functionalities.
kpeter@73
   320
  ///Most of the member functions and nested classes are documented
kpeter@73
   321
  ///only in the concept class.
deba@57
   322
  ///
deba@57
   323
  ///An important extra feature of this digraph implementation is that
deba@57
   324
  ///its maps are real \ref concepts::ReferenceMap "reference map"s.
deba@57
   325
  ///
kpeter@73
   326
  ///\sa concepts::Digraph
deba@57
   327
deba@57
   328
  class ListDigraph : public ExtendedListDigraphBase {
deba@57
   329
  private:
kpeter@73
   330
    ///ListDigraph is \e not copy constructible. Use copyDigraph() instead.
alpar@209
   331
kpeter@73
   332
    ///ListDigraph is \e not copy constructible. Use copyDigraph() instead.
deba@57
   333
    ///
deba@57
   334
    ListDigraph(const ListDigraph &) :ExtendedListDigraphBase() {};
deba@57
   335
    ///\brief Assignment of ListDigraph to another one is \e not allowed.
kpeter@73
   336
    ///Use copyDigraph() instead.
deba@57
   337
deba@57
   338
    ///Assignment of ListDigraph to another one is \e not allowed.
kpeter@73
   339
    ///Use copyDigraph() instead.
deba@57
   340
    void operator=(const ListDigraph &) {}
deba@57
   341
  public:
deba@57
   342
deba@57
   343
    typedef ExtendedListDigraphBase Parent;
deba@57
   344
deba@57
   345
    /// Constructor
alpar@209
   346
deba@57
   347
    /// Constructor.
deba@57
   348
    ///
deba@57
   349
    ListDigraph() {}
deba@57
   350
deba@57
   351
    ///Add a new node to the digraph.
alpar@209
   352
kpeter@73
   353
    ///Add a new node to the digraph.
kpeter@73
   354
    ///\return the new node.
deba@57
   355
    Node addNode() { return Parent::addNode(); }
deba@57
   356
deba@57
   357
    ///Add a new arc to the digraph.
alpar@209
   358
deba@57
   359
    ///Add a new arc to the digraph with source node \c s
deba@57
   360
    ///and target node \c t.
deba@57
   361
    ///\return the new arc.
alpar@209
   362
    Arc addArc(const Node& s, const Node& t) {
alpar@209
   363
      return Parent::addArc(s, t);
deba@57
   364
    }
deba@57
   365
deba@234
   366
    ///\brief Erase a node from the digraph.
deba@234
   367
    ///
deba@234
   368
    ///Erase a node from the digraph.
deba@234
   369
    ///
deba@234
   370
    void erase(const Node& n) { Parent::erase(n); }
deba@234
   371
deba@234
   372
    ///\brief Erase an arc from the digraph.
deba@234
   373
    ///
deba@234
   374
    ///Erase an arc from the digraph.
deba@234
   375
    ///
deba@234
   376
    void erase(const Arc& a) { Parent::erase(a); }
deba@234
   377
deba@149
   378
    /// Node validity check
deba@149
   379
deba@149
   380
    /// This function gives back true if the given node is valid,
alpar@209
   381
    /// ie. it is a real node of the graph.
deba@149
   382
    ///
deba@149
   383
    /// \warning A Node pointing to a removed item
deba@149
   384
    /// could become valid again later if new nodes are
deba@149
   385
    /// added to the graph.
deba@149
   386
    bool valid(Node n) const { return Parent::valid(n); }
deba@149
   387
deba@149
   388
    /// Arc validity check
deba@149
   389
deba@149
   390
    /// This function gives back true if the given arc is valid,
alpar@209
   391
    /// ie. it is a real arc of the graph.
deba@149
   392
    ///
deba@149
   393
    /// \warning An Arc pointing to a removed item
deba@149
   394
    /// could become valid again later if new nodes are
deba@149
   395
    /// added to the graph.
deba@149
   396
    bool valid(Arc a) const { return Parent::valid(a); }
deba@149
   397
deba@235
   398
    /// Change the target of \c a to \c n
deba@57
   399
deba@235
   400
    /// Change the target of \c a to \c n
deba@57
   401
    ///
deba@57
   402
    ///\note The <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s referencing
deba@57
   403
    ///the changed arc remain valid. However <tt>InArcIt</tt>s are
deba@57
   404
    ///invalidated.
kpeter@73
   405
    ///
deba@57
   406
    ///\warning This functionality cannot be used together with the Snapshot
deba@57
   407
    ///feature.
deba@235
   408
    void changeTarget(Arc a, Node n) {
deba@235
   409
      Parent::changeTarget(a,n);
deba@57
   410
    }
deba@235
   411
    /// Change the source of \c a to \c n
deba@57
   412
deba@235
   413
    /// Change the source of \c a to \c n
deba@57
   414
    ///
deba@235
   415
    ///\note The <tt>InArcIt</tt>s referencing the changed arc remain
deba@235
   416
    ///valid. However the <tt>ArcIt<tt>s and <tt>OutArcIt</tt>s are
deba@57
   417
    ///invalidated.
kpeter@73
   418
    ///
deba@57
   419
    ///\warning This functionality cannot be used together with the Snapshot
deba@57
   420
    ///feature.
deba@235
   421
    void changeSource(Arc a, Node n) {
deba@235
   422
      Parent::changeSource(a,n);
deba@57
   423
    }
deba@57
   424
deba@57
   425
    /// Invert the direction of an arc.
deba@57
   426
deba@57
   427
    ///\note The <tt>ArcIt</tt>s referencing the changed arc remain
deba@57
   428
    ///valid. However <tt>OutArcIt</tt>s and <tt>InArcIt</tt>s are
deba@57
   429
    ///invalidated.
kpeter@73
   430
    ///
deba@57
   431
    ///\warning This functionality cannot be used together with the Snapshot
deba@57
   432
    ///feature.
deba@57
   433
    void reverseArc(Arc e) {
deba@57
   434
      Node t=target(e);
deba@57
   435
      changeTarget(e,source(e));
deba@57
   436
      changeSource(e,t);
deba@57
   437
    }
deba@57
   438
kpeter@73
   439
    /// Reserve memory for nodes.
kpeter@73
   440
kpeter@73
   441
    /// Using this function it is possible to avoid the superfluous memory
deba@57
   442
    /// allocation: if you know that the digraph you want to build will
deba@57
   443
    /// be very large (e.g. it will contain millions of nodes and/or arcs)
deba@57
   444
    /// then it is worth reserving space for this amount before starting
deba@57
   445
    /// to build the digraph.
deba@57
   446
    /// \sa reserveArc
deba@57
   447
    void reserveNode(int n) { nodes.reserve(n); };
deba@57
   448
kpeter@73
   449
    /// Reserve memory for arcs.
deba@57
   450
kpeter@73
   451
    /// Using this function it is possible to avoid the superfluous memory
deba@57
   452
    /// allocation: if you know that the digraph you want to build will
deba@57
   453
    /// be very large (e.g. it will contain millions of nodes and/or arcs)
deba@57
   454
    /// then it is worth reserving space for this amount before starting
deba@57
   455
    /// to build the digraph.
deba@57
   456
    /// \sa reserveNode
deba@57
   457
    void reserveArc(int m) { arcs.reserve(m); };
deba@57
   458
deba@57
   459
    ///Contract two nodes.
deba@57
   460
deba@57
   461
    ///This function contracts two nodes.
deba@57
   462
    ///Node \p b will be removed but instead of deleting
deba@57
   463
    ///incident arcs, they will be joined to \p a.
deba@57
   464
    ///The last parameter \p r controls whether to remove loops. \c true
deba@57
   465
    ///means that loops will be removed.
deba@57
   466
    ///
kpeter@73
   467
    ///\note The <tt>ArcIt</tt>s referencing a moved arc remain
deba@57
   468
    ///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s
deba@57
   469
    ///may be invalidated.
kpeter@73
   470
    ///
deba@57
   471
    ///\warning This functionality cannot be used together with the Snapshot
deba@57
   472
    ///feature.
alpar@209
   473
    void contract(Node a, Node b, bool r = true)
deba@57
   474
    {
deba@57
   475
      for(OutArcIt e(*this,b);e!=INVALID;) {
alpar@209
   476
        OutArcIt f=e;
alpar@209
   477
        ++f;
alpar@209
   478
        if(r && target(e)==a) erase(e);
alpar@209
   479
        else changeSource(e,a);
alpar@209
   480
        e=f;
deba@57
   481
      }
deba@57
   482
      for(InArcIt e(*this,b);e!=INVALID;) {
alpar@209
   483
        InArcIt f=e;
alpar@209
   484
        ++f;
alpar@209
   485
        if(r && source(e)==a) erase(e);
alpar@209
   486
        else changeTarget(e,a);
alpar@209
   487
        e=f;
deba@57
   488
      }
deba@57
   489
      erase(b);
deba@57
   490
    }
deba@57
   491
deba@57
   492
    ///Split a node.
deba@57
   493
deba@57
   494
    ///This function splits a node. First a new node is added to the digraph,
deba@57
   495
    ///then the source of each outgoing arc of \c n is moved to this new node.
deba@57
   496
    ///If \c connect is \c true (this is the default value), then a new arc
deba@57
   497
    ///from \c n to the newly created node is also added.
deba@57
   498
    ///\return The newly created node.
deba@57
   499
    ///
deba@57
   500
    ///\note The <tt>ArcIt</tt>s referencing a moved arc remain
deba@57
   501
    ///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s may
alpar@209
   502
    ///be invalidated.
deba@57
   503
    ///
deba@57
   504
    ///\warning This functionality cannot be used together with the
kpeter@73
   505
    ///Snapshot feature.
kpeter@73
   506
    ///
kpeter@73
   507
    ///\todo It could be implemented in a bit faster way.
deba@57
   508
    Node split(Node n, bool connect = true) {
deba@57
   509
      Node b = addNode();
deba@57
   510
      for(OutArcIt e(*this,n);e!=INVALID;) {
kpeter@212
   511
        OutArcIt f=e;
alpar@209
   512
        ++f;
alpar@209
   513
        changeSource(e,b);
alpar@209
   514
        e=f;
deba@57
   515
      }
deba@57
   516
      if (connect) addArc(n,b);
deba@57
   517
      return b;
deba@57
   518
    }
alpar@209
   519
deba@57
   520
    ///Split an arc.
deba@57
   521
deba@57
   522
    ///This function splits an arc. First a new node \c b is added to
deba@57
   523
    ///the digraph, then the original arc is re-targeted to \c
deba@57
   524
    ///b. Finally an arc from \c b to the original target is added.
kpeter@73
   525
    ///
kpeter@73
   526
    ///\return The newly created node.
kpeter@73
   527
    ///
kpeter@73
   528
    ///\warning This functionality cannot be used together with the
kpeter@73
   529
    ///Snapshot feature.
deba@57
   530
    Node split(Arc e) {
deba@57
   531
      Node b = addNode();
deba@57
   532
      addArc(b,target(e));
deba@57
   533
      changeTarget(e,b);
deba@57
   534
      return b;
deba@57
   535
    }
alpar@209
   536
deba@57
   537
    /// \brief Class to make a snapshot of the digraph and restore
kpeter@73
   538
    /// it later.
deba@57
   539
    ///
kpeter@73
   540
    /// Class to make a snapshot of the digraph and restore it later.
deba@57
   541
    ///
deba@57
   542
    /// The newly added nodes and arcs can be removed using the
deba@57
   543
    /// restore() function.
deba@57
   544
    ///
kpeter@73
   545
    /// \warning Arc and node deletions and other modifications (e.g.
alpar@209
   546
    /// contracting, splitting, reversing arcs or nodes) cannot be
alpar@209
   547
    /// restored. These events invalidate the snapshot.
deba@57
   548
    class Snapshot {
deba@57
   549
    protected:
deba@57
   550
deba@57
   551
      typedef Parent::NodeNotifier NodeNotifier;
deba@57
   552
deba@57
   553
      class NodeObserverProxy : public NodeNotifier::ObserverBase {
deba@57
   554
      public:
deba@57
   555
deba@57
   556
        NodeObserverProxy(Snapshot& _snapshot)
deba@57
   557
          : snapshot(_snapshot) {}
deba@57
   558
deba@57
   559
        using NodeNotifier::ObserverBase::attach;
deba@57
   560
        using NodeNotifier::ObserverBase::detach;
deba@57
   561
        using NodeNotifier::ObserverBase::attached;
alpar@209
   562
deba@57
   563
      protected:
alpar@209
   564
deba@57
   565
        virtual void add(const Node& node) {
deba@57
   566
          snapshot.addNode(node);
deba@57
   567
        }
deba@57
   568
        virtual void add(const std::vector<Node>& nodes) {
deba@57
   569
          for (int i = nodes.size() - 1; i >= 0; ++i) {
deba@57
   570
            snapshot.addNode(nodes[i]);
deba@57
   571
          }
deba@57
   572
        }
deba@57
   573
        virtual void erase(const Node& node) {
deba@57
   574
          snapshot.eraseNode(node);
deba@57
   575
        }
deba@57
   576
        virtual void erase(const std::vector<Node>& nodes) {
deba@57
   577
          for (int i = 0; i < int(nodes.size()); ++i) {
deba@57
   578
            snapshot.eraseNode(nodes[i]);
deba@57
   579
          }
deba@57
   580
        }
deba@57
   581
        virtual void build() {
deba@57
   582
          Node node;
deba@57
   583
          std::vector<Node> nodes;
alpar@209
   584
          for (notifier()->first(node); node != INVALID;
deba@57
   585
               notifier()->next(node)) {
deba@57
   586
            nodes.push_back(node);
deba@57
   587
          }
deba@57
   588
          for (int i = nodes.size() - 1; i >= 0; --i) {
deba@57
   589
            snapshot.addNode(nodes[i]);
deba@57
   590
          }
deba@57
   591
        }
deba@57
   592
        virtual void clear() {
deba@57
   593
          Node node;
alpar@209
   594
          for (notifier()->first(node); node != INVALID;
deba@57
   595
               notifier()->next(node)) {
deba@57
   596
            snapshot.eraseNode(node);
deba@57
   597
          }
deba@57
   598
        }
deba@57
   599
deba@57
   600
        Snapshot& snapshot;
deba@57
   601
      };
deba@57
   602
deba@57
   603
      class ArcObserverProxy : public ArcNotifier::ObserverBase {
deba@57
   604
      public:
deba@57
   605
deba@57
   606
        ArcObserverProxy(Snapshot& _snapshot)
deba@57
   607
          : snapshot(_snapshot) {}
deba@57
   608
deba@57
   609
        using ArcNotifier::ObserverBase::attach;
deba@57
   610
        using ArcNotifier::ObserverBase::detach;
deba@57
   611
        using ArcNotifier::ObserverBase::attached;
alpar@209
   612
deba@57
   613
      protected:
deba@57
   614
deba@57
   615
        virtual void add(const Arc& arc) {
deba@57
   616
          snapshot.addArc(arc);
deba@57
   617
        }
deba@57
   618
        virtual void add(const std::vector<Arc>& arcs) {
deba@57
   619
          for (int i = arcs.size() - 1; i >= 0; ++i) {
deba@57
   620
            snapshot.addArc(arcs[i]);
deba@57
   621
          }
deba@57
   622
        }
deba@57
   623
        virtual void erase(const Arc& arc) {
deba@57
   624
          snapshot.eraseArc(arc);
deba@57
   625
        }
deba@57
   626
        virtual void erase(const std::vector<Arc>& arcs) {
deba@57
   627
          for (int i = 0; i < int(arcs.size()); ++i) {
deba@57
   628
            snapshot.eraseArc(arcs[i]);
deba@57
   629
          }
deba@57
   630
        }
deba@57
   631
        virtual void build() {
deba@57
   632
          Arc arc;
deba@57
   633
          std::vector<Arc> arcs;
alpar@209
   634
          for (notifier()->first(arc); arc != INVALID;
deba@57
   635
               notifier()->next(arc)) {
deba@57
   636
            arcs.push_back(arc);
deba@57
   637
          }
deba@57
   638
          for (int i = arcs.size() - 1; i >= 0; --i) {
deba@57
   639
            snapshot.addArc(arcs[i]);
deba@57
   640
          }
deba@57
   641
        }
deba@57
   642
        virtual void clear() {
deba@57
   643
          Arc arc;
alpar@209
   644
          for (notifier()->first(arc); arc != INVALID;
deba@57
   645
               notifier()->next(arc)) {
deba@57
   646
            snapshot.eraseArc(arc);
deba@57
   647
          }
deba@57
   648
        }
deba@57
   649
deba@57
   650
        Snapshot& snapshot;
deba@57
   651
      };
alpar@209
   652
deba@57
   653
      ListDigraph *digraph;
deba@57
   654
deba@57
   655
      NodeObserverProxy node_observer_proxy;
deba@57
   656
      ArcObserverProxy arc_observer_proxy;
deba@57
   657
deba@57
   658
      std::list<Node> added_nodes;
deba@57
   659
      std::list<Arc> added_arcs;
deba@57
   660
deba@57
   661
deba@57
   662
      void addNode(const Node& node) {
alpar@209
   663
        added_nodes.push_front(node);
deba@57
   664
      }
deba@57
   665
      void eraseNode(const Node& node) {
alpar@209
   666
        std::list<Node>::iterator it =
deba@57
   667
          std::find(added_nodes.begin(), added_nodes.end(), node);
deba@57
   668
        if (it == added_nodes.end()) {
deba@57
   669
          clear();
deba@57
   670
          arc_observer_proxy.detach();
deba@57
   671
          throw NodeNotifier::ImmediateDetach();
deba@57
   672
        } else {
deba@57
   673
          added_nodes.erase(it);
deba@57
   674
        }
deba@57
   675
      }
deba@57
   676
deba@57
   677
      void addArc(const Arc& arc) {
alpar@209
   678
        added_arcs.push_front(arc);
deba@57
   679
      }
deba@57
   680
      void eraseArc(const Arc& arc) {
alpar@209
   681
        std::list<Arc>::iterator it =
deba@57
   682
          std::find(added_arcs.begin(), added_arcs.end(), arc);
deba@57
   683
        if (it == added_arcs.end()) {
deba@57
   684
          clear();
alpar@209
   685
          node_observer_proxy.detach();
deba@57
   686
          throw ArcNotifier::ImmediateDetach();
deba@57
   687
        } else {
deba@57
   688
          added_arcs.erase(it);
alpar@209
   689
        }
deba@57
   690
      }
deba@57
   691
deba@57
   692
      void attach(ListDigraph &_digraph) {
alpar@209
   693
        digraph = &_digraph;
alpar@209
   694
        node_observer_proxy.attach(digraph->notifier(Node()));
deba@57
   695
        arc_observer_proxy.attach(digraph->notifier(Arc()));
deba@57
   696
      }
alpar@209
   697
deba@57
   698
      void detach() {
alpar@209
   699
        node_observer_proxy.detach();
alpar@209
   700
        arc_observer_proxy.detach();
deba@57
   701
      }
deba@57
   702
deba@57
   703
      bool attached() const {
deba@57
   704
        return node_observer_proxy.attached();
deba@57
   705
      }
deba@57
   706
deba@57
   707
      void clear() {
deba@57
   708
        added_nodes.clear();
alpar@209
   709
        added_arcs.clear();
deba@57
   710
      }
deba@57
   711
deba@57
   712
    public:
deba@57
   713
deba@57
   714
      /// \brief Default constructor.
deba@57
   715
      ///
deba@57
   716
      /// Default constructor.
deba@57
   717
      /// To actually make a snapshot you must call save().
alpar@209
   718
      Snapshot()
alpar@209
   719
        : digraph(0), node_observer_proxy(*this),
deba@57
   720
          arc_observer_proxy(*this) {}
alpar@209
   721
deba@57
   722
      /// \brief Constructor that immediately makes a snapshot.
alpar@209
   723
      ///
deba@57
   724
      /// This constructor immediately makes a snapshot of the digraph.
deba@57
   725
      /// \param _digraph The digraph we make a snapshot of.
alpar@209
   726
      Snapshot(ListDigraph &_digraph)
alpar@209
   727
        : node_observer_proxy(*this),
deba@57
   728
          arc_observer_proxy(*this) {
alpar@209
   729
        attach(_digraph);
deba@57
   730
      }
alpar@209
   731
deba@57
   732
      /// \brief Make a snapshot.
deba@57
   733
      ///
deba@57
   734
      /// Make a snapshot of the digraph.
deba@57
   735
      ///
deba@57
   736
      /// This function can be called more than once. In case of a repeated
deba@57
   737
      /// call, the previous snapshot gets lost.
deba@57
   738
      /// \param _digraph The digraph we make the snapshot of.
deba@57
   739
      void save(ListDigraph &_digraph) {
deba@57
   740
        if (attached()) {
deba@57
   741
          detach();
deba@57
   742
          clear();
deba@57
   743
        }
deba@57
   744
        attach(_digraph);
deba@57
   745
      }
alpar@209
   746
deba@57
   747
      /// \brief Undo the changes until the last snapshot.
alpar@209
   748
      //
deba@57
   749
      /// Undo the changes until the last snapshot created by save().
deba@57
   750
      void restore() {
alpar@209
   751
        detach();
alpar@209
   752
        for(std::list<Arc>::iterator it = added_arcs.begin();
deba@57
   753
            it != added_arcs.end(); ++it) {
alpar@209
   754
          digraph->erase(*it);
alpar@209
   755
        }
alpar@209
   756
        for(std::list<Node>::iterator it = added_nodes.begin();
deba@57
   757
            it != added_nodes.end(); ++it) {
alpar@209
   758
          digraph->erase(*it);
alpar@209
   759
        }
deba@57
   760
        clear();
deba@57
   761
      }
deba@57
   762
deba@57
   763
      /// \brief Gives back true when the snapshot is valid.
deba@57
   764
      ///
deba@57
   765
      /// Gives back true when the snapshot is valid.
deba@57
   766
      bool valid() const {
deba@57
   767
        return attached();
deba@57
   768
      }
deba@57
   769
    };
alpar@209
   770
deba@57
   771
  };
deba@57
   772
deba@57
   773
  ///@}
deba@57
   774
deba@57
   775
  class ListGraphBase {
deba@57
   776
deba@57
   777
  protected:
deba@57
   778
deba@57
   779
    struct NodeT {
deba@57
   780
      int first_out;
deba@57
   781
      int prev, next;
deba@57
   782
    };
alpar@209
   783
deba@57
   784
    struct ArcT {
deba@57
   785
      int target;
deba@57
   786
      int prev_out, next_out;
deba@57
   787
    };
deba@57
   788
deba@57
   789
    std::vector<NodeT> nodes;
deba@57
   790
deba@57
   791
    int first_node;
deba@57
   792
deba@57
   793
    int first_free_node;
deba@57
   794
deba@57
   795
    std::vector<ArcT> arcs;
deba@57
   796
deba@57
   797
    int first_free_arc;
alpar@209
   798
deba@57
   799
  public:
alpar@209
   800
deba@57
   801
    typedef ListGraphBase Digraph;
deba@57
   802
deba@57
   803
    class Node;
deba@57
   804
    class Arc;
deba@57
   805
    class Edge;
alpar@209
   806
deba@57
   807
    class Node {
deba@57
   808
      friend class ListGraphBase;
deba@57
   809
    protected:
deba@57
   810
deba@57
   811
      int id;
deba@57
   812
      explicit Node(int pid) { id = pid;}
deba@57
   813
deba@57
   814
    public:
deba@57
   815
      Node() {}
deba@57
   816
      Node (Invalid) { id = -1; }
deba@57
   817
      bool operator==(const Node& node) const {return id == node.id;}
deba@57
   818
      bool operator!=(const Node& node) const {return id != node.id;}
deba@57
   819
      bool operator<(const Node& node) const {return id < node.id;}
deba@57
   820
    };
deba@57
   821
deba@57
   822
    class Edge {
deba@57
   823
      friend class ListGraphBase;
deba@57
   824
    protected:
deba@57
   825
deba@57
   826
      int id;
deba@57
   827
      explicit Edge(int pid) { id = pid;}
deba@57
   828
deba@57
   829
    public:
deba@57
   830
      Edge() {}
deba@57
   831
      Edge (Invalid) { id = -1; }
kpeter@73
   832
      bool operator==(const Edge& edge) const {return id == edge.id;}
kpeter@73
   833
      bool operator!=(const Edge& edge) const {return id != edge.id;}
kpeter@73
   834
      bool operator<(const Edge& edge) const {return id < edge.id;}
deba@57
   835
    };
deba@57
   836
deba@57
   837
    class Arc {
deba@57
   838
      friend class ListGraphBase;
deba@57
   839
    protected:
deba@57
   840
deba@57
   841
      int id;
deba@57
   842
      explicit Arc(int pid) { id = pid;}
deba@57
   843
deba@57
   844
    public:
deba@238
   845
      operator Edge() const { 
deba@238
   846
        return id != -1 ? edgeFromId(id / 2) : INVALID; 
deba@238
   847
      }
deba@57
   848
deba@57
   849
      Arc() {}
deba@57
   850
      Arc (Invalid) { id = -1; }
deba@57
   851
      bool operator==(const Arc& arc) const {return id == arc.id;}
deba@57
   852
      bool operator!=(const Arc& arc) const {return id != arc.id;}
deba@57
   853
      bool operator<(const Arc& arc) const {return id < arc.id;}
deba@57
   854
    };
deba@57
   855
deba@57
   856
deba@57
   857
deba@57
   858
    ListGraphBase()
deba@57
   859
      : nodes(), first_node(-1),
alpar@209
   860
        first_free_node(-1), arcs(), first_free_arc(-1) {}
deba@57
   861
alpar@209
   862
alpar@209
   863
    int maxNodeId() const { return nodes.size()-1; }
deba@57
   864
    int maxEdgeId() const { return arcs.size() / 2 - 1; }
deba@57
   865
    int maxArcId() const { return arcs.size()-1; }
deba@57
   866
deba@57
   867
    Node source(Arc e) const { return Node(arcs[e.id ^ 1].target); }
deba@57
   868
    Node target(Arc e) const { return Node(arcs[e.id].target); }
deba@57
   869
deba@57
   870
    Node u(Edge e) const { return Node(arcs[2 * e.id].target); }
deba@57
   871
    Node v(Edge e) const { return Node(arcs[2 * e.id + 1].target); }
deba@57
   872
deba@57
   873
    static bool direction(Arc e) {
deba@57
   874
      return (e.id & 1) == 1;
deba@57
   875
    }
deba@57
   876
deba@57
   877
    static Arc direct(Edge e, bool d) {
deba@57
   878
      return Arc(e.id * 2 + (d ? 1 : 0));
deba@57
   879
    }
deba@57
   880
alpar@209
   881
    void first(Node& node) const {
deba@57
   882
      node.id = first_node;
deba@57
   883
    }
deba@57
   884
deba@57
   885
    void next(Node& node) const {
deba@57
   886
      node.id = nodes[node.id].next;
deba@57
   887
    }
deba@57
   888
alpar@209
   889
    void first(Arc& e) const {
deba@57
   890
      int n = first_node;
deba@57
   891
      while (n != -1 && nodes[n].first_out == -1) {
deba@57
   892
        n = nodes[n].next;
deba@57
   893
      }
deba@57
   894
      e.id = (n == -1) ? -1 : nodes[n].first_out;
deba@57
   895
    }
deba@57
   896
deba@57
   897
    void next(Arc& e) const {
deba@57
   898
      if (arcs[e.id].next_out != -1) {
alpar@209
   899
        e.id = arcs[e.id].next_out;
deba@57
   900
      } else {
alpar@209
   901
        int n = nodes[arcs[e.id ^ 1].target].next;
deba@57
   902
        while(n != -1 && nodes[n].first_out == -1) {
deba@57
   903
          n = nodes[n].next;
deba@57
   904
        }
alpar@209
   905
        e.id = (n == -1) ? -1 : nodes[n].first_out;
alpar@209
   906
      }
deba@57
   907
    }
deba@57
   908
alpar@209
   909
    void first(Edge& e) const {
deba@57
   910
      int n = first_node;
deba@57
   911
      while (n != -1) {
deba@57
   912
        e.id = nodes[n].first_out;
deba@57
   913
        while ((e.id & 1) != 1) {
deba@57
   914
          e.id = arcs[e.id].next_out;
deba@57
   915
        }
deba@57
   916
        if (e.id != -1) {
deba@57
   917
          e.id /= 2;
deba@57
   918
          return;
alpar@209
   919
        }
deba@57
   920
        n = nodes[n].next;
deba@57
   921
      }
deba@57
   922
      e.id = -1;
deba@57
   923
    }
deba@57
   924
deba@57
   925
    void next(Edge& e) const {
deba@57
   926
      int n = arcs[e.id * 2].target;
deba@57
   927
      e.id = arcs[(e.id * 2) | 1].next_out;
deba@57
   928
      while ((e.id & 1) != 1) {
deba@57
   929
        e.id = arcs[e.id].next_out;
deba@57
   930
      }
deba@57
   931
      if (e.id != -1) {
deba@57
   932
        e.id /= 2;
deba@57
   933
        return;
alpar@209
   934
      }
deba@57
   935
      n = nodes[n].next;
deba@57
   936
      while (n != -1) {
deba@57
   937
        e.id = nodes[n].first_out;
deba@57
   938
        while ((e.id & 1) != 1) {
deba@57
   939
          e.id = arcs[e.id].next_out;
deba@57
   940
        }
deba@57
   941
        if (e.id != -1) {
deba@57
   942
          e.id /= 2;
deba@57
   943
          return;
alpar@209
   944
        }
deba@57
   945
        n = nodes[n].next;
deba@57
   946
      }
deba@57
   947
      e.id = -1;
deba@57
   948
    }
deba@57
   949
deba@57
   950
    void firstOut(Arc &e, const Node& v) const {
deba@57
   951
      e.id = nodes[v.id].first_out;
deba@57
   952
    }
deba@57
   953
    void nextOut(Arc &e) const {
deba@57
   954
      e.id = arcs[e.id].next_out;
deba@57
   955
    }
deba@57
   956
deba@57
   957
    void firstIn(Arc &e, const Node& v) const {
deba@57
   958
      e.id = ((nodes[v.id].first_out) ^ 1);
deba@57
   959
      if (e.id == -2) e.id = -1;
deba@57
   960
    }
deba@57
   961
    void nextIn(Arc &e) const {
deba@57
   962
      e.id = ((arcs[e.id ^ 1].next_out) ^ 1);
deba@57
   963
      if (e.id == -2) e.id = -1;
deba@57
   964
    }
deba@57
   965
deba@57
   966
    void firstInc(Edge &e, bool& d, const Node& v) const {
kpeter@73
   967
      int a = nodes[v.id].first_out;
kpeter@73
   968
      if (a != -1 ) {
kpeter@73
   969
        e.id = a / 2;
kpeter@73
   970
        d = ((a & 1) == 1);
deba@57
   971
      } else {
deba@57
   972
        e.id = -1;
deba@57
   973
        d = true;
deba@57
   974
      }
deba@57
   975
    }
deba@57
   976
    void nextInc(Edge &e, bool& d) const {
kpeter@73
   977
      int a = (arcs[(e.id * 2) | (d ? 1 : 0)].next_out);
kpeter@73
   978
      if (a != -1 ) {
kpeter@73
   979
        e.id = a / 2;
kpeter@73
   980
        d = ((a & 1) == 1);
deba@57
   981
      } else {
deba@57
   982
        e.id = -1;
deba@57
   983
        d = true;
deba@57
   984
      }
deba@57
   985
    }
alpar@209
   986
deba@57
   987
    static int id(Node v) { return v.id; }
deba@57
   988
    static int id(Arc e) { return e.id; }
deba@57
   989
    static int id(Edge e) { return e.id; }
deba@57
   990
deba@57
   991
    static Node nodeFromId(int id) { return Node(id);}
deba@57
   992
    static Arc arcFromId(int id) { return Arc(id);}
deba@57
   993
    static Edge edgeFromId(int id) { return Edge(id);}
deba@57
   994
alpar@209
   995
    bool valid(Node n) const {
alpar@209
   996
      return n.id >= 0 && n.id < static_cast<int>(nodes.size()) &&
alpar@209
   997
        nodes[n.id].prev != -2;
deba@149
   998
    }
deba@149
   999
alpar@209
  1000
    bool valid(Arc a) const {
alpar@209
  1001
      return a.id >= 0 && a.id < static_cast<int>(arcs.size()) &&
alpar@209
  1002
        arcs[a.id].prev_out != -2;
deba@149
  1003
    }
deba@149
  1004
alpar@209
  1005
    bool valid(Edge e) const {
alpar@209
  1006
      return e.id >= 0 && 2 * e.id < static_cast<int>(arcs.size()) &&
alpar@209
  1007
        arcs[2 * e.id].prev_out != -2;
deba@149
  1008
    }
deba@149
  1009
alpar@209
  1010
    Node addNode() {
deba@57
  1011
      int n;
alpar@209
  1012
deba@57
  1013
      if(first_free_node==-1) {
alpar@209
  1014
        n = nodes.size();
alpar@209
  1015
        nodes.push_back(NodeT());
deba@57
  1016
      } else {
alpar@209
  1017
        n = first_free_node;
alpar@209
  1018
        first_free_node = nodes[n].next;
deba@57
  1019
      }
alpar@209
  1020
deba@57
  1021
      nodes[n].next = first_node;
deba@57
  1022
      if (first_node != -1) nodes[first_node].prev = n;
deba@57
  1023
      first_node = n;
deba@57
  1024
      nodes[n].prev = -1;
alpar@209
  1025
deba@57
  1026
      nodes[n].first_out = -1;
alpar@209
  1027
deba@57
  1028
      return Node(n);
deba@57
  1029
    }
alpar@209
  1030
deba@57
  1031
    Edge addEdge(Node u, Node v) {
alpar@209
  1032
      int n;
deba@57
  1033
deba@57
  1034
      if (first_free_arc == -1) {
alpar@209
  1035
        n = arcs.size();
alpar@209
  1036
        arcs.push_back(ArcT());
alpar@209
  1037
        arcs.push_back(ArcT());
deba@57
  1038
      } else {
alpar@209
  1039
        n = first_free_arc;
alpar@209
  1040
        first_free_arc = arcs[n].next_out;
deba@57
  1041
      }
alpar@209
  1042
deba@57
  1043
      arcs[n].target = u.id;
deba@57
  1044
      arcs[n | 1].target = v.id;
deba@57
  1045
deba@57
  1046
      arcs[n].next_out = nodes[v.id].first_out;
deba@57
  1047
      if (nodes[v.id].first_out != -1) {
alpar@209
  1048
        arcs[nodes[v.id].first_out].prev_out = n;
alpar@209
  1049
      }
deba@57
  1050
      arcs[n].prev_out = -1;
deba@57
  1051
      nodes[v.id].first_out = n;
alpar@209
  1052
deba@57
  1053
      arcs[n | 1].next_out = nodes[u.id].first_out;
deba@57
  1054
      if (nodes[u.id].first_out != -1) {
alpar@209
  1055
        arcs[nodes[u.id].first_out].prev_out = (n | 1);
deba@57
  1056
      }
alpar@209
  1057
      arcs[n | 1].prev_out = -1;
deba@57
  1058
      nodes[u.id].first_out = (n | 1);
deba@57
  1059
deba@57
  1060
      return Edge(n / 2);
deba@57
  1061
    }
alpar@209
  1062
deba@57
  1063
    void erase(const Node& node) {
deba@57
  1064
      int n = node.id;
alpar@209
  1065
deba@57
  1066
      if(nodes[n].next != -1) {
alpar@209
  1067
        nodes[nodes[n].next].prev = nodes[n].prev;
deba@57
  1068
      }
alpar@209
  1069
deba@57
  1070
      if(nodes[n].prev != -1) {
alpar@209
  1071
        nodes[nodes[n].prev].next = nodes[n].next;
deba@57
  1072
      } else {
alpar@209
  1073
        first_node = nodes[n].next;
deba@57
  1074
      }
alpar@209
  1075
deba@57
  1076
      nodes[n].next = first_free_node;
deba@57
  1077
      first_free_node = n;
deba@149
  1078
      nodes[n].prev = -2;
deba@57
  1079
    }
alpar@209
  1080
kpeter@73
  1081
    void erase(const Edge& edge) {
kpeter@73
  1082
      int n = edge.id * 2;
alpar@209
  1083
deba@57
  1084
      if (arcs[n].next_out != -1) {
alpar@209
  1085
        arcs[arcs[n].next_out].prev_out = arcs[n].prev_out;
alpar@209
  1086
      }
deba@57
  1087
deba@57
  1088
      if (arcs[n].prev_out != -1) {
alpar@209
  1089
        arcs[arcs[n].prev_out].next_out = arcs[n].next_out;
deba@57
  1090
      } else {
alpar@209
  1091
        nodes[arcs[n | 1].target].first_out = arcs[n].next_out;
deba@57
  1092
      }
deba@57
  1093
deba@57
  1094
      if (arcs[n | 1].next_out != -1) {
alpar@209
  1095
        arcs[arcs[n | 1].next_out].prev_out = arcs[n | 1].prev_out;
alpar@209
  1096
      }
deba@57
  1097
deba@57
  1098
      if (arcs[n | 1].prev_out != -1) {
alpar@209
  1099
        arcs[arcs[n | 1].prev_out].next_out = arcs[n | 1].next_out;
deba@57
  1100
      } else {
alpar@209
  1101
        nodes[arcs[n].target].first_out = arcs[n | 1].next_out;
deba@57
  1102
      }
alpar@209
  1103
deba@57
  1104
      arcs[n].next_out = first_free_arc;
alpar@209
  1105
      first_free_arc = n;
deba@149
  1106
      arcs[n].prev_out = -2;
deba@149
  1107
      arcs[n | 1].prev_out = -2;
deba@57
  1108
deba@57
  1109
    }
deba@57
  1110
deba@57
  1111
    void clear() {
deba@57
  1112
      arcs.clear();
deba@57
  1113
      nodes.clear();
deba@57
  1114
      first_node = first_free_node = first_free_arc = -1;
deba@57
  1115
    }
deba@57
  1116
deba@57
  1117
  protected:
deba@57
  1118
deba@235
  1119
    void changeV(Edge e, Node n) {
deba@57
  1120
      if(arcs[2 * e.id].next_out != -1) {
alpar@209
  1121
        arcs[arcs[2 * e.id].next_out].prev_out = arcs[2 * e.id].prev_out;
deba@57
  1122
      }
deba@57
  1123
      if(arcs[2 * e.id].prev_out != -1) {
alpar@209
  1124
        arcs[arcs[2 * e.id].prev_out].next_out =
deba@57
  1125
          arcs[2 * e.id].next_out;
deba@57
  1126
      } else {
alpar@209
  1127
        nodes[arcs[(2 * e.id) | 1].target].first_out =
deba@57
  1128
          arcs[2 * e.id].next_out;
deba@57
  1129
      }
deba@57
  1130
deba@57
  1131
      if (nodes[n.id].first_out != -1) {
alpar@209
  1132
        arcs[nodes[n.id].first_out].prev_out = 2 * e.id;
deba@57
  1133
      }
deba@57
  1134
      arcs[(2 * e.id) | 1].target = n.id;
deba@57
  1135
      arcs[2 * e.id].prev_out = -1;
deba@57
  1136
      arcs[2 * e.id].next_out = nodes[n.id].first_out;
deba@57
  1137
      nodes[n.id].first_out = 2 * e.id;
deba@57
  1138
    }
deba@57
  1139
deba@235
  1140
    void changeU(Edge e, Node n) {
deba@57
  1141
      if(arcs[(2 * e.id) | 1].next_out != -1) {
alpar@209
  1142
        arcs[arcs[(2 * e.id) | 1].next_out].prev_out =
deba@57
  1143
          arcs[(2 * e.id) | 1].prev_out;
deba@57
  1144
      }
deba@57
  1145
      if(arcs[(2 * e.id) | 1].prev_out != -1) {
alpar@209
  1146
        arcs[arcs[(2 * e.id) | 1].prev_out].next_out =
deba@57
  1147
          arcs[(2 * e.id) | 1].next_out;
deba@57
  1148
      } else {
alpar@209
  1149
        nodes[arcs[2 * e.id].target].first_out =
deba@57
  1150
          arcs[(2 * e.id) | 1].next_out;
deba@57
  1151
      }
deba@57
  1152
deba@57
  1153
      if (nodes[n.id].first_out != -1) {
alpar@209
  1154
        arcs[nodes[n.id].first_out].prev_out = ((2 * e.id) | 1);
deba@57
  1155
      }
deba@57
  1156
      arcs[2 * e.id].target = n.id;
deba@57
  1157
      arcs[(2 * e.id) | 1].prev_out = -1;
deba@57
  1158
      arcs[(2 * e.id) | 1].next_out = nodes[n.id].first_out;
deba@57
  1159
      nodes[n.id].first_out = ((2 * e.id) | 1);
deba@57
  1160
    }
deba@57
  1161
deba@57
  1162
  };
deba@57
  1163
deba@57
  1164
  typedef GraphExtender<ListGraphBase> ExtendedListGraphBase;
deba@57
  1165
deba@57
  1166
kpeter@73
  1167
  /// \addtogroup graphs
deba@57
  1168
  /// @{
deba@57
  1169
kpeter@73
  1170
  ///A general undirected graph structure.
deba@57
  1171
alpar@209
  1172
  ///\ref ListGraph is a simple and fast <em>undirected graph</em>
alpar@209
  1173
  ///implementation based on static linked lists that are stored in
alpar@209
  1174
  ///\c std::vector structures.
deba@57
  1175
  ///
kpeter@73
  1176
  ///It conforms to the \ref concepts::Graph "Graph concept" and it
kpeter@73
  1177
  ///also provides several useful additional functionalities.
kpeter@73
  1178
  ///Most of the member functions and nested classes are documented
kpeter@73
  1179
  ///only in the concept class.
kpeter@73
  1180
  ///
kpeter@73
  1181
  ///An important extra feature of this graph implementation is that
deba@57
  1182
  ///its maps are real \ref concepts::ReferenceMap "reference map"s.
deba@57
  1183
  ///
kpeter@73
  1184
  ///\sa concepts::Graph
kpeter@73
  1185
deba@57
  1186
  class ListGraph : public ExtendedListGraphBase {
deba@57
  1187
  private:
kpeter@73
  1188
    ///ListGraph is \e not copy constructible. Use copyGraph() instead.
deba@57
  1189
kpeter@73
  1190
    ///ListGraph is \e not copy constructible. Use copyGraph() instead.
deba@57
  1191
    ///
deba@57
  1192
    ListGraph(const ListGraph &) :ExtendedListGraphBase()  {};
deba@57
  1193
    ///\brief Assignment of ListGraph to another one is \e not allowed.
kpeter@73
  1194
    ///Use copyGraph() instead.
deba@57
  1195
deba@57
  1196
    ///Assignment of ListGraph to another one is \e not allowed.
kpeter@73
  1197
    ///Use copyGraph() instead.
deba@57
  1198
    void operator=(const ListGraph &) {}
deba@57
  1199
  public:
deba@57
  1200
    /// Constructor
alpar@209
  1201
deba@57
  1202
    /// Constructor.
deba@57
  1203
    ///
deba@57
  1204
    ListGraph() {}
deba@57
  1205
deba@57
  1206
    typedef ExtendedListGraphBase Parent;
deba@57
  1207
kpeter@73
  1208
    typedef Parent::OutArcIt IncEdgeIt;
deba@57
  1209
kpeter@73
  1210
    /// \brief Add a new node to the graph.
deba@57
  1211
    ///
kpeter@73
  1212
    /// Add a new node to the graph.
deba@57
  1213
    /// \return the new node.
deba@57
  1214
    Node addNode() { return Parent::addNode(); }
deba@57
  1215
kpeter@73
  1216
    /// \brief Add a new edge to the graph.
deba@57
  1217
    ///
kpeter@73
  1218
    /// Add a new edge to the graph with source node \c s
deba@57
  1219
    /// and target node \c t.
deba@57
  1220
    /// \return the new edge.
alpar@209
  1221
    Edge addEdge(const Node& s, const Node& t) {
alpar@209
  1222
      return Parent::addEdge(s, t);
deba@57
  1223
    }
deba@234
  1224
deba@234
  1225
    /// \brief Erase a node from the graph.
deba@234
  1226
    ///
deba@234
  1227
    /// Erase a node from the graph.
deba@234
  1228
    ///
deba@234
  1229
    void erase(const Node& n) { Parent::erase(n); }
deba@234
  1230
deba@234
  1231
    /// \brief Erase an edge from the graph.
deba@234
  1232
    ///
deba@234
  1233
    /// Erase an edge from the graph.
deba@234
  1234
    ///
deba@234
  1235
    void erase(const Edge& e) { Parent::erase(e); }
deba@149
  1236
    /// Node validity check
deba@149
  1237
deba@149
  1238
    /// This function gives back true if the given node is valid,
alpar@209
  1239
    /// ie. it is a real node of the graph.
deba@149
  1240
    ///
deba@149
  1241
    /// \warning A Node pointing to a removed item
deba@149
  1242
    /// could become valid again later if new nodes are
deba@149
  1243
    /// added to the graph.
deba@149
  1244
    bool valid(Node n) const { return Parent::valid(n); }
deba@149
  1245
    /// Arc validity check
deba@149
  1246
deba@149
  1247
    /// This function gives back true if the given arc is valid,
alpar@209
  1248
    /// ie. it is a real arc of the graph.
deba@149
  1249
    ///
deba@149
  1250
    /// \warning An Arc pointing to a removed item
deba@149
  1251
    /// could become valid again later if new edges are
deba@149
  1252
    /// added to the graph.
deba@149
  1253
    bool valid(Arc a) const { return Parent::valid(a); }
deba@149
  1254
    /// Edge validity check
deba@149
  1255
deba@149
  1256
    /// This function gives back true if the given edge is valid,
alpar@209
  1257
    /// ie. it is a real arc of the graph.
deba@149
  1258
    ///
deba@149
  1259
    /// \warning A Edge pointing to a removed item
deba@149
  1260
    /// could become valid again later if new edges are
deba@149
  1261
    /// added to the graph.
deba@149
  1262
    bool valid(Edge e) const { return Parent::valid(e); }
deba@235
  1263
    /// \brief Change the end \c u of \c e to \c n
deba@57
  1264
    ///
deba@235
  1265
    /// This function changes the end \c u of \c e to node \c n.
deba@57
  1266
    ///
deba@235
  1267
    ///\note The <tt>EdgeIt</tt>s and <tt>ArcIt</tt>s referencing the
deba@235
  1268
    ///changed edge are invalidated and if the changed node is the
deba@235
  1269
    ///base node of an iterator then this iterator is also
deba@235
  1270
    ///invalidated.
kpeter@73
  1271
    ///
kpeter@73
  1272
    ///\warning This functionality cannot be used together with the
kpeter@73
  1273
    ///Snapshot feature.
deba@235
  1274
    void changeU(Edge e, Node n) {
deba@235
  1275
      Parent::changeU(e,n);
alpar@209
  1276
    }
deba@235
  1277
    /// \brief Change the end \c v of \c e to \c n
deba@57
  1278
    ///
deba@235
  1279
    /// This function changes the end \c v of \c e to \c n.
deba@57
  1280
    ///
deba@235
  1281
    ///\note The <tt>EdgeIt</tt>s referencing the changed edge remain
deba@235
  1282
    ///valid, however <tt>ArcIt</tt>s and if the changed node is the
deba@235
  1283
    ///base node of an iterator then this iterator is invalidated.
kpeter@73
  1284
    ///
kpeter@73
  1285
    ///\warning This functionality cannot be used together with the
kpeter@73
  1286
    ///Snapshot feature.
deba@235
  1287
    void changeV(Edge e, Node n) {
deba@235
  1288
      Parent::changeV(e,n);
deba@57
  1289
    }
deba@57
  1290
    /// \brief Contract two nodes.
deba@57
  1291
    ///
deba@57
  1292
    /// This function contracts two nodes.
deba@57
  1293
    /// Node \p b will be removed but instead of deleting
deba@57
  1294
    /// its neighboring arcs, they will be joined to \p a.
deba@57
  1295
    /// The last parameter \p r controls whether to remove loops. \c true
deba@57
  1296
    /// means that loops will be removed.
deba@57
  1297
    ///
deba@57
  1298
    /// \note The <tt>ArcIt</tt>s referencing a moved arc remain
deba@57
  1299
    /// valid.
kpeter@73
  1300
    ///
kpeter@73
  1301
    ///\warning This functionality cannot be used together with the
kpeter@73
  1302
    ///Snapshot feature.
deba@57
  1303
    void contract(Node a, Node b, bool r = true) {
kpeter@73
  1304
      for(IncEdgeIt e(*this, b); e!=INVALID;) {
alpar@209
  1305
        IncEdgeIt f = e; ++f;
alpar@209
  1306
        if (r && runningNode(e) == a) {
alpar@209
  1307
          erase(e);
deba@235
  1308
        } else if (u(e) == b) {
deba@235
  1309
          changeU(e, a);
alpar@209
  1310
        } else {
deba@235
  1311
          changeV(e, a);
alpar@209
  1312
        }
alpar@209
  1313
        e = f;
deba@57
  1314
      }
deba@57
  1315
      erase(b);
deba@57
  1316
    }
deba@57
  1317
deba@57
  1318
kpeter@73
  1319
    /// \brief Class to make a snapshot of the graph and restore
kpeter@73
  1320
    /// it later.
deba@57
  1321
    ///
kpeter@73
  1322
    /// Class to make a snapshot of the graph and restore it later.
deba@57
  1323
    ///
deba@57
  1324
    /// The newly added nodes and edges can be removed
deba@57
  1325
    /// using the restore() function.
deba@57
  1326
    ///
kpeter@73
  1327
    /// \warning Edge and node deletions and other modifications
alpar@209
  1328
    /// (e.g. changing nodes of edges, contracting nodes) cannot be
kpeter@73
  1329
    /// restored. These events invalidate the snapshot.
deba@57
  1330
    class Snapshot {
deba@57
  1331
    protected:
deba@57
  1332
deba@57
  1333
      typedef Parent::NodeNotifier NodeNotifier;
deba@57
  1334
deba@57
  1335
      class NodeObserverProxy : public NodeNotifier::ObserverBase {
deba@57
  1336
      public:
deba@57
  1337
deba@57
  1338
        NodeObserverProxy(Snapshot& _snapshot)
deba@57
  1339
          : snapshot(_snapshot) {}
deba@57
  1340
deba@57
  1341
        using NodeNotifier::ObserverBase::attach;
deba@57
  1342
        using NodeNotifier::ObserverBase::detach;
deba@57
  1343
        using NodeNotifier::ObserverBase::attached;
alpar@209
  1344
deba@57
  1345
      protected:
alpar@209
  1346
deba@57
  1347
        virtual void add(const Node& node) {
deba@57
  1348
          snapshot.addNode(node);
deba@57
  1349
        }
deba@57
  1350
        virtual void add(const std::vector<Node>& nodes) {
deba@57
  1351
          for (int i = nodes.size() - 1; i >= 0; ++i) {
deba@57
  1352
            snapshot.addNode(nodes[i]);
deba@57
  1353
          }
deba@57
  1354
        }
deba@57
  1355
        virtual void erase(const Node& node) {
deba@57
  1356
          snapshot.eraseNode(node);
deba@57
  1357
        }
deba@57
  1358
        virtual void erase(const std::vector<Node>& nodes) {
deba@57
  1359
          for (int i = 0; i < int(nodes.size()); ++i) {
deba@57
  1360
            snapshot.eraseNode(nodes[i]);
deba@57
  1361
          }
deba@57
  1362
        }
deba@57
  1363
        virtual void build() {
deba@57
  1364
          Node node;
deba@57
  1365
          std::vector<Node> nodes;
alpar@209
  1366
          for (notifier()->first(node); node != INVALID;
deba@57
  1367
               notifier()->next(node)) {
deba@57
  1368
            nodes.push_back(node);
deba@57
  1369
          }
deba@57
  1370
          for (int i = nodes.size() - 1; i >= 0; --i) {
deba@57
  1371
            snapshot.addNode(nodes[i]);
deba@57
  1372
          }
deba@57
  1373
        }
deba@57
  1374
        virtual void clear() {
deba@57
  1375
          Node node;
alpar@209
  1376
          for (notifier()->first(node); node != INVALID;
deba@57
  1377
               notifier()->next(node)) {
deba@57
  1378
            snapshot.eraseNode(node);
deba@57
  1379
          }
deba@57
  1380
        }
deba@57
  1381
deba@57
  1382
        Snapshot& snapshot;
deba@57
  1383
      };
deba@57
  1384
deba@57
  1385
      class EdgeObserverProxy : public EdgeNotifier::ObserverBase {
deba@57
  1386
      public:
deba@57
  1387
deba@57
  1388
        EdgeObserverProxy(Snapshot& _snapshot)
deba@57
  1389
          : snapshot(_snapshot) {}
deba@57
  1390
deba@57
  1391
        using EdgeNotifier::ObserverBase::attach;
deba@57
  1392
        using EdgeNotifier::ObserverBase::detach;
deba@57
  1393
        using EdgeNotifier::ObserverBase::attached;
alpar@209
  1394
deba@57
  1395
      protected:
deba@57
  1396
kpeter@73
  1397
        virtual void add(const Edge& edge) {
kpeter@73
  1398
          snapshot.addEdge(edge);
deba@57
  1399
        }
kpeter@73
  1400
        virtual void add(const std::vector<Edge>& edges) {
kpeter@73
  1401
          for (int i = edges.size() - 1; i >= 0; ++i) {
kpeter@73
  1402
            snapshot.addEdge(edges[i]);
deba@57
  1403
          }
deba@57
  1404
        }
kpeter@73
  1405
        virtual void erase(const Edge& edge) {
kpeter@73
  1406
          snapshot.eraseEdge(edge);
deba@57
  1407
        }
kpeter@73
  1408
        virtual void erase(const std::vector<Edge>& edges) {
kpeter@73
  1409
          for (int i = 0; i < int(edges.size()); ++i) {
kpeter@73
  1410
            snapshot.eraseEdge(edges[i]);
deba@57
  1411
          }
deba@57
  1412
        }
deba@57
  1413
        virtual void build() {
kpeter@73
  1414
          Edge edge;
kpeter@73
  1415
          std::vector<Edge> edges;
alpar@209
  1416
          for (notifier()->first(edge); edge != INVALID;
kpeter@73
  1417
               notifier()->next(edge)) {
kpeter@73
  1418
            edges.push_back(edge);
deba@57
  1419
          }
kpeter@73
  1420
          for (int i = edges.size() - 1; i >= 0; --i) {
kpeter@73
  1421
            snapshot.addEdge(edges[i]);
deba@57
  1422
          }
deba@57
  1423
        }
deba@57
  1424
        virtual void clear() {
kpeter@73
  1425
          Edge edge;
alpar@209
  1426
          for (notifier()->first(edge); edge != INVALID;
kpeter@73
  1427
               notifier()->next(edge)) {
kpeter@73
  1428
            snapshot.eraseEdge(edge);
deba@57
  1429
          }
deba@57
  1430
        }
deba@57
  1431
deba@57
  1432
        Snapshot& snapshot;
deba@57
  1433
      };
kpeter@73
  1434
kpeter@73
  1435
      ListGraph *graph;
deba@57
  1436
deba@57
  1437
      NodeObserverProxy node_observer_proxy;
kpeter@73
  1438
      EdgeObserverProxy edge_observer_proxy;
deba@57
  1439
deba@57
  1440
      std::list<Node> added_nodes;
kpeter@73
  1441
      std::list<Edge> added_edges;
deba@57
  1442
deba@57
  1443
deba@57
  1444
      void addNode(const Node& node) {
alpar@209
  1445
        added_nodes.push_front(node);
deba@57
  1446
      }
deba@57
  1447
      void eraseNode(const Node& node) {
alpar@209
  1448
        std::list<Node>::iterator it =
deba@57
  1449
          std::find(added_nodes.begin(), added_nodes.end(), node);
deba@57
  1450
        if (it == added_nodes.end()) {
deba@57
  1451
          clear();
kpeter@73
  1452
          edge_observer_proxy.detach();
deba@57
  1453
          throw NodeNotifier::ImmediateDetach();
deba@57
  1454
        } else {
deba@57
  1455
          added_nodes.erase(it);
deba@57
  1456
        }
deba@57
  1457
      }
deba@57
  1458
kpeter@73
  1459
      void addEdge(const Edge& edge) {
alpar@209
  1460
        added_edges.push_front(edge);
deba@57
  1461
      }
kpeter@73
  1462
      void eraseEdge(const Edge& edge) {
alpar@209
  1463
        std::list<Edge>::iterator it =
kpeter@73
  1464
          std::find(added_edges.begin(), added_edges.end(), edge);
kpeter@73
  1465
        if (it == added_edges.end()) {
deba@57
  1466
          clear();
deba@57
  1467
          node_observer_proxy.detach();
deba@57
  1468
          throw EdgeNotifier::ImmediateDetach();
deba@57
  1469
        } else {
kpeter@73
  1470
          added_edges.erase(it);
kpeter@73
  1471
        }
deba@57
  1472
      }
deba@57
  1473
kpeter@73
  1474
      void attach(ListGraph &_graph) {
alpar@209
  1475
        graph = &_graph;
alpar@209
  1476
        node_observer_proxy.attach(graph->notifier(Node()));
kpeter@73
  1477
        edge_observer_proxy.attach(graph->notifier(Edge()));
deba@57
  1478
      }
alpar@209
  1479
deba@57
  1480
      void detach() {
alpar@209
  1481
        node_observer_proxy.detach();
alpar@209
  1482
        edge_observer_proxy.detach();
deba@57
  1483
      }
deba@57
  1484
deba@57
  1485
      bool attached() const {
deba@57
  1486
        return node_observer_proxy.attached();
deba@57
  1487
      }
deba@57
  1488
deba@57
  1489
      void clear() {
deba@57
  1490
        added_nodes.clear();
alpar@209
  1491
        added_edges.clear();
deba@57
  1492
      }
deba@57
  1493
deba@57
  1494
    public:
deba@57
  1495
deba@57
  1496
      /// \brief Default constructor.
deba@57
  1497
      ///
deba@57
  1498
      /// Default constructor.
deba@57
  1499
      /// To actually make a snapshot you must call save().
alpar@209
  1500
      Snapshot()
alpar@209
  1501
        : graph(0), node_observer_proxy(*this),
kpeter@73
  1502
          edge_observer_proxy(*this) {}
alpar@209
  1503
deba@57
  1504
      /// \brief Constructor that immediately makes a snapshot.
alpar@209
  1505
      ///
kpeter@73
  1506
      /// This constructor immediately makes a snapshot of the graph.
kpeter@73
  1507
      /// \param _graph The graph we make a snapshot of.
alpar@209
  1508
      Snapshot(ListGraph &_graph)
alpar@209
  1509
        : node_observer_proxy(*this),
kpeter@73
  1510
          edge_observer_proxy(*this) {
alpar@209
  1511
        attach(_graph);
deba@57
  1512
      }
alpar@209
  1513
deba@57
  1514
      /// \brief Make a snapshot.
deba@57
  1515
      ///
kpeter@73
  1516
      /// Make a snapshot of the graph.
deba@57
  1517
      ///
deba@57
  1518
      /// This function can be called more than once. In case of a repeated
deba@57
  1519
      /// call, the previous snapshot gets lost.
kpeter@73
  1520
      /// \param _graph The graph we make the snapshot of.
kpeter@73
  1521
      void save(ListGraph &_graph) {
deba@57
  1522
        if (attached()) {
deba@57
  1523
          detach();
deba@57
  1524
          clear();
deba@57
  1525
        }
kpeter@73
  1526
        attach(_graph);
deba@57
  1527
      }
alpar@209
  1528
deba@57
  1529
      /// \brief Undo the changes until the last snapshot.
alpar@209
  1530
      //
deba@57
  1531
      /// Undo the changes until the last snapshot created by save().
deba@57
  1532
      void restore() {
alpar@209
  1533
        detach();
alpar@209
  1534
        for(std::list<Edge>::iterator it = added_edges.begin();
kpeter@73
  1535
            it != added_edges.end(); ++it) {
alpar@209
  1536
          graph->erase(*it);
alpar@209
  1537
        }
alpar@209
  1538
        for(std::list<Node>::iterator it = added_nodes.begin();
deba@57
  1539
            it != added_nodes.end(); ++it) {
alpar@209
  1540
          graph->erase(*it);
alpar@209
  1541
        }
deba@57
  1542
        clear();
deba@57
  1543
      }
deba@57
  1544
deba@57
  1545
      /// \brief Gives back true when the snapshot is valid.
deba@57
  1546
      ///
deba@57
  1547
      /// Gives back true when the snapshot is valid.
deba@57
  1548
      bool valid() const {
deba@57
  1549
        return attached();
deba@57
  1550
      }
deba@57
  1551
    };
deba@57
  1552
  };
alpar@209
  1553
alpar@209
  1554
  /// @}
deba@57
  1555
} //namespace lemon
alpar@209
  1556
deba@57
  1557
deba@57
  1558
#endif