lemon/list_graph.h
author deba
Fri, 29 Sep 2006 11:25:27 +0000
changeset 2223 590c1b663a27
parent 2160 abd867cf8a9c
child 2231 06faf3f06d67
permissions -rw-r--r--
Exporting interface to the Graph class
Some documentation improvements
alpar@948
     1
/* -*- C++ -*-
alpar@948
     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@1359
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@948
     8
 *
alpar@948
     9
 * Permission to use, modify and distribute this software is granted
alpar@948
    10
 * provided that this copyright notice appears in all copies. For
alpar@948
    11
 * precise terms see the accompanying LICENSE file.
alpar@948
    12
 *
alpar@948
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@948
    14
 * express or implied, and with no claim as to its suitability for any
alpar@948
    15
 * purpose.
alpar@948
    16
 *
alpar@948
    17
 */
alpar@395
    18
alpar@921
    19
#ifndef LEMON_LIST_GRAPH_H
alpar@921
    20
#define LEMON_LIST_GRAPH_H
alpar@395
    21
alpar@948
    22
///\ingroup graphs
alpar@948
    23
///\file
deba@2116
    24
///\brief ListGraph, ListUGraph classes.
alpar@948
    25
deba@2116
    26
#include <lemon/bits/base_extender.h>
deba@1791
    27
#include <lemon/bits/graph_extender.h>
deba@782
    28
deba@2116
    29
#include <lemon/error.h>
deba@2116
    30
deba@1979
    31
#include <vector>
alpar@1011
    32
#include <list>
deba@782
    33
alpar@921
    34
namespace lemon {
alpar@395
    35
klao@946
    36
  class ListGraphBase {
alpar@406
    37
alpar@949
    38
  protected:
klao@946
    39
    struct NodeT {
deba@1470
    40
      int first_in, first_out;
alpar@397
    41
      int prev, next;
alpar@395
    42
    };
klao@946
    43
 
klao@946
    44
    struct EdgeT {
alpar@986
    45
      int target, source;
alpar@397
    46
      int prev_in, prev_out;
alpar@397
    47
      int next_in, next_out;
alpar@395
    48
    };
alpar@395
    49
alpar@395
    50
    std::vector<NodeT> nodes;
klao@946
    51
alpar@397
    52
    int first_node;
klao@946
    53
alpar@397
    54
    int first_free_node;
klao@946
    55
alpar@395
    56
    std::vector<EdgeT> edges;
klao@946
    57
alpar@397
    58
    int first_free_edge;
alpar@395
    59
    
deba@782
    60
  public:
alpar@395
    61
    
klao@946
    62
    typedef ListGraphBase Graph;
alpar@397
    63
    
klao@946
    64
    class Node {
marci@975
    65
      friend class ListGraphBase;
klao@946
    66
    protected:
alpar@395
    67
klao@946
    68
      int id;
deba@2031
    69
      explicit Node(int pid) { id = pid;}
alpar@395
    70
klao@946
    71
    public:
klao@946
    72
      Node() {}
klao@946
    73
      Node (Invalid) { id = -1; }
klao@946
    74
      bool operator==(const Node& node) const {return id == node.id;}
klao@946
    75
      bool operator!=(const Node& node) const {return id != node.id;}
klao@946
    76
      bool operator<(const Node& node) const {return id < node.id;}
klao@946
    77
    };
deba@782
    78
klao@946
    79
    class Edge {
marci@975
    80
      friend class ListGraphBase;
klao@946
    81
    protected:
deba@782
    82
klao@946
    83
      int id;
deba@2031
    84
      explicit Edge(int pid) { id = pid;}
alpar@395
    85
klao@946
    86
    public:
klao@946
    87
      Edge() {}
klao@946
    88
      Edge (Invalid) { id = -1; }
klao@946
    89
      bool operator==(const Edge& edge) const {return id == edge.id;}
klao@946
    90
      bool operator!=(const Edge& edge) const {return id != edge.id;}
klao@946
    91
      bool operator<(const Edge& edge) const {return id < edge.id;}
klao@946
    92
    };
klao@946
    93
klao@946
    94
klao@946
    95
klao@946
    96
    ListGraphBase()
deba@782
    97
      : nodes(), first_node(-1),
deba@782
    98
	first_free_node(-1), edges(), first_free_edge(-1) {}
deba@782
    99
alpar@395
   100
    
alpar@813
   101
    /// Maximum node ID.
alpar@813
   102
    
alpar@813
   103
    /// Maximum node ID.
alpar@813
   104
    ///\sa id(Node)
deba@1791
   105
    int maxNodeId() const { return nodes.size()-1; } 
klao@946
   106
alpar@813
   107
    /// Maximum edge ID.
alpar@813
   108
    
alpar@813
   109
    /// Maximum edge ID.
alpar@813
   110
    ///\sa id(Edge)
deba@1791
   111
    int maxEdgeId() const { return edges.size()-1; }
alpar@395
   112
deba@2031
   113
    Node source(Edge e) const { return Node(edges[e.id].source); }
deba@2031
   114
    Node target(Edge e) const { return Node(edges[e.id].target); }
alpar@395
   115
alpar@395
   116
klao@946
   117
    void first(Node& node) const { 
klao@946
   118
      node.id = first_node;
klao@946
   119
    }
klao@946
   120
klao@946
   121
    void next(Node& node) const {
klao@946
   122
      node.id = nodes[node.id].next;
klao@946
   123
    }
klao@946
   124
klao@946
   125
klao@946
   126
    void first(Edge& e) const { 
klao@946
   127
      int n;
klao@946
   128
      for(n = first_node; 
klao@946
   129
	  n!=-1 && nodes[n].first_in == -1; 
klao@946
   130
	  n = nodes[n].next);
klao@946
   131
      e.id = (n == -1) ? -1 : nodes[n].first_in;
klao@946
   132
    }
klao@946
   133
klao@946
   134
    void next(Edge& edge) const {
klao@946
   135
      if (edges[edge.id].next_in != -1) {
klao@946
   136
	edge.id = edges[edge.id].next_in;
klao@946
   137
      } else {
klao@946
   138
	int n;
alpar@986
   139
	for(n = nodes[edges[edge.id].target].next;
klao@946
   140
	  n!=-1 && nodes[n].first_in == -1; 
klao@946
   141
	  n = nodes[n].next);
klao@946
   142
	edge.id = (n == -1) ? -1 : nodes[n].first_in;
klao@946
   143
      }      
klao@946
   144
    }
klao@946
   145
klao@946
   146
    void firstOut(Edge &e, const Node& v) const {
klao@946
   147
      e.id = nodes[v.id].first_out;
klao@946
   148
    }
klao@946
   149
    void nextOut(Edge &e) const {
klao@946
   150
      e.id=edges[e.id].next_out;
klao@946
   151
    }
klao@946
   152
klao@946
   153
    void firstIn(Edge &e, const Node& v) const {
klao@946
   154
      e.id = nodes[v.id].first_in;
klao@946
   155
    }
klao@946
   156
    void nextIn(Edge &e) const {
klao@946
   157
      e.id=edges[e.id].next_in;
klao@946
   158
    }
klao@946
   159
alpar@813
   160
    
klao@946
   161
    static int id(Node v) { return v.id; }
klao@946
   162
    static int id(Edge e) { return e.id; }
alpar@395
   163
deba@1791
   164
    static Node nodeFromId(int id) { return Node(id);}
deba@1791
   165
    static Edge edgeFromId(int id) { return Edge(id);}
deba@1106
   166
alpar@397
   167
    /// Adds a new node to the graph.
alpar@397
   168
alpar@2123
   169
    /// Adds a new node to the graph.
alpar@2123
   170
    ///
alpar@813
   171
    /// \warning It adds the new node to the front of the list.
alpar@397
   172
    /// (i.e. the lastly added node becomes the first.)
klao@946
   173
    Node addNode() {     
alpar@397
   174
      int n;
alpar@397
   175
      
klao@946
   176
      if(first_free_node==-1) {
klao@946
   177
	n = nodes.size();
klao@946
   178
	nodes.push_back(NodeT());
klao@946
   179
      } else {
alpar@397
   180
	n = first_free_node;
alpar@397
   181
	first_free_node = nodes[n].next;
alpar@397
   182
      }
alpar@397
   183
      
alpar@397
   184
      nodes[n].next = first_node;
alpar@397
   185
      if(first_node != -1) nodes[first_node].prev = n;
alpar@397
   186
      first_node = n;
alpar@397
   187
      nodes[n].prev = -1;
alpar@397
   188
      
alpar@397
   189
      nodes[n].first_in = nodes[n].first_out = -1;
alpar@397
   190
      
klao@946
   191
      return Node(n);
alpar@395
   192
    }
alpar@395
   193
    
alpar@395
   194
    Edge addEdge(Node u, Node v) {
klao@946
   195
      int n;      
klao@946
   196
klao@946
   197
      if (first_free_edge == -1) {
klao@946
   198
	n = edges.size();
klao@946
   199
	edges.push_back(EdgeT());
klao@946
   200
      } else {
alpar@397
   201
	n = first_free_edge;
alpar@397
   202
	first_free_edge = edges[n].next_in;
alpar@397
   203
      }
alpar@397
   204
      
alpar@986
   205
      edges[n].source = u.id; 
alpar@986
   206
      edges[n].target = v.id;
alpar@395
   207
klao@946
   208
      edges[n].next_out = nodes[u.id].first_out;
klao@946
   209
      if(nodes[u.id].first_out != -1) {
klao@946
   210
	edges[nodes[u.id].first_out].prev_out = n;
klao@946
   211
      }
klao@946
   212
      
klao@946
   213
      edges[n].next_in = nodes[v.id].first_in;
klao@946
   214
      if(nodes[v.id].first_in != -1) {
klao@946
   215
	edges[nodes[v.id].first_in].prev_in = n;
klao@946
   216
      }
klao@946
   217
      
alpar@397
   218
      edges[n].prev_in = edges[n].prev_out = -1;
alpar@397
   219
	
klao@946
   220
      nodes[u.id].first_out = nodes[v.id].first_in = n;
alpar@397
   221
klao@946
   222
      return Edge(n);
alpar@395
   223
    }
alpar@774
   224
    
klao@946
   225
    void erase(const Node& node) {
klao@946
   226
      int n = node.id;
klao@946
   227
      
klao@946
   228
      if(nodes[n].next != -1) {
klao@946
   229
	nodes[nodes[n].next].prev = nodes[n].prev;
klao@946
   230
      }
klao@946
   231
      
klao@946
   232
      if(nodes[n].prev != -1) {
klao@946
   233
	nodes[nodes[n].prev].next = nodes[n].next;
klao@946
   234
      } else {
klao@946
   235
	first_node = nodes[n].next;
klao@946
   236
      }
klao@946
   237
      
klao@946
   238
      nodes[n].next = first_free_node;
klao@946
   239
      first_free_node = n;
alpar@395
   240
alpar@774
   241
    }
alpar@774
   242
    
klao@946
   243
    void erase(const Edge& edge) {
klao@946
   244
      int n = edge.id;
alpar@397
   245
      
klao@946
   246
      if(edges[n].next_in!=-1) {
alpar@397
   247
	edges[edges[n].next_in].prev_in = edges[n].prev_in;
klao@946
   248
      }
klao@946
   249
klao@946
   250
      if(edges[n].prev_in!=-1) {
alpar@397
   251
	edges[edges[n].prev_in].next_in = edges[n].next_in;
klao@946
   252
      } else {
alpar@986
   253
	nodes[edges[n].target].first_in = edges[n].next_in;
klao@946
   254
      }
klao@946
   255
alpar@397
   256
      
klao@946
   257
      if(edges[n].next_out!=-1) {
alpar@397
   258
	edges[edges[n].next_out].prev_out = edges[n].prev_out;
klao@946
   259
      } 
klao@946
   260
klao@946
   261
      if(edges[n].prev_out!=-1) {
alpar@397
   262
	edges[edges[n].prev_out].next_out = edges[n].next_out;
klao@946
   263
      } else {
alpar@986
   264
	nodes[edges[n].source].first_out = edges[n].next_out;
klao@946
   265
      }
alpar@397
   266
      
alpar@397
   267
      edges[n].next_in = first_free_edge;
alpar@695
   268
      first_free_edge = n;      
alpar@397
   269
alpar@397
   270
    }
alpar@397
   271
alpar@397
   272
    void clear() {
deba@782
   273
      edges.clear();
deba@782
   274
      nodes.clear();
klao@946
   275
      first_node = first_free_node = first_free_edge = -1;
deba@937
   276
    }
deba@937
   277
alpar@949
   278
  protected:
deba@2111
   279
    void changeTarget(Edge e, Node n) 
alpar@949
   280
    {
alpar@949
   281
      if(edges[e.id].next_in != -1)
alpar@949
   282
	edges[edges[e.id].next_in].prev_in = edges[e.id].prev_in;
alpar@949
   283
      if(edges[e.id].prev_in != -1)
alpar@949
   284
	edges[edges[e.id].prev_in].next_in = edges[e.id].next_in;
alpar@986
   285
      else nodes[edges[e.id].target].first_in = edges[e.id].next_in;
deba@1702
   286
      if (nodes[n.id].first_in != -1) {
deba@1702
   287
	edges[nodes[n.id].first_in].prev_in = e.id;
deba@1702
   288
      }
alpar@986
   289
      edges[e.id].target = n.id;
alpar@949
   290
      edges[e.id].prev_in = -1;
alpar@949
   291
      edges[e.id].next_in = nodes[n.id].first_in;
alpar@949
   292
      nodes[n.id].first_in = e.id;
alpar@949
   293
    }
deba@2111
   294
    void changeSource(Edge e, Node n) 
alpar@949
   295
    {
alpar@949
   296
      if(edges[e.id].next_out != -1)
alpar@949
   297
	edges[edges[e.id].next_out].prev_out = edges[e.id].prev_out;
alpar@949
   298
      if(edges[e.id].prev_out != -1)
alpar@949
   299
	edges[edges[e.id].prev_out].next_out = edges[e.id].next_out;
alpar@986
   300
      else nodes[edges[e.id].source].first_out = edges[e.id].next_out;
deba@1702
   301
      if (nodes[n.id].first_out != -1) {
deba@1702
   302
	edges[nodes[n.id].first_out].prev_out = e.id;
deba@1702
   303
      }
alpar@986
   304
      edges[e.id].source = n.id;
alpar@949
   305
      edges[e.id].prev_out = -1;
alpar@949
   306
      edges[e.id].next_out = nodes[n.id].first_out;
alpar@949
   307
      nodes[n.id].first_out = e.id;
alpar@949
   308
    }
alpar@949
   309
alpar@919
   310
  };
deba@909
   311
deba@1979
   312
  typedef GraphExtender<ListGraphBase> ExtendedListGraphBase;
alpar@400
   313
deba@2116
   314
  /// \addtogroup graphs
deba@2116
   315
  /// @{
alpar@400
   316
alpar@948
   317
  ///A list graph class.
alpar@400
   318
alpar@2117
   319
  ///This is a simple and fast graph implementation.
alpar@948
   320
  ///
alpar@2117
   321
  ///It conforms to the \ref concept::Graph "Graph concept" and it
deba@2111
   322
  ///also provides several additional useful extra functionalities.
deba@2111
   323
  ///The most of the member functions and nested classes are
deba@2111
   324
  ///documented only in the concept class.
deba@2111
   325
  ///\sa concept::Graph.
deba@782
   326
deba@1999
   327
  class ListGraph : public ExtendedListGraphBase {
alpar@2128
   328
  private:
alpar@2128
   329
    ///ListGraph is \e not copy constructible. Use GraphCopy() instead.
alpar@2128
   330
    
alpar@2128
   331
    ///ListGraph is \e not copy constructible. Use GraphCopy() instead.
alpar@2128
   332
    ///
alpar@2128
   333
    ListGraph(const ListGraph &) :ExtendedListGraphBase() {};
alpar@2132
   334
    ///\brief Assignment of ListGraph to another one is \e not allowed.
alpar@2128
   335
    ///Use GraphCopy() instead.
alpar@2128
   336
alpar@2132
   337
    ///Assignment of ListGraph to another one is \e not allowed.
alpar@2128
   338
    ///Use GraphCopy() instead.
alpar@2128
   339
    void operator=(const ListGraph &) {}
alpar@948
   340
  public:
deba@1999
   341
deba@1999
   342
    typedef ExtendedListGraphBase Parent;
deba@1999
   343
alpar@2128
   344
    /// Constructor
alpar@2128
   345
    
alpar@2128
   346
    /// Constructor.
alpar@2128
   347
    ///
alpar@2128
   348
    ListGraph() {}
alpar@2128
   349
deba@2111
   350
    ///Add a new node to the graph.
deba@2111
   351
    
deba@2111
   352
    /// \return the new node.
deba@2111
   353
    ///
deba@2111
   354
    Node addNode() { return Parent::addNode(); }
deba@2111
   355
deba@2111
   356
    ///Add a new edge to the graph.
deba@2111
   357
    
deba@2111
   358
    ///Add a new edge to the graph with source node \c s
deba@2111
   359
    ///and target node \c t.
deba@2111
   360
    ///\return the new edge.
deba@2111
   361
    Edge addEdge(const Node& s, const Node& t) { 
deba@2111
   362
      return Parent::addEdge(s, t); 
deba@2111
   363
    }
deba@2111
   364
alpar@1546
   365
    /// Changes the target of \c e to \c n
alpar@948
   366
alpar@1546
   367
    /// Changes the target of \c e to \c n
alpar@948
   368
    ///
deba@2160
   369
    ///\note The <tt>EdgeIt</tt>s and <tt>OutEdgeIt</tt>s referencing
deba@2114
   370
    ///the changed edge remain valid. However <tt>InEdgeIt</tt>s are
deba@2114
   371
    ///invalidated.
alpar@2123
   372
    ///\warning This functionality cannot be used together with the Snapshot
alpar@2123
   373
    ///feature.
deba@1718
   374
    void changeTarget(Edge e, Node n) { 
deba@2111
   375
      Parent::changeTarget(e,n); 
deba@1718
   376
    }
alpar@1546
   377
    /// Changes the source of \c e to \c n
alpar@948
   378
alpar@1546
   379
    /// Changes the source of \c e to \c n
alpar@948
   380
    ///
deba@2160
   381
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s referencing
deba@2114
   382
    ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
deba@2114
   383
    ///invalidated.
alpar@2123
   384
    ///\warning This functionality cannot be used together with the Snapshot
alpar@2123
   385
    ///feature.
deba@1718
   386
    void changeSource(Edge e, Node n) { 
deba@2111
   387
      Parent::changeSource(e,n);
deba@1718
   388
    }
alpar@949
   389
alpar@1010
   390
    /// Invert the direction of an edge.
alpar@1010
   391
deba@2160
   392
    ///\note The <tt>EdgeIt</tt>s referencing the changed edge remain
deba@2114
   393
    ///valid. However <tt>OutEdgeIt</tt>s and <tt>InEdgeIt</tt>s are
deba@2114
   394
    ///invalidated.
alpar@2123
   395
    ///\warning This functionality cannot be used together with the Snapshot
alpar@2123
   396
    ///feature.
alpar@1010
   397
    void reverseEdge(Edge e) {
alpar@1010
   398
      Node t=target(e);
deba@2111
   399
      changeTarget(e,source(e));
deba@2111
   400
      changeSource(e,t);
alpar@1010
   401
    }
alpar@1010
   402
deba@2111
   403
    /// \brief Using this it is possible to avoid the superfluous memory
deba@2111
   404
    /// allocation.
alpar@1010
   405
deba@2107
   406
    ///Using this it is possible to avoid the superfluous memory
deba@2107
   407
    ///allocation: if you know that the graph you want to build will
alpar@2123
   408
    ///contain at least 10 million nodes then it is worth reserving
deba@2107
   409
    ///space for this amount before starting to build the graph.
deba@2107
   410
    void reserveNode(int n) { nodes.reserve(n); };
deba@2107
   411
deba@2111
   412
    /// \brief Using this it is possible to avoid the superfluous memory
deba@2111
   413
    /// allocation.
deba@2107
   414
deba@2107
   415
    ///Using this it is possible to avoid the superfluous memory
deba@2107
   416
    ///allocation: see the \ref reserveNode function.
alpar@949
   417
    void reserveEdge(int n) { edges.reserve(n); };
alpar@1010
   418
deba@2107
   419
alpar@1010
   420
    ///Contract two nodes.
alpar@1010
   421
alpar@1010
   422
    ///This function contracts two nodes.
alpar@1010
   423
    ///
alpar@1010
   424
    ///Node \p b will be removed but instead of deleting
athos@2102
   425
    ///incident edges, they will be joined to \p a.
alpar@1010
   426
    ///The last parameter \p r controls whether to remove loops. \c true
alpar@1010
   427
    ///means that loops will be removed.
alpar@1010
   428
    ///
deba@2160
   429
    ///\note The <tt>EdgeIt</tt>s
alpar@1281
   430
    ///referencing a moved edge remain
deba@2160
   431
    ///valid. However <tt>InEdgeIt</tt>s and <tt>OutEdgeIt</tt>s
alpar@1010
   432
    ///may be invalidated.
alpar@2123
   433
    ///\warning This functionality cannot be used together with the Snapshot
alpar@2123
   434
    ///feature.
deba@1718
   435
    void contract(Node a, Node b, bool r = true) 
alpar@1010
   436
    {
alpar@1010
   437
      for(OutEdgeIt e(*this,b);e!=INVALID;) {
alpar@1010
   438
	OutEdgeIt f=e;
alpar@1010
   439
	++f;
alpar@1010
   440
	if(r && target(e)==a) erase(e);
alpar@1546
   441
	else changeSource(e,a);
alpar@1010
   442
	e=f;
alpar@1010
   443
      }
alpar@1010
   444
      for(InEdgeIt e(*this,b);e!=INVALID;) {
alpar@1010
   445
	InEdgeIt f=e;
alpar@1010
   446
	++f;
alpar@1010
   447
	if(r && source(e)==a) erase(e);
alpar@1546
   448
	else changeTarget(e,a);
alpar@1010
   449
	e=f;
alpar@1010
   450
      }
alpar@1010
   451
      erase(b);
alpar@1010
   452
    }
alpar@1011
   453
alpar@1281
   454
    ///Split a node.
alpar@1011
   455
alpar@1284
   456
    ///This function splits a node. First a new node is added to the graph,
alpar@1284
   457
    ///then the source of each outgoing edge of \c n is moved to this new node.
alpar@1281
   458
    ///If \c connect is \c true (this is the default value), then a new edge
alpar@1281
   459
    ///from \c n to the newly created node is also added.
alpar@1281
   460
    ///\return The newly created node.
alpar@1281
   461
    ///
deba@2160
   462
    ///\note The <tt>EdgeIt</tt>s referencing a moved edge remain
deba@2160
   463
    ///valid. However <tt>InEdgeIt</tt>s and <tt>OutEdgeIt</tt>s may
deba@2160
   464
    ///be invalidated.  
deba@2160
   465
    ///
deba@2160
   466
    ///\warning This functionality cannot be used together with the
deba@2160
   467
    ///Snapshot feature.  \todo It could be implemented in a bit
deba@2160
   468
    ///faster way.
deba@2114
   469
    Node split(Node n, bool connect = true) {
alpar@1281
   470
      Node b = addNode();
alpar@1281
   471
      for(OutEdgeIt e(*this,n);e!=INVALID;) {
alpar@1281
   472
 	OutEdgeIt f=e;
alpar@1281
   473
	++f;
alpar@1546
   474
	changeSource(e,b);
alpar@1281
   475
	e=f;
alpar@1281
   476
      }
deba@2114
   477
      if (connect) addEdge(n,b);
alpar@1281
   478
      return b;
alpar@1281
   479
    }
alpar@1281
   480
      
alpar@1812
   481
    ///Split an edge.
alpar@1812
   482
athos@2102
   483
    ///This function splits an edge. First a new node \c b is added to
athos@2102
   484
    ///the graph, then the original edge is re-targeted to \c
athos@2102
   485
    ///b. Finally an edge from \c b to the original target is added.
athos@2102
   486
    ///\return The newly created node.  
athos@2102
   487
    ///\warning This functionality
athos@2102
   488
    ///cannot be used together with the Snapshot feature.
deba@2114
   489
    Node split(Edge e) {
alpar@1812
   490
      Node b = addNode();
alpar@1812
   491
      addEdge(b,target(e));
alpar@1812
   492
      changeTarget(e,b);
alpar@1812
   493
      return b;
alpar@1812
   494
    }
alpar@1812
   495
      
deba@2114
   496
    /// \brief Class to make a snapshot of the graph and restore
deba@2114
   497
    /// to it later.
alpar@1011
   498
    ///
deba@2114
   499
    /// Class to make a snapshot of the graph and to restore it
deba@2114
   500
    /// later.
alpar@1011
   501
    ///
deba@2114
   502
    /// The newly added nodes and edges can be removed using the
deba@2114
   503
    /// restore() function.
deba@2114
   504
    ///
deba@2189
   505
    /// \warning Edge and node deletions cannot be restored. This
deba@2189
   506
    /// events invalidate the snapshot. 
deba@2114
   507
    class Snapshot {
deba@1999
   508
    protected:
deba@2114
   509
deba@2114
   510
      typedef Parent::NodeNotifier NodeNotifier;
deba@2114
   511
deba@2114
   512
      class NodeObserverProxy : public NodeNotifier::ObserverBase {
deba@2114
   513
      public:
deba@2114
   514
deba@2114
   515
        NodeObserverProxy(Snapshot& _snapshot)
deba@2114
   516
          : snapshot(_snapshot) {}
deba@2114
   517
deba@2114
   518
        using NodeNotifier::ObserverBase::attach;
deba@2114
   519
        using NodeNotifier::ObserverBase::detach;
deba@2114
   520
        using NodeNotifier::ObserverBase::attached;
deba@2114
   521
        
deba@2114
   522
      protected:
deba@2114
   523
        
deba@2114
   524
        virtual void add(const Node& node) {
deba@2114
   525
          snapshot.addNode(node);
deba@2114
   526
        }
deba@2114
   527
        virtual void add(const std::vector<Node>& nodes) {
deba@2114
   528
          for (int i = nodes.size() - 1; i >= 0; ++i) {
deba@2114
   529
            snapshot.addNode(nodes[i]);
deba@2114
   530
          }
deba@2114
   531
        }
deba@2114
   532
        virtual void erase(const Node& node) {
deba@2114
   533
          snapshot.eraseNode(node);
deba@2114
   534
        }
deba@2114
   535
        virtual void erase(const std::vector<Node>& nodes) {
deba@2114
   536
          for (int i = 0; i < (int)nodes.size(); ++i) {
deba@2189
   537
            snapshot.eraseNode(nodes[i]);
deba@2114
   538
          }
deba@2114
   539
        }
deba@2114
   540
        virtual void build() {
deba@2114
   541
          NodeNotifier* notifier = getNotifier();
deba@2114
   542
          Node node;
deba@2114
   543
          std::vector<Node> nodes;
deba@2114
   544
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2114
   545
            nodes.push_back(node);
deba@2114
   546
          }
deba@2114
   547
          for (int i = nodes.size() - 1; i >= 0; --i) {
deba@2114
   548
            snapshot.addNode(nodes[i]);
deba@2114
   549
          }
deba@2114
   550
        }
deba@2114
   551
        virtual void clear() {
deba@2114
   552
          NodeNotifier* notifier = getNotifier();
deba@2114
   553
          Node node;
deba@2114
   554
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2189
   555
            snapshot.eraseNode(node);
deba@2114
   556
          }
deba@2114
   557
        }
deba@2114
   558
deba@2114
   559
        Snapshot& snapshot;
deba@2114
   560
      };
deba@2114
   561
deba@2114
   562
      class EdgeObserverProxy : public EdgeNotifier::ObserverBase {
deba@2114
   563
      public:
deba@2114
   564
deba@2114
   565
        EdgeObserverProxy(Snapshot& _snapshot)
deba@2114
   566
          : snapshot(_snapshot) {}
deba@2114
   567
deba@2114
   568
        using EdgeNotifier::ObserverBase::attach;
deba@2114
   569
        using EdgeNotifier::ObserverBase::detach;
deba@2114
   570
        using EdgeNotifier::ObserverBase::attached;
deba@2114
   571
        
deba@2114
   572
      protected:
deba@2114
   573
deba@2114
   574
        virtual void add(const Edge& edge) {
deba@2114
   575
          snapshot.addEdge(edge);
deba@2114
   576
        }
deba@2114
   577
        virtual void add(const std::vector<Edge>& edges) {
deba@2114
   578
          for (int i = edges.size() - 1; i >= 0; ++i) {
deba@2114
   579
            snapshot.addEdge(edges[i]);
deba@2114
   580
          }
deba@2114
   581
        }
deba@2114
   582
        virtual void erase(const Edge& edge) {
deba@2114
   583
          snapshot.eraseEdge(edge);
deba@2114
   584
        }
deba@2114
   585
        virtual void erase(const std::vector<Edge>& edges) {
deba@2114
   586
          for (int i = 0; i < (int)edges.size(); ++i) {
deba@2189
   587
            snapshot.eraseEdge(edges[i]);
deba@2114
   588
          }
deba@2114
   589
        }
deba@2114
   590
        virtual void build() {
deba@2114
   591
          EdgeNotifier* notifier = getNotifier();
deba@2114
   592
          Edge edge;
deba@2114
   593
          std::vector<Edge> edges;
deba@2114
   594
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2114
   595
            edges.push_back(edge);
deba@2114
   596
          }
deba@2114
   597
          for (int i = edges.size() - 1; i >= 0; --i) {
deba@2114
   598
            snapshot.addEdge(edges[i]);
deba@2114
   599
          }
deba@2114
   600
        }
deba@2114
   601
        virtual void clear() {
deba@2114
   602
          EdgeNotifier* notifier = getNotifier();
deba@2114
   603
          Edge edge;
deba@2114
   604
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2189
   605
            snapshot.eraseEdge(edge);
deba@2114
   606
          }
deba@2114
   607
        }
deba@2114
   608
deba@2114
   609
        Snapshot& snapshot;
deba@2114
   610
      };
alpar@1011
   611
      
deba@2114
   612
      ListGraph *graph;
deba@2114
   613
deba@2114
   614
      NodeObserverProxy node_observer_proxy;
deba@2114
   615
      EdgeObserverProxy edge_observer_proxy;
deba@2114
   616
alpar@1011
   617
      std::list<Node> added_nodes;
alpar@1011
   618
      std::list<Edge> added_edges;
deba@2114
   619
deba@2114
   620
deba@2114
   621
      void addNode(const Node& node) {
deba@2114
   622
        added_nodes.push_front(node);        
alpar@1011
   623
      }
deba@2189
   624
      void eraseNode(const Node& node) {
deba@2114
   625
        std::list<Node>::iterator it = 
deba@2114
   626
          std::find(added_nodes.begin(), added_nodes.end(), node);
deba@2114
   627
        if (it == added_nodes.end()) {
deba@2114
   628
          clear();
deba@2189
   629
          edge_observer_proxy.detach();
deba@2189
   630
          throw NodeNotifier::ImmediateDetach();
deba@2114
   631
        } else {
deba@2114
   632
          added_nodes.erase(it);
deba@2114
   633
        }
alpar@1011
   634
      }
alpar@1011
   635
deba@2114
   636
      void addEdge(const Edge& edge) {
deba@2114
   637
        added_edges.push_front(edge);        
deba@2114
   638
      }
deba@2189
   639
      void eraseEdge(const Edge& edge) {
deba@2114
   640
        std::list<Edge>::iterator it = 
deba@2114
   641
          std::find(added_edges.begin(), added_edges.end(), edge);
deba@2114
   642
        if (it == added_edges.end()) {
deba@2114
   643
          clear();
deba@2189
   644
          node_observer_proxy.detach(); 
deba@2189
   645
          throw EdgeNotifier::ImmediateDetach();
deba@2114
   646
        } else {
deba@2114
   647
          added_edges.erase(it);
deba@2114
   648
        }        
deba@2114
   649
      }
alpar@1457
   650
deba@2114
   651
      void attach(ListGraph &_graph) {
deba@2114
   652
	graph = &_graph;
deba@2114
   653
	node_observer_proxy.attach(graph->getNotifier(Node()));
deba@2114
   654
        edge_observer_proxy.attach(graph->getNotifier(Edge()));
alpar@1011
   655
      }
alpar@1011
   656
            
deba@2114
   657
      void detach() {
deba@2114
   658
	node_observer_proxy.detach();
deba@2114
   659
	edge_observer_proxy.detach();
deba@2114
   660
      }
deba@2114
   661
deba@2189
   662
      bool attached() const {
deba@2189
   663
        return node_observer_proxy.attached();
deba@2189
   664
      }
deba@2189
   665
deba@2114
   666
      void clear() {
deba@2114
   667
        added_nodes.clear();
deba@2114
   668
        added_edges.clear();        
alpar@1011
   669
      }
deba@1774
   670
alpar@1011
   671
    public:
deba@2114
   672
deba@2160
   673
      /// \brief Default constructor.
deba@2114
   674
      ///
deba@2114
   675
      /// Default constructor.
deba@2114
   676
      /// To actually make a snapshot you must call save().
deba@2114
   677
      Snapshot() 
deba@2114
   678
        : graph(0), node_observer_proxy(*this), 
deba@2114
   679
          edge_observer_proxy(*this) {}
alpar@1011
   680
      
deba@2114
   681
      /// \brief Constructor that immediately makes a snapshot.
deba@2114
   682
      ///      
deba@2114
   683
      /// This constructor immediately makes a snapshot of the graph.
deba@2114
   684
      /// \param _graph The graph we make a snapshot of.
deba@2114
   685
      Snapshot(ListGraph &_graph) 
deba@2114
   686
        : node_observer_proxy(*this), 
deba@2114
   687
          edge_observer_proxy(*this) {
deba@2114
   688
	attach(_graph);
alpar@1011
   689
      }
alpar@1011
   690
      
deba@2114
   691
      /// \brief Make a snapshot.
alpar@1011
   692
      ///
deba@2114
   693
      /// Make a snapshot of the graph.
deba@2114
   694
      ///
deba@2114
   695
      /// This function can be called more than once. In case of a repeated
deba@2114
   696
      /// call, the previous snapshot gets lost.
deba@2114
   697
      /// \param _graph The graph we make the snapshot of.
deba@2114
   698
      void save(ListGraph &_graph) {
deba@2189
   699
        if (attached()) {
deba@2189
   700
          detach();
deba@2189
   701
          clear();
deba@2189
   702
        }
deba@2114
   703
        attach(_graph);
alpar@1011
   704
      }
alpar@1011
   705
      
deba@2114
   706
      /// \brief Undo the changes until the last snapshot.
deba@2114
   707
      // 
alpar@2123
   708
      /// Undo the changes until the last snapshot created by save().
alpar@1011
   709
      void restore() {
deba@2114
   710
	detach();
deba@2189
   711
	for(std::list<Edge>::iterator it = added_edges.begin(); 
deba@2189
   712
            it != added_edges.end(); ++it) {
deba@2189
   713
	  graph->erase(*it);
alpar@1011
   714
	}
deba@2189
   715
	for(std::list<Node>::iterator it = added_nodes.begin(); 
deba@2189
   716
            it != added_nodes.end(); ++it) {
deba@2189
   717
	  graph->erase(*it);
alpar@1011
   718
	}
deba@2189
   719
        clear();
alpar@1011
   720
      }
deba@2114
   721
deba@2114
   722
      /// \brief Gives back true when the snapshot is valid.
deba@2114
   723
      ///
deba@2114
   724
      /// Gives back true when the snapshot is valid.
deba@2114
   725
      bool valid() const {
deba@2189
   726
        return attached();
deba@2114
   727
      }
alpar@1011
   728
    };
alpar@1011
   729
    
alpar@949
   730
  };
klao@1034
   731
deba@2116
   732
  ///@}
deba@2116
   733
deba@2116
   734
  /**************** Undirected List Graph ****************/
deba@2116
   735
deba@2116
   736
  typedef UGraphExtender<UndirGraphExtender<ListGraphBase> > 
deba@2116
   737
  ExtendedListUGraphBase;
deba@2116
   738
deba@2116
   739
  /// \addtogroup graphs
deba@2116
   740
  /// @{
deba@2116
   741
deba@2116
   742
  ///An undirected list graph class.
deba@2116
   743
alpar@2117
   744
  ///This is a simple and fast undirected graph implementation.
deba@2116
   745
  ///
deba@2116
   746
  ///It conforms to the
alpar@2117
   747
  ///\ref concept::UGraph "UGraph concept".
deba@2116
   748
  ///
deba@2116
   749
  ///\sa concept::UGraph.
deba@2116
   750
  ///
deba@2116
   751
  class ListUGraph : public ExtendedListUGraphBase {
alpar@2128
   752
  private:
alpar@2128
   753
    ///ListUGraph is \e not copy constructible. Use UGraphCopy() instead.
alpar@2128
   754
alpar@2128
   755
    ///ListUGraph is \e not copy constructible. Use UGraphCopy() instead.
alpar@2128
   756
    ///
alpar@2128
   757
    ListUGraph(const ListUGraph &) :ExtendedListUGraphBase()  {};
alpar@2132
   758
    ///\brief Assignment of ListUGraph to another one is \e not allowed.
alpar@2128
   759
    ///Use UGraphCopy() instead.
alpar@2128
   760
alpar@2132
   761
    ///Assignment of ListUGraph to another one is \e not allowed.
alpar@2128
   762
    ///Use UGraphCopy() instead.
alpar@2128
   763
    void operator=(const ListUGraph &) {}
deba@2116
   764
  public:
alpar@2128
   765
    /// Constructor
alpar@2128
   766
    
alpar@2128
   767
    /// Constructor.
alpar@2128
   768
    ///
alpar@2128
   769
    ListUGraph() {}
alpar@2128
   770
deba@2116
   771
    typedef ExtendedListUGraphBase Parent;
deba@2116
   772
    /// \brief Add a new node to the graph.
deba@2116
   773
    ///
deba@2116
   774
    /// \return the new node.
deba@2116
   775
    ///
deba@2116
   776
    Node addNode() { return Parent::addNode(); }
deba@2116
   777
deba@2116
   778
    /// \brief Add a new edge to the graph.
deba@2116
   779
    ///
deba@2116
   780
    /// Add a new edge to the graph with source node \c s
deba@2116
   781
    /// and target node \c t.
deba@2116
   782
    /// \return the new undirected edge.
deba@2116
   783
    UEdge addEdge(const Node& s, const Node& t) { 
deba@2116
   784
      return Parent::addEdge(s, t); 
deba@2116
   785
    }
deba@2160
   786
    /// \brief Changes the source of \c e to \c n
deba@2160
   787
    ///
deba@2160
   788
    /// Changes the source of \c e to \c n
deba@2160
   789
    ///
deba@2160
   790
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s
deba@2160
   791
    ///referencing the changed edge remain
deba@2160
   792
    ///valid. However <tt>OutEdgeIt</tt>s are invalidated.
deba@2160
   793
    void changeSource(UEdge e, Node n) { 
deba@2160
   794
      Parent::changeSource(e,n); 
deba@2160
   795
    }    
deba@2116
   796
    /// \brief Changes the target of \c e to \c n
deba@2116
   797
    ///
deba@2116
   798
    /// Changes the target of \c e to \c n
deba@2116
   799
    ///
deba@2160
   800
    /// \note The <tt>EdgeIt</tt>s referencing the changed edge remain
deba@2160
   801
    /// valid. However the other iterators may be invalidated.
deba@2116
   802
    void changeTarget(UEdge e, Node n) { 
deba@2116
   803
      Parent::changeTarget(e,n); 
deba@2116
   804
    }
deba@2160
   805
    /// \brief Changes the source of \c e to \c n
deba@2116
   806
    ///
deba@2160
   807
    /// Changes the source of \c e to \c n. It changes the proper
deba@2160
   808
    /// node of the represented undirected edge.
deba@2116
   809
    ///
deba@2160
   810
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s
deba@2116
   811
    ///referencing the changed edge remain
deba@2160
   812
    ///valid. However <tt>OutEdgeIt</tt>s are invalidated.
deba@2160
   813
    void changeSource(Edge e, Node n) { 
deba@2160
   814
      if (Parent::direction(e)) {
deba@2160
   815
        Parent::changeSource(e,n);
deba@2160
   816
      } else {
deba@2160
   817
        Parent::changeTarget(e,n);
deba@2160
   818
      } 
deba@2160
   819
    }
deba@2160
   820
    /// \brief Changes the target of \c e to \c n
deba@2160
   821
    ///
deba@2160
   822
    /// Changes the target of \c e to \c n. It changes the proper
deba@2160
   823
    /// node of the represented undirected edge.
deba@2160
   824
    ///
deba@2160
   825
    ///\note The <tt>EdgeIt</tt>s and <tt>OutEdgeIt</tt>s
deba@2160
   826
    ///referencing the changed edge remain
deba@2160
   827
    ///valid. However <tt>InEdgeIt</tt>s are invalidated.
deba@2160
   828
    void changeTarget(Edge e, Node n) { 
deba@2160
   829
      if (Parent::direction(e)) {
deba@2160
   830
        Parent::changeTarget(e,n);
deba@2160
   831
      } else {
deba@2160
   832
        Parent::changeSource(e,n);
deba@2160
   833
      } 
deba@2116
   834
    }
deba@2116
   835
    /// \brief Contract two nodes.
deba@2116
   836
    ///
deba@2116
   837
    /// This function contracts two nodes.
deba@2116
   838
    ///
deba@2116
   839
    /// Node \p b will be removed but instead of deleting
deba@2116
   840
    /// its neighboring edges, they will be joined to \p a.
deba@2116
   841
    /// The last parameter \p r controls whether to remove loops. \c true
deba@2116
   842
    /// means that loops will be removed.
deba@2116
   843
    ///
deba@2160
   844
    /// \note The <tt>EdgeIt</tt>s referencing a moved edge remain
deba@2116
   845
    /// valid.
deba@2116
   846
    void contract(Node a, Node b, bool r = true) {
deba@2116
   847
      for(IncEdgeIt e(*this, b); e!=INVALID;) {
deba@2116
   848
	IncEdgeIt f = e; ++f;
deba@2116
   849
	if (r && runningNode(e) == a) {
deba@2116
   850
	  erase(e);
deba@2116
   851
	} else if (source(e) == b) {
deba@2116
   852
	  changeSource(e, a);
deba@2116
   853
	} else {
deba@2116
   854
	  changeTarget(e, a);
deba@2116
   855
	}
deba@2116
   856
	e = f;
deba@2116
   857
      }
deba@2116
   858
      erase(b);
deba@2116
   859
    }
deba@2189
   860
deba@2189
   861
deba@2189
   862
    /// \brief Class to make a snapshot of the graph and restore
deba@2189
   863
    /// to it later.
deba@2189
   864
    ///
deba@2189
   865
    /// Class to make a snapshot of the graph and to restore it
deba@2189
   866
    /// later.
deba@2189
   867
    ///
deba@2189
   868
    /// The newly added nodes and undirected edges can be removed
deba@2189
   869
    /// using the restore() function.
deba@2189
   870
    ///
deba@2189
   871
    /// \warning Edge and node deletions cannot be restored. This
deba@2189
   872
    /// events invalidate the snapshot. 
deba@2189
   873
    class Snapshot {
deba@2189
   874
    protected:
deba@2189
   875
deba@2189
   876
      typedef Parent::NodeNotifier NodeNotifier;
deba@2189
   877
deba@2189
   878
      class NodeObserverProxy : public NodeNotifier::ObserverBase {
deba@2189
   879
      public:
deba@2189
   880
deba@2189
   881
        NodeObserverProxy(Snapshot& _snapshot)
deba@2189
   882
          : snapshot(_snapshot) {}
deba@2189
   883
deba@2189
   884
        using NodeNotifier::ObserverBase::attach;
deba@2189
   885
        using NodeNotifier::ObserverBase::detach;
deba@2189
   886
        using NodeNotifier::ObserverBase::attached;
deba@2189
   887
        
deba@2189
   888
      protected:
deba@2189
   889
        
deba@2189
   890
        virtual void add(const Node& node) {
deba@2189
   891
          snapshot.addNode(node);
deba@2189
   892
        }
deba@2189
   893
        virtual void add(const std::vector<Node>& nodes) {
deba@2189
   894
          for (int i = nodes.size() - 1; i >= 0; ++i) {
deba@2189
   895
            snapshot.addNode(nodes[i]);
deba@2189
   896
          }
deba@2189
   897
        }
deba@2189
   898
        virtual void erase(const Node& node) {
deba@2189
   899
          snapshot.eraseNode(node);
deba@2189
   900
        }
deba@2189
   901
        virtual void erase(const std::vector<Node>& nodes) {
deba@2189
   902
          for (int i = 0; i < (int)nodes.size(); ++i) {
deba@2189
   903
            snapshot.eraseNode(nodes[i]);
deba@2189
   904
          }
deba@2189
   905
        }
deba@2189
   906
        virtual void build() {
deba@2189
   907
          NodeNotifier* notifier = getNotifier();
deba@2189
   908
          Node node;
deba@2189
   909
          std::vector<Node> nodes;
deba@2189
   910
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2189
   911
            nodes.push_back(node);
deba@2189
   912
          }
deba@2189
   913
          for (int i = nodes.size() - 1; i >= 0; --i) {
deba@2189
   914
            snapshot.addNode(nodes[i]);
deba@2189
   915
          }
deba@2189
   916
        }
deba@2189
   917
        virtual void clear() {
deba@2189
   918
          NodeNotifier* notifier = getNotifier();
deba@2189
   919
          Node node;
deba@2189
   920
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2189
   921
            snapshot.eraseNode(node);
deba@2189
   922
          }
deba@2189
   923
        }
deba@2189
   924
deba@2189
   925
        Snapshot& snapshot;
deba@2189
   926
      };
deba@2189
   927
deba@2189
   928
      class UEdgeObserverProxy : public UEdgeNotifier::ObserverBase {
deba@2189
   929
      public:
deba@2189
   930
deba@2189
   931
        UEdgeObserverProxy(Snapshot& _snapshot)
deba@2189
   932
          : snapshot(_snapshot) {}
deba@2189
   933
deba@2189
   934
        using UEdgeNotifier::ObserverBase::attach;
deba@2189
   935
        using UEdgeNotifier::ObserverBase::detach;
deba@2189
   936
        using UEdgeNotifier::ObserverBase::attached;
deba@2189
   937
        
deba@2189
   938
      protected:
deba@2189
   939
deba@2189
   940
        virtual void add(const UEdge& edge) {
deba@2189
   941
          snapshot.addUEdge(edge);
deba@2189
   942
        }
deba@2189
   943
        virtual void add(const std::vector<UEdge>& edges) {
deba@2189
   944
          for (int i = edges.size() - 1; i >= 0; ++i) {
deba@2189
   945
            snapshot.addUEdge(edges[i]);
deba@2189
   946
          }
deba@2189
   947
        }
deba@2189
   948
        virtual void erase(const UEdge& edge) {
deba@2189
   949
          snapshot.eraseUEdge(edge);
deba@2189
   950
        }
deba@2189
   951
        virtual void erase(const std::vector<UEdge>& edges) {
deba@2189
   952
          for (int i = 0; i < (int)edges.size(); ++i) {
deba@2189
   953
            snapshot.eraseUEdge(edges[i]);
deba@2189
   954
          }
deba@2189
   955
        }
deba@2189
   956
        virtual void build() {
deba@2189
   957
          UEdgeNotifier* notifier = getNotifier();
deba@2189
   958
          UEdge edge;
deba@2189
   959
          std::vector<UEdge> edges;
deba@2189
   960
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2189
   961
            edges.push_back(edge);
deba@2189
   962
          }
deba@2189
   963
          for (int i = edges.size() - 1; i >= 0; --i) {
deba@2189
   964
            snapshot.addUEdge(edges[i]);
deba@2189
   965
          }
deba@2189
   966
        }
deba@2189
   967
        virtual void clear() {
deba@2189
   968
          UEdgeNotifier* notifier = getNotifier();
deba@2189
   969
          UEdge edge;
deba@2189
   970
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2189
   971
            snapshot.eraseUEdge(edge);
deba@2189
   972
          }
deba@2189
   973
        }
deba@2189
   974
deba@2189
   975
        Snapshot& snapshot;
deba@2189
   976
      };
deba@2189
   977
      
deba@2189
   978
      ListUGraph *graph;
deba@2189
   979
deba@2189
   980
      NodeObserverProxy node_observer_proxy;
deba@2189
   981
      UEdgeObserverProxy edge_observer_proxy;
deba@2189
   982
deba@2189
   983
      std::list<Node> added_nodes;
deba@2189
   984
      std::list<UEdge> added_edges;
deba@2189
   985
deba@2189
   986
deba@2189
   987
      void addNode(const Node& node) {
deba@2189
   988
        added_nodes.push_front(node);        
deba@2189
   989
      }
deba@2189
   990
      void eraseNode(const Node& node) {
deba@2189
   991
        std::list<Node>::iterator it = 
deba@2189
   992
          std::find(added_nodes.begin(), added_nodes.end(), node);
deba@2189
   993
        if (it == added_nodes.end()) {
deba@2189
   994
          clear();
deba@2189
   995
          edge_observer_proxy.detach();
deba@2189
   996
          throw NodeNotifier::ImmediateDetach();
deba@2189
   997
        } else {
deba@2189
   998
          added_nodes.erase(it);
deba@2189
   999
        }
deba@2189
  1000
      }
deba@2189
  1001
deba@2189
  1002
      void addUEdge(const UEdge& edge) {
deba@2189
  1003
        added_edges.push_front(edge);        
deba@2189
  1004
      }
deba@2189
  1005
      void eraseUEdge(const UEdge& edge) {
deba@2189
  1006
        std::list<UEdge>::iterator it = 
deba@2189
  1007
          std::find(added_edges.begin(), added_edges.end(), edge);
deba@2189
  1008
        if (it == added_edges.end()) {
deba@2189
  1009
          clear();
deba@2189
  1010
          node_observer_proxy.detach();
deba@2189
  1011
          throw UEdgeNotifier::ImmediateDetach();
deba@2189
  1012
        } else {
deba@2189
  1013
          added_edges.erase(it);
deba@2189
  1014
        }        
deba@2189
  1015
      }
deba@2189
  1016
deba@2189
  1017
      void attach(ListUGraph &_graph) {
deba@2189
  1018
	graph = &_graph;
deba@2189
  1019
	node_observer_proxy.attach(graph->getNotifier(Node()));
deba@2189
  1020
        edge_observer_proxy.attach(graph->getNotifier(UEdge()));
deba@2189
  1021
      }
deba@2189
  1022
            
deba@2189
  1023
      void detach() {
deba@2189
  1024
	node_observer_proxy.detach();
deba@2189
  1025
	edge_observer_proxy.detach();
deba@2189
  1026
      }
deba@2189
  1027
deba@2189
  1028
      bool attached() const {
deba@2189
  1029
        return node_observer_proxy.attached();
deba@2189
  1030
      }
deba@2189
  1031
deba@2189
  1032
      void clear() {
deba@2189
  1033
        added_nodes.clear();
deba@2189
  1034
        added_edges.clear();        
deba@2189
  1035
      }
deba@2189
  1036
deba@2189
  1037
    public:
deba@2189
  1038
deba@2189
  1039
      /// \brief Default constructor.
deba@2189
  1040
      ///
deba@2189
  1041
      /// Default constructor.
deba@2189
  1042
      /// To actually make a snapshot you must call save().
deba@2189
  1043
      Snapshot() 
deba@2189
  1044
        : graph(0), node_observer_proxy(*this), 
deba@2189
  1045
          edge_observer_proxy(*this) {}
deba@2189
  1046
      
deba@2189
  1047
      /// \brief Constructor that immediately makes a snapshot.
deba@2189
  1048
      ///      
deba@2189
  1049
      /// This constructor immediately makes a snapshot of the graph.
deba@2189
  1050
      /// \param _graph The graph we make a snapshot of.
deba@2189
  1051
      Snapshot(ListUGraph &_graph) 
deba@2189
  1052
        : node_observer_proxy(*this), 
deba@2189
  1053
          edge_observer_proxy(*this) {
deba@2189
  1054
	attach(_graph);
deba@2189
  1055
      }
deba@2189
  1056
      
deba@2189
  1057
      /// \brief Make a snapshot.
deba@2189
  1058
      ///
deba@2189
  1059
      /// Make a snapshot of the graph.
deba@2189
  1060
      ///
deba@2189
  1061
      /// This function can be called more than once. In case of a repeated
deba@2189
  1062
      /// call, the previous snapshot gets lost.
deba@2189
  1063
      /// \param _graph The graph we make the snapshot of.
deba@2189
  1064
      void save(ListUGraph &_graph) {
deba@2189
  1065
        if (attached()) {
deba@2189
  1066
          detach();
deba@2189
  1067
          clear();
deba@2189
  1068
        }
deba@2189
  1069
        attach(_graph);
deba@2189
  1070
      }
deba@2189
  1071
      
deba@2189
  1072
      /// \brief Undo the changes until the last snapshot.
deba@2189
  1073
      // 
deba@2189
  1074
      /// Undo the changes until the last snapshot created by save().
deba@2189
  1075
      void restore() {
deba@2189
  1076
	detach();
deba@2189
  1077
	for(std::list<UEdge>::iterator it = added_edges.begin(); 
deba@2189
  1078
            it != added_edges.end(); ++it) {
deba@2189
  1079
	  graph->erase(*it);
deba@2189
  1080
	}
deba@2189
  1081
	for(std::list<Node>::iterator it = added_nodes.begin(); 
deba@2189
  1082
            it != added_nodes.end(); ++it) {
deba@2189
  1083
	  graph->erase(*it);
deba@2189
  1084
	}
deba@2189
  1085
        clear();
deba@2189
  1086
      }
deba@2189
  1087
deba@2189
  1088
      /// \brief Gives back true when the snapshot is valid.
deba@2189
  1089
      ///
deba@2189
  1090
      /// Gives back true when the snapshot is valid.
deba@2189
  1091
      bool valid() const {
deba@2189
  1092
        return attached();
deba@2189
  1093
      }
deba@2189
  1094
    };
deba@2116
  1095
  };
deba@2116
  1096
deba@2116
  1097
deba@2116
  1098
  class ListBpUGraphBase {
deba@2116
  1099
  public:
deba@2116
  1100
deba@2116
  1101
    class NodeSetError : public LogicError {
deba@2160
  1102
    public:
alpar@2151
  1103
      virtual const char* what() const throw() { 
deba@2116
  1104
	return "lemon::ListBpUGraph::NodeSetError";
deba@2116
  1105
      }
deba@2116
  1106
    };
deba@2116
  1107
deba@2116
  1108
  protected:
deba@2116
  1109
deba@2116
  1110
    struct NodeT {
deba@2116
  1111
      int first_edge, prev, next;
deba@2116
  1112
    };
deba@2116
  1113
deba@2116
  1114
    struct UEdgeT {
deba@2116
  1115
      int aNode, prev_out, next_out;
deba@2116
  1116
      int bNode, prev_in, next_in;
deba@2116
  1117
    };
deba@2116
  1118
deba@2116
  1119
    std::vector<NodeT> aNodes;
deba@2116
  1120
    std::vector<NodeT> bNodes;
deba@2116
  1121
deba@2116
  1122
    std::vector<UEdgeT> edges;
deba@2116
  1123
deba@2116
  1124
    int first_anode;
deba@2116
  1125
    int first_free_anode;
deba@2116
  1126
deba@2116
  1127
    int first_bnode;
deba@2116
  1128
    int first_free_bnode;
deba@2116
  1129
deba@2116
  1130
    int first_free_edge;
deba@2116
  1131
deba@2116
  1132
  public:
deba@2116
  1133
  
deba@2116
  1134
    class Node {
deba@2116
  1135
      friend class ListBpUGraphBase;
deba@2116
  1136
    protected:
deba@2116
  1137
      int id;
deba@2116
  1138
deba@2116
  1139
      explicit Node(int _id) : id(_id) {}
deba@2116
  1140
    public:
deba@2116
  1141
      Node() {}
deba@2116
  1142
      Node(Invalid) { id = -1; }
deba@2116
  1143
      bool operator==(const Node i) const {return id==i.id;}
deba@2116
  1144
      bool operator!=(const Node i) const {return id!=i.id;}
deba@2116
  1145
      bool operator<(const Node i) const {return id<i.id;}
deba@2116
  1146
    };
deba@2116
  1147
deba@2116
  1148
    class UEdge {
deba@2116
  1149
      friend class ListBpUGraphBase;
deba@2116
  1150
    protected:
deba@2116
  1151
      int id;
deba@2116
  1152
deba@2116
  1153
      explicit UEdge(int _id) { id = _id;}
deba@2116
  1154
    public:
deba@2116
  1155
      UEdge() {}
deba@2116
  1156
      UEdge (Invalid) { id = -1; }
deba@2116
  1157
      bool operator==(const UEdge i) const {return id==i.id;}
deba@2116
  1158
      bool operator!=(const UEdge i) const {return id!=i.id;}
deba@2116
  1159
      bool operator<(const UEdge i) const {return id<i.id;}
deba@2116
  1160
    };
deba@2116
  1161
deba@2116
  1162
    ListBpUGraphBase()
deba@2116
  1163
      : first_anode(-1), first_free_anode(-1),
deba@2116
  1164
        first_bnode(-1), first_free_bnode(-1),
deba@2116
  1165
        first_free_edge(-1) {}
deba@2116
  1166
deba@2116
  1167
    void firstANode(Node& node) const {
deba@2116
  1168
      node.id = first_anode != -1 ? (first_anode << 1) : -1;
deba@2116
  1169
    }
deba@2116
  1170
    void nextANode(Node& node) const {
deba@2116
  1171
      node.id = aNodes[node.id >> 1].next;
deba@2116
  1172
    }
deba@2116
  1173
deba@2116
  1174
    void firstBNode(Node& node) const {
deba@2116
  1175
      node.id = first_bnode != -1 ? (first_bnode << 1) + 1 : -1;
deba@2116
  1176
    }
deba@2116
  1177
    void nextBNode(Node& node) const {
deba@2116
  1178
      node.id = bNodes[node.id >> 1].next;
deba@2116
  1179
    }
deba@2116
  1180
deba@2116
  1181
    void first(Node& node) const {
deba@2116
  1182
      if (first_anode != -1) {
deba@2116
  1183
        node.id = (first_anode << 1);
deba@2116
  1184
      } else if (first_bnode != -1) {
deba@2116
  1185
        node.id = (first_bnode << 1) + 1;
deba@2116
  1186
      } else {
deba@2116
  1187
        node.id = -1;
deba@2116
  1188
      }
deba@2116
  1189
    }
deba@2116
  1190
    void next(Node& node) const {
deba@2116
  1191
      if (aNode(node)) {
deba@2116
  1192
        node.id = aNodes[node.id >> 1].next;
deba@2116
  1193
        if (node.id == -1) {
deba@2116
  1194
          if (first_bnode != -1) {
deba@2116
  1195
            node.id = (first_bnode << 1) + 1;
deba@2116
  1196
          }
deba@2116
  1197
        }
deba@2116
  1198
      } else {
deba@2116
  1199
        node.id = bNodes[node.id >> 1].next;
deba@2116
  1200
      }
deba@2116
  1201
    }
deba@2116
  1202
  
deba@2116
  1203
    void first(UEdge& edge) const {
deba@2116
  1204
      int aNodeId = first_anode;
deba@2116
  1205
      while (aNodeId != -1 && aNodes[aNodeId].first_edge == -1) {
deba@2116
  1206
        aNodeId = aNodes[aNodeId].next != -1 ? 
deba@2116
  1207
          aNodes[aNodeId].next >> 1 : -1;
deba@2116
  1208
      }
deba@2116
  1209
      if (aNodeId != -1) {
deba@2116
  1210
        edge.id = aNodes[aNodeId].first_edge;
deba@2116
  1211
      } else {
deba@2116
  1212
        edge.id = -1;
deba@2116
  1213
      }
deba@2116
  1214
    }
deba@2116
  1215
    void next(UEdge& edge) const {
deba@2116
  1216
      int aNodeId = edges[edge.id].aNode >> 1;
deba@2116
  1217
      edge.id = edges[edge.id].next_out;
deba@2116
  1218
      if (edge.id == -1) {
deba@2116
  1219
        aNodeId = aNodes[aNodeId].next != -1 ? 
deba@2116
  1220
          aNodes[aNodeId].next >> 1 : -1;
deba@2116
  1221
        while (aNodeId != -1 && aNodes[aNodeId].first_edge == -1) {
deba@2116
  1222
          aNodeId = aNodes[aNodeId].next != -1 ? 
deba@2116
  1223
          aNodes[aNodeId].next >> 1 : -1;
deba@2116
  1224
        }
deba@2116
  1225
        if (aNodeId != -1) {
deba@2116
  1226
          edge.id = aNodes[aNodeId].first_edge;
deba@2116
  1227
        } else {
deba@2116
  1228
          edge.id = -1;
deba@2116
  1229
        }
deba@2116
  1230
      }
deba@2116
  1231
    }
deba@2116
  1232
deba@2116
  1233
    void firstFromANode(UEdge& edge, const Node& node) const {
deba@2116
  1234
      LEMON_ASSERT((node.id & 1) == 0, NodeSetError());
deba@2116
  1235
      edge.id = aNodes[node.id >> 1].first_edge;
deba@2116
  1236
    }
deba@2116
  1237
    void nextFromANode(UEdge& edge) const {
deba@2116
  1238
      edge.id = edges[edge.id].next_out;
deba@2116
  1239
    }
deba@2116
  1240
deba@2116
  1241
    void firstFromBNode(UEdge& edge, const Node& node) const {
deba@2116
  1242
      LEMON_ASSERT((node.id & 1) == 1, NodeSetError());
deba@2116
  1243
      edge.id = bNodes[node.id >> 1].first_edge;
deba@2116
  1244
    }
deba@2116
  1245
    void nextFromBNode(UEdge& edge) const {
deba@2116
  1246
      edge.id = edges[edge.id].next_in;
deba@2116
  1247
    }
deba@2116
  1248
deba@2116
  1249
    static int id(const Node& node) {
deba@2116
  1250
      return node.id;
deba@2116
  1251
    }
deba@2116
  1252
    static Node nodeFromId(int id) {
deba@2116
  1253
      return Node(id);
deba@2116
  1254
    }
deba@2116
  1255
    int maxNodeId() const {
deba@2116
  1256
      return aNodes.size() > bNodes.size() ?
deba@2116
  1257
	aNodes.size() * 2 - 2 : bNodes.size() * 2 - 1;
deba@2116
  1258
    }
deba@2116
  1259
  
deba@2116
  1260
    static int id(const UEdge& edge) {
deba@2116
  1261
      return edge.id;
deba@2116
  1262
    }
deba@2116
  1263
    static UEdge uEdgeFromId(int id) {
deba@2116
  1264
      return UEdge(id);
deba@2116
  1265
    }
deba@2116
  1266
    int maxUEdgeId() const {
deba@2116
  1267
      return edges.size();
deba@2116
  1268
    }
deba@2116
  1269
  
deba@2116
  1270
    static int aNodeId(const Node& node) {
deba@2116
  1271
      return node.id >> 1;
deba@2116
  1272
    }
deba@2116
  1273
    static Node fromANodeId(int id) {
deba@2116
  1274
      return Node(id << 1);
deba@2116
  1275
    }
deba@2116
  1276
    int maxANodeId() const {
deba@2116
  1277
      return aNodes.size();
deba@2116
  1278
    }
deba@2116
  1279
deba@2116
  1280
    static int bNodeId(const Node& node) {
deba@2116
  1281
      return node.id >> 1;
deba@2116
  1282
    }
deba@2116
  1283
    static Node fromBNodeId(int id) {
deba@2116
  1284
      return Node((id << 1) + 1);
deba@2116
  1285
    }
deba@2116
  1286
    int maxBNodeId() const {
deba@2116
  1287
      return bNodes.size();
deba@2116
  1288
    }
deba@2116
  1289
deba@2116
  1290
    Node aNode(const UEdge& edge) const {
deba@2116
  1291
      return Node(edges[edge.id].aNode);
deba@2116
  1292
    }
deba@2116
  1293
    Node bNode(const UEdge& edge) const {
deba@2116
  1294
      return Node(edges[edge.id].bNode);
deba@2116
  1295
    }
deba@2116
  1296
deba@2116
  1297
    static bool aNode(const Node& node) {
deba@2116
  1298
      return (node.id & 1) == 0;
deba@2116
  1299
    }
deba@2116
  1300
deba@2116
  1301
    static bool bNode(const Node& node) {
deba@2116
  1302
      return (node.id & 1) == 1;
deba@2116
  1303
    }
deba@2116
  1304
deba@2116
  1305
    Node addANode() {
deba@2116
  1306
      int aNodeId;
deba@2116
  1307
      if (first_free_anode == -1) {
deba@2116
  1308
        aNodeId = aNodes.size();
deba@2116
  1309
        aNodes.push_back(NodeT());
deba@2116
  1310
      } else {
deba@2116
  1311
        aNodeId = first_free_anode;
deba@2116
  1312
        first_free_anode = aNodes[first_free_anode].next;
deba@2116
  1313
      }
deba@2116
  1314
      if (first_anode != -1) {
deba@2116
  1315
        aNodes[aNodeId].next = first_anode << 1;
deba@2116
  1316
        aNodes[first_anode].prev = aNodeId << 1;
deba@2116
  1317
      } else {
deba@2116
  1318
        aNodes[aNodeId].next = -1;
deba@2116
  1319
      }
deba@2116
  1320
      aNodes[aNodeId].prev = -1;
deba@2116
  1321
      first_anode = aNodeId;
deba@2116
  1322
      aNodes[aNodeId].first_edge = -1;
deba@2116
  1323
      return Node(aNodeId << 1);
deba@2116
  1324
    }
deba@2116
  1325
deba@2116
  1326
    Node addBNode() {
deba@2116
  1327
      int bNodeId;
deba@2116
  1328
      if (first_free_bnode == -1) {
deba@2116
  1329
        bNodeId = bNodes.size();
deba@2116
  1330
        bNodes.push_back(NodeT());
deba@2116
  1331
      } else {
deba@2116
  1332
        bNodeId = first_free_bnode;
deba@2116
  1333
        first_free_bnode = bNodes[first_free_bnode].next;
deba@2116
  1334
      }
deba@2116
  1335
      if (first_bnode != -1) {
deba@2116
  1336
        bNodes[bNodeId].next = (first_bnode << 1) + 1;
deba@2116
  1337
        bNodes[first_bnode].prev = (bNodeId << 1) + 1;
deba@2116
  1338
      } else {
deba@2116
  1339
        bNodes[bNodeId].next = -1;
deba@2116
  1340
      }
deba@2189
  1341
      bNodes[bNodeId].prev = -1;
deba@2116
  1342
      first_bnode = bNodeId;
deba@2116
  1343
      bNodes[bNodeId].first_edge = -1;
deba@2116
  1344
      return Node((bNodeId << 1) + 1);
deba@2116
  1345
    }
deba@2116
  1346
deba@2116
  1347
    UEdge addEdge(const Node& source, const Node& target) {
deba@2116
  1348
      LEMON_ASSERT(((source.id ^ target.id) & 1) == 1, NodeSetError());
deba@2116
  1349
      int edgeId;
deba@2116
  1350
      if (first_free_edge != -1) {
deba@2116
  1351
        edgeId = first_free_edge;
deba@2116
  1352
        first_free_edge = edges[edgeId].next_out;
deba@2116
  1353
      } else {
deba@2116
  1354
        edgeId = edges.size();
deba@2116
  1355
        edges.push_back(UEdgeT());
deba@2116
  1356
      }
deba@2116
  1357
      if ((source.id & 1) == 0) {
deba@2116
  1358
	edges[edgeId].aNode = source.id;
deba@2116
  1359
	edges[edgeId].bNode = target.id;
deba@2116
  1360
      } else {
deba@2116
  1361
	edges[edgeId].aNode = target.id;
deba@2116
  1362
	edges[edgeId].bNode = source.id;
deba@2116
  1363
      }
deba@2116
  1364
      edges[edgeId].next_out = aNodes[edges[edgeId].aNode >> 1].first_edge;
deba@2116
  1365
      edges[edgeId].prev_out = -1;
deba@2116
  1366
      if (aNodes[edges[edgeId].aNode >> 1].first_edge != -1) {
deba@2116
  1367
        edges[aNodes[edges[edgeId].aNode >> 1].first_edge].prev_out = edgeId;
deba@2116
  1368
      }
deba@2116
  1369
      aNodes[edges[edgeId].aNode >> 1].first_edge = edgeId;
deba@2116
  1370
      edges[edgeId].next_in = bNodes[edges[edgeId].bNode >> 1].first_edge;
deba@2116
  1371
      edges[edgeId].prev_in = -1;
deba@2116
  1372
      if (bNodes[edges[edgeId].bNode >> 1].first_edge != -1) {
deba@2116
  1373
        edges[bNodes[edges[edgeId].bNode >> 1].first_edge].prev_in = edgeId;
deba@2116
  1374
      }
deba@2116
  1375
      bNodes[edges[edgeId].bNode >> 1].first_edge = edgeId;
deba@2116
  1376
      return UEdge(edgeId);
deba@2116
  1377
    }
deba@2116
  1378
deba@2116
  1379
    void erase(const Node& node) {
deba@2116
  1380
      if (aNode(node)) {
deba@2116
  1381
        int aNodeId = node.id >> 1;
deba@2116
  1382
        if (aNodes[aNodeId].prev != -1) {
deba@2116
  1383
          aNodes[aNodes[aNodeId].prev >> 1].next = aNodes[aNodeId].next;
deba@2116
  1384
        } else {
deba@2189
  1385
          first_anode = 
deba@2189
  1386
            aNodes[aNodeId].next != -1 ? aNodes[aNodeId].next >> 1 : -1;
deba@2116
  1387
        }
deba@2116
  1388
        if (aNodes[aNodeId].next != -1) {
deba@2116
  1389
          aNodes[aNodes[aNodeId].next >> 1].prev = aNodes[aNodeId].prev;
deba@2116
  1390
        }
deba@2116
  1391
        aNodes[aNodeId].next = first_free_anode;
deba@2116
  1392
        first_free_anode = aNodeId;
deba@2116
  1393
      } else {
deba@2116
  1394
        int bNodeId = node.id >> 1;
deba@2116
  1395
        if (bNodes[bNodeId].prev != -1) {
deba@2116
  1396
          bNodes[bNodes[bNodeId].prev >> 1].next = bNodes[bNodeId].next;
deba@2116
  1397
        } else {
deba@2189
  1398
          first_bnode = 
deba@2189
  1399
            bNodes[bNodeId].next != -1 ? bNodes[bNodeId].next >> 1 : -1;
deba@2116
  1400
        }
deba@2116
  1401
        if (bNodes[bNodeId].next != -1) {
deba@2116
  1402
          bNodes[bNodes[bNodeId].next >> 1].prev = bNodes[bNodeId].prev;
deba@2116
  1403
        }
deba@2116
  1404
        bNodes[bNodeId].next = first_free_bnode;
deba@2116
  1405
        first_free_bnode = bNodeId;
deba@2116
  1406
      }
deba@2116
  1407
    }
deba@2116
  1408
deba@2116
  1409
    void erase(const UEdge& edge) {
deba@2116
  1410
deba@2116
  1411
      if (edges[edge.id].prev_out != -1) {
deba@2116
  1412
        edges[edges[edge.id].prev_out].next_out = edges[edge.id].next_out;
deba@2116
  1413
      } else {
deba@2116
  1414
        aNodes[edges[edge.id].aNode >> 1].first_edge = edges[edge.id].next_out;
deba@2116
  1415
      }
deba@2116
  1416
      if (edges[edge.id].next_out != -1) {
deba@2116
  1417
        edges[edges[edge.id].next_out].prev_out = edges[edge.id].prev_out;
deba@2116
  1418
      }
deba@2116
  1419
deba@2116
  1420
      if (edges[edge.id].prev_in != -1) {
deba@2116
  1421
        edges[edges[edge.id].prev_in].next_in = edges[edge.id].next_in;
deba@2116
  1422
      } else {
deba@2116
  1423
        bNodes[edges[edge.id].bNode >> 1].first_edge = edges[edge.id].next_in;
deba@2116
  1424
      }
deba@2116
  1425
      if (edges[edge.id].next_in != -1) {
deba@2116
  1426
        edges[edges[edge.id].next_in].prev_in = edges[edge.id].prev_in;
deba@2116
  1427
      }
deba@2116
  1428
deba@2116
  1429
      edges[edge.id].next_out = first_free_edge;
deba@2116
  1430
      first_free_edge = edge.id;
deba@2116
  1431
    }
alpar@2128
  1432
 
deba@2116
  1433
    void clear() {
deba@2116
  1434
      aNodes.clear();
deba@2116
  1435
      bNodes.clear();
deba@2116
  1436
      edges.clear();
deba@2116
  1437
      first_anode = -1;
deba@2116
  1438
      first_free_anode = -1;
deba@2116
  1439
      first_bnode = -1;
deba@2116
  1440
      first_free_bnode = -1;
deba@2116
  1441
      first_free_edge = -1;
deba@2116
  1442
    }
deba@2116
  1443
deba@2160
  1444
    void changeANode(const UEdge& edge, const Node& node) {
deba@2160
  1445
      LEMON_ASSERT((node.id & 1) == 0, NodeSetError());
deba@2160
  1446
      if (edges[edge.id].prev_out != -1) {
deba@2160
  1447
        edges[edges[edge.id].prev_out].next_out = edges[edge.id].next_out;
deba@2160
  1448
      } else {
deba@2160
  1449
        aNodes[edges[edge.id].aNode >> 1].first_edge = edges[edge.id].next_out;
deba@2160
  1450
      }
deba@2160
  1451
      if (edges[edge.id].next_out != -1) {
deba@2160
  1452
        edges[edges[edge.id].next_out].prev_out = edges[edge.id].prev_out;  
deba@2160
  1453
      }
deba@2160
  1454
      if (aNodes[node.id >> 1].first_edge != -1) {
deba@2160
  1455
        edges[aNodes[node.id >> 1].first_edge].prev_out = edge.id;
deba@2160
  1456
      }
deba@2160
  1457
      edges[edge.id].prev_out = -1;
deba@2160
  1458
      edges[edge.id].next_out = aNodes[node.id >> 1].first_edge;
deba@2160
  1459
      aNodes[node.id >> 1].first_edge = edge.id;
deba@2160
  1460
      edges[edge.id].aNode = node.id;
deba@2160
  1461
    } 
deba@2160
  1462
deba@2160
  1463
    void changeBNode(const UEdge& edge, const Node& node) {
deba@2160
  1464
      LEMON_ASSERT((node.id & 1) == 1, NodeSetError());
deba@2160
  1465
      if (edges[edge.id].prev_in != -1) {
deba@2160
  1466
        edges[edges[edge.id].prev_in].next_in = edges[edge.id].next_in;
deba@2160
  1467
      } else {
deba@2160
  1468
        bNodes[edges[edge.id].bNode >> 1].first_edge = edges[edge.id].next_in;
deba@2160
  1469
      }
deba@2160
  1470
      if (edges[edge.id].next_in != -1) {
deba@2160
  1471
        edges[edges[edge.id].next_in].prev_in = edges[edge.id].prev_in;  
deba@2160
  1472
      }
deba@2160
  1473
      if (bNodes[node.id >> 1].first_edge != -1) {
deba@2160
  1474
        edges[bNodes[node.id >> 1].first_edge].prev_in = edge.id;
deba@2160
  1475
      }
deba@2160
  1476
      edges[edge.id].prev_in = -1;
deba@2160
  1477
      edges[edge.id].next_in = bNodes[node.id >> 1].first_edge;
deba@2160
  1478
      bNodes[node.id >> 1].first_edge = edge.id;
deba@2160
  1479
      edges[edge.id].bNode = node.id;
deba@2160
  1480
    } 
deba@2160
  1481
deba@2116
  1482
  };
deba@2116
  1483
deba@2116
  1484
deba@2116
  1485
  typedef BpUGraphExtender< ListBpUGraphBase > ExtendedListBpUGraphBase;
deba@2116
  1486
deba@2116
  1487
  /// \ingroup graphs
deba@2116
  1488
  ///
deba@2116
  1489
  /// \brief A smart bipartite undirected graph class.
deba@2116
  1490
  ///
deba@2116
  1491
  /// This is a bipartite undirected graph implementation.
alpar@2117
  1492
  /// It is conforms to the \ref concept::BpUGraph "BpUGraph concept".
deba@2116
  1493
  /// \sa concept::BpUGraph.
deba@2116
  1494
  ///
deba@2160
  1495
  class ListBpUGraph : public ExtendedListBpUGraphBase {
deba@2160
  1496
    /// \brief ListBpUGraph is \e not copy constructible.
deba@2160
  1497
    ///
deba@2160
  1498
    ///ListBpUGraph is \e not copy constructible.
deba@2160
  1499
    ListBpUGraph(const ListBpUGraph &) :ExtendedListBpUGraphBase()  {};
deba@2160
  1500
    /// \brief Assignment of ListBpUGraph to another one is \e not
deba@2160
  1501
    /// allowed.
deba@2160
  1502
    ///
deba@2160
  1503
    /// Assignment of ListBpUGraph to another one is \e not allowed.
deba@2160
  1504
    void operator=(const ListBpUGraph &) {}
deba@2160
  1505
  public:
deba@2160
  1506
    /// \brief Constructor
deba@2160
  1507
    ///    
deba@2160
  1508
    /// Constructor.
deba@2160
  1509
    ///
deba@2160
  1510
    ListBpUGraph() {}
deba@2160
  1511
deba@2160
  1512
    typedef ExtendedListBpUGraphBase Parent;
deba@2160
  1513
    /// \brief Add a new ANode to the graph.
deba@2160
  1514
    ///
deba@2160
  1515
    /// \return the new node.
deba@2160
  1516
    ///
deba@2160
  1517
    Node addANode() { return Parent::addANode(); }
deba@2160
  1518
deba@2160
  1519
    /// \brief Add a new BNode to the graph.
deba@2160
  1520
    ///
deba@2160
  1521
    /// \return the new node.
deba@2160
  1522
    ///
deba@2160
  1523
    Node addBNode() { return Parent::addBNode(); }
deba@2160
  1524
deba@2160
  1525
    /// \brief Add a new edge to the graph.
deba@2160
  1526
    ///
deba@2160
  1527
    /// Add a new edge to the graph with an ANode and a BNode.
deba@2160
  1528
    /// \return the new undirected edge.
deba@2160
  1529
    UEdge addEdge(const Node& s, const Node& t) { 
deba@2160
  1530
      return Parent::addEdge(s, t); 
deba@2160
  1531
    }
deba@2160
  1532
deba@2160
  1533
    /// \brief Changes the ANode of \c e to \c n
deba@2160
  1534
    ///
deba@2160
  1535
    /// Changes the ANode of \c e to \c n
deba@2160
  1536
    ///
deba@2160
  1537
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s referencing
deba@2160
  1538
    ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
deba@2160
  1539
    ///invalidated.
deba@2160
  1540
    void changeANode(UEdge e, Node n) { 
deba@2160
  1541
      Parent::changeANode(e,n); 
deba@2160
  1542
    }
deba@2160
  1543
deba@2160
  1544
    /// \brief Changes the BNode of \c e to \c n
deba@2160
  1545
    ///
deba@2160
  1546
    /// Changes the BNode of \c e to \c n
deba@2160
  1547
    ///
deba@2160
  1548
    /// \note The <tt>EdgeIt</tt>s and <tt>OutEdgeIt</tt>s
deba@2160
  1549
    /// referencing the changed edge remain
deba@2160
  1550
    /// valid. However <tt>InEdgeIt</tt>s are invalidated.
deba@2160
  1551
    void changeBNode(UEdge e, Node n) { 
deba@2160
  1552
      Parent::changeBNode(e,n); 
deba@2160
  1553
    }
deba@2160
  1554
deba@2160
  1555
    /// \brief Changes the source(ANode) of \c e to \c n
deba@2160
  1556
    ///
deba@2160
  1557
    /// Changes the source(ANode) of \c e to \c n
deba@2160
  1558
    ///
deba@2160
  1559
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s referencing
deba@2160
  1560
    ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
deba@2160
  1561
    ///invalidated.
deba@2160
  1562
    void changeSource(UEdge e, Node n) { 
deba@2160
  1563
      Parent::changeANode(e,n); 
deba@2160
  1564
    }
deba@2160
  1565
deba@2160
  1566
    /// \brief Changes the target(BNode) of \c e to \c n
deba@2160
  1567
    ///
deba@2160
  1568
    /// Changes the target(BNode) of \c e to \c n
deba@2160
  1569
    ///
deba@2160
  1570
    /// \note The <tt>EdgeIt</tt>s and <tt>OutEdgeIt</tt>s
deba@2160
  1571
    /// referencing the changed edge remain
deba@2160
  1572
    /// valid. However <tt>InEdgeIt</tt>s are invalidated.
deba@2160
  1573
    void changeTarget(UEdge e, Node n) { 
deba@2160
  1574
      Parent::changeBNode(e,n); 
deba@2160
  1575
    }
deba@2160
  1576
deba@2160
  1577
    /// \brief Changes the source of \c e to \c n
deba@2160
  1578
    ///
deba@2160
  1579
    /// Changes the source of \c e to \c n. It changes the proper
deba@2160
  1580
    /// node of the represented undirected edge.
deba@2160
  1581
    ///
deba@2160
  1582
    ///\note The <tt>EdgeIt</tt>s and <tt>InEdgeIt</tt>s
deba@2160
  1583
    ///referencing the changed edge remain
deba@2160
  1584
    ///valid. However <tt>OutEdgeIt</tt>s are invalidated.
deba@2160
  1585
    void changeSource(Edge e, Node n) { 
deba@2160
  1586
      if (Parent::direction(e)) {
deba@2160
  1587
        Parent::changeANode(e,n);
deba@2160
  1588
      } else {
deba@2160
  1589
        Parent::changeBNode(e,n);
deba@2160
  1590
      } 
deba@2160
  1591
    }
deba@2160
  1592
    /// \brief Changes the target of \c e to \c n
deba@2160
  1593
    ///
deba@2160
  1594
    /// Changes the target of \c e to \c n. It changes the proper
deba@2160
  1595
    /// node of the represented undirected edge.
deba@2160
  1596
    ///
deba@2160
  1597
    ///\note The <tt>EdgeIt</tt>s and <tt>OutEdgeIt</tt>s
deba@2160
  1598
    ///referencing the changed edge remain
deba@2160
  1599
    ///valid. However <tt>InEdgeIt</tt>s are invalidated.
deba@2160
  1600
    void changeTarget(Edge e, Node n) { 
deba@2160
  1601
      if (Parent::direction(e)) {
deba@2160
  1602
        Parent::changeBNode(e,n);
deba@2160
  1603
      } else {
deba@2160
  1604
        Parent::changeANode(e,n);
deba@2160
  1605
      } 
deba@2160
  1606
    }
deba@2160
  1607
    /// \brief Contract two nodes.
deba@2160
  1608
    ///
deba@2160
  1609
    /// This function contracts two nodes.
deba@2160
  1610
    ///
deba@2160
  1611
    /// Node \p b will be removed but instead of deleting its
deba@2160
  1612
    /// neighboring edges, they will be joined to \p a.  The two nodes
deba@2160
  1613
    /// should be from the same nodeset, of course.
deba@2160
  1614
    ///
deba@2160
  1615
    /// \note The <tt>EdgeIt</tt>s referencing a moved edge remain
deba@2160
  1616
    /// valid.
deba@2160
  1617
    void contract(const Node& a, const Node& b) {
deba@2160
  1618
      LEMON_ASSERT(Parent::aNode(a) == Parent::aNode(b), NodeSetError());
deba@2160
  1619
      if (Parent::aNode(a)) {
deba@2160
  1620
        for (IncEdgeIt e(*this, b); e!=INVALID;) {
deba@2160
  1621
          IncEdgeIt f = e; ++f;
deba@2160
  1622
          changeSource(e, a);
deba@2160
  1623
          e = f;
deba@2160
  1624
        }
deba@2160
  1625
      } else {
deba@2160
  1626
        for (IncEdgeIt e(*this, b); e!=INVALID;) {
deba@2160
  1627
          IncEdgeIt f = e; ++f;
deba@2160
  1628
          changeTarget(e, a);
deba@2160
  1629
          e = f;
deba@2160
  1630
        }
deba@2160
  1631
      }
deba@2160
  1632
      erase(b);
deba@2160
  1633
    }
deba@2160
  1634
deba@2189
  1635
    /// \brief Class to make a snapshot of the graph and restore
deba@2189
  1636
    /// to it later.
deba@2189
  1637
    ///
deba@2189
  1638
    /// Class to make a snapshot of the graph and to restore it
deba@2189
  1639
    /// later.
deba@2189
  1640
    ///
deba@2189
  1641
    /// The newly added nodes and undirected edges can be removed
deba@2189
  1642
    /// using the restore() function.
deba@2189
  1643
    ///
deba@2189
  1644
    /// \warning Edge and node deletions cannot be restored. This
deba@2189
  1645
    /// events invalidate the snapshot. 
deba@2189
  1646
    class Snapshot {
deba@2189
  1647
    protected:
deba@2189
  1648
deba@2189
  1649
      typedef Parent::NodeNotifier NodeNotifier;
deba@2189
  1650
deba@2189
  1651
      class NodeObserverProxy : public NodeNotifier::ObserverBase {
deba@2189
  1652
      public:
deba@2189
  1653
deba@2189
  1654
        NodeObserverProxy(Snapshot& _snapshot)
deba@2189
  1655
          : snapshot(_snapshot) {}
deba@2189
  1656
deba@2189
  1657
        using NodeNotifier::ObserverBase::attach;
deba@2189
  1658
        using NodeNotifier::ObserverBase::detach;
deba@2189
  1659
        using NodeNotifier::ObserverBase::attached;
deba@2189
  1660
        
deba@2189
  1661
      protected:
deba@2189
  1662
        
deba@2189
  1663
        virtual void add(const Node& node) {
deba@2189
  1664
          snapshot.addNode(node);
deba@2189
  1665
        }
deba@2189
  1666
        virtual void add(const std::vector<Node>& nodes) {
deba@2189
  1667
          for (int i = nodes.size() - 1; i >= 0; ++i) {
deba@2189
  1668
            snapshot.addNode(nodes[i]);
deba@2189
  1669
          }
deba@2189
  1670
        }
deba@2189
  1671
        virtual void erase(const Node& node) {
deba@2189
  1672
          snapshot.eraseNode(node);
deba@2189
  1673
        }
deba@2189
  1674
        virtual void erase(const std::vector<Node>& nodes) {
deba@2189
  1675
          for (int i = 0; i < (int)nodes.size(); ++i) {
deba@2189
  1676
            snapshot.eraseNode(nodes[i]);
deba@2189
  1677
          }
deba@2189
  1678
        }
deba@2189
  1679
        virtual void build() {
deba@2189
  1680
          NodeNotifier* notifier = getNotifier();
deba@2189
  1681
          Node node;
deba@2189
  1682
          std::vector<Node> nodes;
deba@2189
  1683
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2189
  1684
            nodes.push_back(node);
deba@2189
  1685
          }
deba@2189
  1686
          for (int i = nodes.size() - 1; i >= 0; --i) {
deba@2189
  1687
            snapshot.addNode(nodes[i]);
deba@2189
  1688
          }
deba@2189
  1689
        }
deba@2189
  1690
        virtual void clear() {
deba@2189
  1691
          NodeNotifier* notifier = getNotifier();
deba@2189
  1692
          Node node;
deba@2189
  1693
          for (notifier->first(node); node != INVALID; notifier->next(node)) {
deba@2189
  1694
            snapshot.eraseNode(node);
deba@2189
  1695
          }
deba@2189
  1696
        }
deba@2189
  1697
deba@2189
  1698
        Snapshot& snapshot;
deba@2189
  1699
      };
deba@2189
  1700
deba@2189
  1701
      class UEdgeObserverProxy : public UEdgeNotifier::ObserverBase {
deba@2189
  1702
      public:
deba@2189
  1703
deba@2189
  1704
        UEdgeObserverProxy(Snapshot& _snapshot)
deba@2189
  1705
          : snapshot(_snapshot) {}
deba@2189
  1706
deba@2189
  1707
        using UEdgeNotifier::ObserverBase::attach;
deba@2189
  1708
        using UEdgeNotifier::ObserverBase::detach;
deba@2189
  1709
        using UEdgeNotifier::ObserverBase::attached;
deba@2189
  1710
        
deba@2189
  1711
      protected:
deba@2189
  1712
deba@2189
  1713
        virtual void add(const UEdge& edge) {
deba@2189
  1714
          snapshot.addUEdge(edge);
deba@2189
  1715
        }
deba@2189
  1716
        virtual void add(const std::vector<UEdge>& edges) {
deba@2189
  1717
          for (int i = edges.size() - 1; i >= 0; ++i) {
deba@2189
  1718
            snapshot.addUEdge(edges[i]);
deba@2189
  1719
          }
deba@2189
  1720
        }
deba@2189
  1721
        virtual void erase(const UEdge& edge) {
deba@2189
  1722
          snapshot.eraseUEdge(edge);
deba@2189
  1723
        }
deba@2189
  1724
        virtual void erase(const std::vector<UEdge>& edges) {
deba@2189
  1725
          for (int i = 0; i < (int)edges.size(); ++i) {
deba@2189
  1726
            snapshot.eraseUEdge(edges[i]);
deba@2189
  1727
          }
deba@2189
  1728
        }
deba@2189
  1729
        virtual void build() {
deba@2189
  1730
          UEdgeNotifier* notifier = getNotifier();
deba@2189
  1731
          UEdge edge;
deba@2189
  1732
          std::vector<UEdge> edges;
deba@2189
  1733
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2189
  1734
            edges.push_back(edge);
deba@2189
  1735
          }
deba@2189
  1736
          for (int i = edges.size() - 1; i >= 0; --i) {
deba@2189
  1737
            snapshot.addUEdge(edges[i]);
deba@2189
  1738
          }
deba@2189
  1739
        }
deba@2189
  1740
        virtual void clear() {
deba@2189
  1741
          UEdgeNotifier* notifier = getNotifier();
deba@2189
  1742
          UEdge edge;
deba@2189
  1743
          for (notifier->first(edge); edge != INVALID; notifier->next(edge)) {
deba@2189
  1744
            snapshot.eraseUEdge(edge);
deba@2189
  1745
          }
deba@2189
  1746
        }
deba@2189
  1747
deba@2189
  1748
        Snapshot& snapshot;
deba@2189
  1749
      };
deba@2189
  1750
      
deba@2189
  1751
      ListBpUGraph *graph;
deba@2189
  1752
deba@2189
  1753
      NodeObserverProxy node_observer_proxy;
deba@2189
  1754
      UEdgeObserverProxy edge_observer_proxy;
deba@2189
  1755
deba@2189
  1756
      std::list<Node> added_nodes;
deba@2189
  1757
      std::list<UEdge> added_edges;
deba@2189
  1758
deba@2189
  1759
deba@2189
  1760
      void addNode(const Node& node) {
deba@2189
  1761
        added_nodes.push_front(node);        
deba@2189
  1762
      }
deba@2189
  1763
      void eraseNode(const Node& node) {
deba@2189
  1764
        std::list<Node>::iterator it = 
deba@2189
  1765
          std::find(added_nodes.begin(), added_nodes.end(), node);
deba@2189
  1766
        if (it == added_nodes.end()) {
deba@2189
  1767
          clear();
deba@2189
  1768
          edge_observer_proxy.detach();
deba@2189
  1769
          throw NodeNotifier::ImmediateDetach();
deba@2189
  1770
        } else {
deba@2189
  1771
          added_nodes.erase(it);
deba@2189
  1772
        }
deba@2189
  1773
      }
deba@2189
  1774
deba@2189
  1775
      void addUEdge(const UEdge& edge) {
deba@2189
  1776
        added_edges.push_front(edge);        
deba@2189
  1777
      }
deba@2189
  1778
      void eraseUEdge(const UEdge& edge) {
deba@2189
  1779
        std::list<UEdge>::iterator it = 
deba@2189
  1780
          std::find(added_edges.begin(), added_edges.end(), edge);
deba@2189
  1781
        if (it == added_edges.end()) {
deba@2189
  1782
          clear();
deba@2189
  1783
          node_observer_proxy.detach();
deba@2189
  1784
          throw UEdgeNotifier::ImmediateDetach();
deba@2189
  1785
        } else {
deba@2189
  1786
          added_edges.erase(it);
deba@2189
  1787
        }        
deba@2189
  1788
      }
deba@2189
  1789
deba@2189
  1790
      void attach(ListBpUGraph &_graph) {
deba@2189
  1791
	graph = &_graph;
deba@2189
  1792
	node_observer_proxy.attach(graph->getNotifier(Node()));
deba@2189
  1793
        edge_observer_proxy.attach(graph->getNotifier(UEdge()));
deba@2189
  1794
      }
deba@2189
  1795
            
deba@2189
  1796
      void detach() {
deba@2189
  1797
	node_observer_proxy.detach();
deba@2189
  1798
	edge_observer_proxy.detach();
deba@2189
  1799
      }
deba@2189
  1800
deba@2189
  1801
      bool attached() const {
deba@2189
  1802
        return node_observer_proxy.attached();
deba@2189
  1803
      }
deba@2189
  1804
deba@2189
  1805
      void clear() {
deba@2189
  1806
        added_nodes.clear();
deba@2189
  1807
        added_edges.clear();        
deba@2189
  1808
      }
deba@2189
  1809
deba@2189
  1810
    public:
deba@2189
  1811
deba@2189
  1812
      /// \brief Default constructor.
deba@2189
  1813
      ///
deba@2189
  1814
      /// Default constructor.
deba@2189
  1815
      /// To actually make a snapshot you must call save().
deba@2189
  1816
      Snapshot() 
deba@2189
  1817
        : graph(0), node_observer_proxy(*this), 
deba@2189
  1818
          edge_observer_proxy(*this) {}
deba@2189
  1819
      
deba@2189
  1820
      /// \brief Constructor that immediately makes a snapshot.
deba@2189
  1821
      ///      
deba@2189
  1822
      /// This constructor immediately makes a snapshot of the graph.
deba@2189
  1823
      /// \param _graph The graph we make a snapshot of.
deba@2189
  1824
      Snapshot(ListBpUGraph &_graph) 
deba@2189
  1825
        : node_observer_proxy(*this), 
deba@2189
  1826
          edge_observer_proxy(*this) {
deba@2189
  1827
	attach(_graph);
deba@2189
  1828
      }
deba@2189
  1829
      
deba@2189
  1830
      /// \brief Make a snapshot.
deba@2189
  1831
      ///
deba@2189
  1832
      /// Make a snapshot of the graph.
deba@2189
  1833
      ///
deba@2189
  1834
      /// This function can be called more than once. In case of a repeated
deba@2189
  1835
      /// call, the previous snapshot gets lost.
deba@2189
  1836
      /// \param _graph The graph we make the snapshot of.
deba@2189
  1837
      void save(ListBpUGraph &_graph) {
deba@2189
  1838
        if (attached()) {
deba@2189
  1839
          detach();
deba@2189
  1840
          clear();
deba@2189
  1841
        }
deba@2189
  1842
        attach(_graph);
deba@2189
  1843
      }
deba@2189
  1844
      
deba@2189
  1845
      /// \brief Undo the changes until the last snapshot.
deba@2189
  1846
      // 
deba@2189
  1847
      /// Undo the changes until the last snapshot created by save().
deba@2189
  1848
      void restore() {
deba@2189
  1849
	detach();
deba@2189
  1850
	for(std::list<UEdge>::iterator it = added_edges.begin(); 
deba@2189
  1851
            it != added_edges.end(); ++it) {
deba@2189
  1852
	  graph->erase(*it);
deba@2189
  1853
	}
deba@2189
  1854
	for(std::list<Node>::iterator it = added_nodes.begin(); 
deba@2189
  1855
            it != added_nodes.end(); ++it) {
deba@2189
  1856
	  graph->erase(*it);
deba@2189
  1857
	}
deba@2189
  1858
        clear();
deba@2189
  1859
      }
deba@2189
  1860
deba@2189
  1861
      /// \brief Gives back true when the snapshot is valid.
deba@2189
  1862
      ///
deba@2189
  1863
      /// Gives back true when the snapshot is valid.
deba@2189
  1864
      bool valid() const {
deba@2189
  1865
        return attached();
deba@2189
  1866
      }
deba@2189
  1867
    };
deba@2160
  1868
  };
deba@2116
  1869
deba@2116
  1870
  
deba@2116
  1871
  /// @}  
alpar@948
  1872
} //namespace lemon
klao@946
  1873
  
alpar@400
  1874
klao@946
  1875
#endif