lemon/smart_graph.h
author alpar
Fri, 20 Oct 2006 12:05:54 +0000
changeset 2256 b22dfb6c5ff3
parent 2231 06faf3f06d67
child 2260 4274224f8a7d
permissions -rw-r--r--
Graph imlementations actually provide ReferenceMaps.
alpar@906
     1
/* -*- C++ -*-
alpar@906
     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@906
     8
 *
alpar@906
     9
 * Permission to use, modify and distribute this software is granted
alpar@906
    10
 * provided that this copyright notice appears in all copies. For
alpar@906
    11
 * precise terms see the accompanying LICENSE file.
alpar@906
    12
 *
alpar@906
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@906
    14
 * express or implied, and with no claim as to its suitability for any
alpar@906
    15
 * purpose.
alpar@906
    16
 *
alpar@906
    17
 */
alpar@105
    18
alpar@921
    19
#ifndef LEMON_SMART_GRAPH_H
alpar@921
    20
#define LEMON_SMART_GRAPH_H
alpar@104
    21
klao@491
    22
///\ingroup graphs
alpar@242
    23
///\file
deba@2116
    24
///\brief SmartGraph and SmartUGraph classes.
alpar@242
    25
alpar@104
    26
#include <vector>
alpar@104
    27
deba@1993
    28
#include <lemon/bits/invalid.h>
alpar@157
    29
deba@2116
    30
#include <lemon/bits/base_extender.h>
deba@1791
    31
#include <lemon/bits/graph_extender.h>
klao@1034
    32
deba@1993
    33
#include <lemon/bits/utility.h>
deba@2116
    34
#include <lemon/error.h>
deba@782
    35
deba@1979
    36
#include <lemon/bits/graph_extender.h>
deba@1979
    37
alpar@921
    38
namespace lemon {
alpar@104
    39
alpar@973
    40
  class SmartGraph;
alpar@969
    41
  ///Base of SmartGraph
alpar@969
    42
alpar@969
    43
  ///Base of SmartGraph
alpar@969
    44
  ///
klao@946
    45
  class SmartGraphBase {
deba@2190
    46
  protected:
alpar@104
    47
alpar@104
    48
    struct NodeT 
alpar@104
    49
    {
deba@2190
    50
      int first_in, first_out;      
deba@2190
    51
      NodeT() {}
alpar@104
    52
    };
alpar@104
    53
    struct EdgeT 
alpar@104
    54
    {
alpar@986
    55
      int target, source, next_in, next_out;      
deba@2190
    56
      EdgeT() {}  
alpar@104
    57
    };
alpar@104
    58
alpar@104
    59
    std::vector<NodeT> nodes;
alpar@129
    60
alpar@104
    61
    std::vector<EdgeT> edges;
alpar@104
    62
    
alpar@185
    63
    
alpar@104
    64
  public:
deba@782
    65
klao@946
    66
    typedef SmartGraphBase Graph;
alpar@104
    67
alpar@164
    68
    class Node;
alpar@164
    69
    class Edge;
alpar@108
    70
alpar@104
    71
    
alpar@104
    72
  public:
alpar@104
    73
klao@946
    74
    SmartGraphBase() : nodes(), edges() { }
deba@1718
    75
    SmartGraphBase(const SmartGraphBase &_g) 
deba@1718
    76
      : nodes(_g.nodes), edges(_g.edges) { }
alpar@104
    77
    
klao@977
    78
    typedef True NodeNumTag;
klao@977
    79
    typedef True EdgeNumTag;
klao@977
    80
alpar@813
    81
    int nodeNum() const { return nodes.size(); }
alpar@813
    82
    int edgeNum() const { return edges.size(); }
alpar@104
    83
deba@1791
    84
    int maxNodeId() const { return nodes.size()-1; }
deba@1791
    85
    int maxEdgeId() const { return edges.size()-1; }
alpar@108
    86
alpar@2128
    87
    Node addNode() {
deba@2190
    88
      int n = nodes.size();     
deba@2190
    89
      nodes.push_back(NodeT());
deba@2190
    90
      nodes[n].first_in = -1;
deba@2190
    91
      nodes[n].first_out = -1;
deba@2190
    92
      return Node(n);
alpar@2128
    93
    }
alpar@2128
    94
    
alpar@2128
    95
    Edge addEdge(Node u, Node v) {
deba@2190
    96
      int n = edges.size(); 
deba@2190
    97
      edges.push_back(EdgeT());
deba@2190
    98
      edges[n].source = u.id; 
deba@2190
    99
      edges[n].target = v.id;
deba@2190
   100
      edges[n].next_out = nodes[u.id].first_out;
deba@2190
   101
      edges[n].next_in = nodes[v.id].first_in;
deba@2190
   102
      nodes[u.id].first_out = nodes[v.id].first_in = n;
alpar@2128
   103
deba@2190
   104
      return Edge(n);
alpar@2128
   105
    }
alpar@2128
   106
deba@2190
   107
    void clear() {
deba@2190
   108
      edges.clear();
deba@2190
   109
      nodes.clear();
deba@2190
   110
    }
alpar@2128
   111
deba@2190
   112
    Node source(Edge e) const { return Node(edges[e.id].source); }
deba@2190
   113
    Node target(Edge e) const { return Node(edges[e.id].target); }
alpar@104
   114
deba@2190
   115
    static int id(Node v) { return v.id; }
deba@2190
   116
    static int id(Edge e) { return e.id; }
alpar@104
   117
deba@1791
   118
    static Node nodeFromId(int id) { return Node(id);}
deba@1791
   119
    static Edge edgeFromId(int id) { return Edge(id);}
deba@1106
   120
alpar@164
   121
    class Node {
klao@946
   122
      friend class SmartGraphBase;
alpar@973
   123
      friend class SmartGraph;
alpar@104
   124
alpar@104
   125
    protected:
deba@2190
   126
      int id;
deba@2190
   127
      explicit Node(int _id) : id(_id) {}
alpar@104
   128
    public:
alpar@164
   129
      Node() {}
deba@2190
   130
      Node (Invalid) : id(-1) {}
deba@2190
   131
      bool operator==(const Node i) const {return id == i.id;}
deba@2190
   132
      bool operator!=(const Node i) const {return id != i.id;}
deba@2190
   133
      bool operator<(const Node i) const {return id < i.id;}
alpar@104
   134
    };
alpar@104
   135
    
alpar@104
   136
alpar@164
   137
    class Edge {
klao@946
   138
      friend class SmartGraphBase;
alpar@973
   139
      friend class SmartGraph;
alpar@185
   140
alpar@104
   141
    protected:
deba@2190
   142
      int id;
deba@2190
   143
      explicit Edge(int _id) : id(_id) {}
alpar@706
   144
    public:
alpar@164
   145
      Edge() { }
deba@2190
   146
      Edge (Invalid) : id(-1) {}
deba@2190
   147
      bool operator==(const Edge i) const {return id == i.id;}
deba@2190
   148
      bool operator!=(const Edge i) const {return id != i.id;}
deba@2190
   149
      bool operator<(const Edge i) const {return id < i.id;}
klao@946
   150
    };
alpar@905
   151
klao@946
   152
    void first(Node& node) const {
deba@2190
   153
      node.id = nodes.size() - 1;
klao@946
   154
    }
klao@946
   155
klao@946
   156
    static void next(Node& node) {
deba@2190
   157
      --node.id;
klao@946
   158
    }
klao@946
   159
klao@946
   160
    void first(Edge& edge) const {
deba@2190
   161
      edge.id = edges.size() - 1;
klao@946
   162
    }
klao@946
   163
klao@946
   164
    static void next(Edge& edge) {
deba@2190
   165
      --edge.id;
klao@946
   166
    }
klao@946
   167
klao@946
   168
    void firstOut(Edge& edge, const Node& node) const {
deba@2190
   169
      edge.id = nodes[node.id].first_out;
klao@946
   170
    }
klao@946
   171
klao@946
   172
    void nextOut(Edge& edge) const {
deba@2190
   173
      edge.id = edges[edge.id].next_out;
klao@946
   174
    }
klao@946
   175
klao@946
   176
    void firstIn(Edge& edge, const Node& node) const {
deba@2190
   177
      edge.id = nodes[node.id].first_in;
klao@946
   178
    }
alpar@104
   179
    
klao@946
   180
    void nextIn(Edge& edge) const {
deba@2190
   181
      edge.id = edges[edge.id].next_in;
klao@946
   182
    }
alpar@105
   183
alpar@104
   184
  };
alpar@185
   185
deba@1979
   186
  typedef GraphExtender<SmartGraphBase> ExtendedSmartGraphBase;
deba@937
   187
deba@1791
   188
  /// \ingroup graphs
alpar@1161
   189
alpar@950
   190
  ///A smart graph class.
deba@937
   191
alpar@950
   192
  ///This is a simple and fast graph implementation.
alpar@950
   193
  ///It is also quite memory efficient, but at the price
alpar@974
   194
  ///that <b> it does support only limited (only stack-like)
alpar@974
   195
  ///node and edge deletions</b>.
alpar@950
   196
  ///It conforms to 
alpar@2256
   197
  ///the \ref concept::Graph "Graph concept" with an
alpar@2256
   198
  ///important extra feature that
alpar@2256
   199
  ///its maps are real \ref concept::ReferenceMap "reference map"s.
alpar@2256
   200
  ///
deba@2111
   201
  ///\sa concept::Graph.
alpar@950
   202
  ///
alpar@950
   203
  ///\author Alpar Juttner
deba@1669
   204
  class SmartGraph : public ExtendedSmartGraphBase {
alpar@969
   205
  public:
deba@1979
   206
deba@1979
   207
    typedef ExtendedSmartGraphBase Parent;
deba@1979
   208
deba@2190
   209
  private:
alpar@973
   210
alpar@2128
   211
    ///SmartGraph is \e not copy constructible. Use GraphCopy() instead.
alpar@2128
   212
alpar@2128
   213
    ///SmartGraph is \e not copy constructible. Use GraphCopy() instead.
alpar@2128
   214
    ///
deba@2190
   215
    SmartGraph(const SmartGraph &) : ExtendedSmartGraphBase() {};
alpar@2132
   216
    ///\brief Assignment of SmartGraph to another one is \e not allowed.
alpar@2128
   217
    ///Use GraphCopy() instead.
alpar@2128
   218
alpar@2132
   219
    ///Assignment of SmartGraph to another one is \e not allowed.
alpar@2128
   220
    ///Use GraphCopy() instead.
alpar@2128
   221
    void operator=(const SmartGraph &) {}
alpar@1011
   222
alpar@1011
   223
  public:
alpar@2128
   224
    
alpar@2128
   225
    /// Constructor
alpar@2128
   226
    
alpar@2128
   227
    /// Constructor.
alpar@2128
   228
    ///
alpar@2128
   229
    SmartGraph() {};
alpar@2128
   230
    
alpar@2128
   231
    ///Add a new node to the graph.
alpar@2128
   232
    
alpar@2128
   233
    /// \return the new node.
alpar@2128
   234
    ///
alpar@2128
   235
    Node addNode() { return Parent::addNode(); }
alpar@2128
   236
    
alpar@2128
   237
    ///Add a new edge to the graph.
alpar@2128
   238
    
alpar@2128
   239
    ///Add a new edge to the graph with source node \c s
alpar@2128
   240
    ///and target node \c t.
alpar@2128
   241
    ///\return the new edge.
alpar@2128
   242
    Edge addEdge(const Node& s, const Node& t) { 
alpar@2128
   243
      return Parent::addEdge(s, t); 
alpar@2128
   244
    }
alpar@2128
   245
deba@2190
   246
    ///Clear the graph.
alpar@2128
   247
    
deba@2190
   248
    ///Erase all the nodes and edges from the graph.
deba@2190
   249
    ///
alpar@2128
   250
    void clear() {
deba@2190
   251
      Parent::clear();
alpar@2128
   252
    }
alpar@1284
   253
alpar@1284
   254
    ///Split a node.
alpar@1284
   255
    
alpar@1284
   256
    ///This function splits a node. First a new node is added to the graph,
alpar@1284
   257
    ///then the source of each outgoing edge of \c n is moved to this new node.
alpar@1284
   258
    ///If \c connect is \c true (this is the default value), then a new edge
alpar@1284
   259
    ///from \c n to the newly created node is also added.
alpar@1284
   260
    ///\return The newly created node.
alpar@1284
   261
    ///
alpar@1284
   262
    ///\note The <tt>Edge</tt>s
alpar@1284
   263
    ///referencing a moved edge remain
alpar@1284
   264
    ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
alpar@1284
   265
    ///may be invalidated.
alpar@1770
   266
    ///\warning This functionality cannot be used together with the Snapshot
alpar@1284
   267
    ///feature.
alpar@1284
   268
    ///\todo It could be implemented in a bit faster way.
alpar@2128
   269
    Node split(Node n, bool connect = true)
alpar@1284
   270
    {
alpar@2128
   271
      Node b = addNode();
deba@2190
   272
      nodes[b.id].first_out=nodes[n.id].first_out;
deba@2190
   273
      nodes[n.id].first_out=-1;
deba@2190
   274
      for(int i=nodes[b.id].first_out;i!=-1;i++) edges[i].source=b.id;
alpar@2128
   275
      if(connect) addEdge(n,b);
deba@1718
   276
      return b;
alpar@1284
   277
    }
alpar@1284
   278
deba@2190
   279
  public:
deba@2190
   280
    
deba@2190
   281
    class Snapshot;
deba@2190
   282
deba@2190
   283
  protected:
deba@2190
   284
deba@2190
   285
    void restoreSnapshot(const Snapshot &s)
deba@2190
   286
    {
deba@2190
   287
      while(s.edge_num<edges.size()) {
deba@2190
   288
        Edge edge = edgeFromId(edges.size()-1);
deba@2190
   289
	Parent::getNotifier(Edge()).erase(edge);
deba@2190
   290
	nodes[edges.back().source].first_out=edges.back().next_out;
deba@2190
   291
	nodes[edges.back().target].first_in=edges.back().next_in;
deba@2190
   292
	edges.pop_back();
deba@2190
   293
      }
deba@2190
   294
      while(s.node_num<nodes.size()) {
deba@2190
   295
        Node node = nodeFromId(nodes.size()-1);
deba@2190
   296
	Parent::getNotifier(Node()).erase(node);
deba@2190
   297
	nodes.pop_back();
deba@2190
   298
      }
deba@2190
   299
    }    
deba@2190
   300
deba@2190
   301
  public:
deba@2190
   302
alpar@1011
   303
    ///Class to make a snapshot of the graph and to restrore to it later.
alpar@1011
   304
alpar@1011
   305
    ///Class to make a snapshot of the graph and to restrore to it later.
alpar@1011
   306
    ///
alpar@1011
   307
    ///The newly added nodes and edges can be removed using the
alpar@1011
   308
    ///restore() function.
alpar@1011
   309
    ///\note After you restore a state, you cannot restore
alpar@1011
   310
    ///a later state, in other word you cannot add again the edges deleted
alpar@2132
   311
    ///by restore() using another one Snapshot instance.
alpar@1011
   312
    ///
deba@2190
   313
    ///\warning If you do not use correctly the snapshot that can cause
deba@2190
   314
    ///either broken program, invalid state of the graph, valid but
deba@2190
   315
    ///not the restored graph or no change. Because the runtime performance
deba@2190
   316
    ///the validity of the snapshot is not stored.
alpar@1770
   317
    class Snapshot 
alpar@1011
   318
    {
alpar@1011
   319
      SmartGraph *g;
alpar@1011
   320
    protected:
alpar@1011
   321
      friend class SmartGraph;
alpar@1011
   322
      unsigned int node_num;
alpar@1011
   323
      unsigned int edge_num;
alpar@1011
   324
    public:
zsuzska@1274
   325
      ///Default constructor.
alpar@1011
   326
      
zsuzska@1274
   327
      ///Default constructor.
alpar@1011
   328
      ///To actually make a snapshot you must call save().
alpar@1011
   329
      ///
alpar@1770
   330
      Snapshot() : g(0) {}
alpar@1011
   331
      ///Constructor that immediately makes a snapshot
alpar@1011
   332
      
alpar@1011
   333
      ///This constructor immediately makes a snapshot of the graph.
alpar@1011
   334
      ///\param _g The graph we make a snapshot of.
alpar@1770
   335
      Snapshot(SmartGraph &_g) :g(&_g) {
alpar@1011
   336
	node_num=g->nodes.size();
alpar@1011
   337
	edge_num=g->edges.size();
alpar@1011
   338
      }
alpar@1011
   339
alpar@1011
   340
      ///Make a snapshot.
alpar@1011
   341
alpar@1011
   342
      ///Make a snapshot of the graph.
alpar@1011
   343
      ///
alpar@1011
   344
      ///This function can be called more than once. In case of a repeated
alpar@1011
   345
      ///call, the previous snapshot gets lost.
alpar@1011
   346
      ///\param _g The graph we make the snapshot of.
alpar@1011
   347
      void save(SmartGraph &_g) 
alpar@1011
   348
      {
alpar@1011
   349
	g=&_g;
alpar@1011
   350
	node_num=g->nodes.size();
alpar@1011
   351
	edge_num=g->edges.size();
alpar@1011
   352
      }
alpar@1011
   353
alpar@1011
   354
      ///Undo the changes until a snapshot.
alpar@1011
   355
      
alpar@1011
   356
      ///Undo the changes until a snapshot created by save().
alpar@1011
   357
      ///
alpar@1011
   358
      ///\note After you restored a state, you cannot restore
alpar@1011
   359
      ///a later state, in other word you cannot add again the edges deleted
alpar@1011
   360
      ///by restore().
alpar@1011
   361
      void restore()
alpar@1011
   362
      {
alpar@1770
   363
	g->restoreSnapshot(*this);
alpar@1011
   364
      }
alpar@1011
   365
    };
alpar@973
   366
  };
klao@1034
   367
klao@1034
   368
deba@2116
   369
  /**************** Undirected List Graph ****************/
deba@2116
   370
deba@2116
   371
  typedef UGraphExtender<UndirGraphExtender<SmartGraphBase> >
deba@2116
   372
  ExtendedSmartUGraphBase;
deba@2116
   373
deba@2116
   374
  /// \ingroup graphs
deba@2116
   375
  ///
deba@2116
   376
  /// \brief A smart undirected graph class.
deba@2116
   377
  ///
deba@2116
   378
  /// This is a simple and fast undirected graph implementation.
deba@2116
   379
  /// It is also quite memory efficient, but at the price
deba@2116
   380
  /// that <b> it does support only limited (only stack-like)
deba@2116
   381
  /// node and edge deletions</b>.
deba@2116
   382
  /// Except from this it conforms to 
alpar@2123
   383
  /// the \ref concept::UGraph "UGraph concept".
alpar@2256
   384
  ///
alpar@2256
   385
  ///It also has an
alpar@2256
   386
  ///important extra feature that
alpar@2256
   387
  ///its maps are real \ref concept::ReferenceMap "reference map"s.
alpar@2256
   388
  ///
deba@2116
   389
  /// \sa concept::UGraph.
deba@2116
   390
  ///
deba@2116
   391
  /// \todo Snapshot hasn't been implemented yet.
deba@2116
   392
  ///
deba@2116
   393
  class SmartUGraph : public ExtendedSmartUGraphBase {
alpar@2128
   394
  private:
deba@2190
   395
alpar@2128
   396
    ///SmartUGraph is \e not copy constructible. Use UGraphCopy() instead.
alpar@2128
   397
alpar@2128
   398
    ///SmartUGraph is \e not copy constructible. Use UGraphCopy() instead.
alpar@2128
   399
    ///
alpar@2128
   400
    SmartUGraph(const SmartUGraph &) : ExtendedSmartUGraphBase() {};
deba@2190
   401
alpar@2132
   402
    ///\brief Assignment of SmartUGraph to another one is \e not allowed.
alpar@2128
   403
    ///Use UGraphCopy() instead.
alpar@2128
   404
alpar@2132
   405
    ///Assignment of SmartUGraph to another one is \e not allowed.
alpar@2128
   406
    ///Use UGraphCopy() instead.
alpar@2128
   407
    void operator=(const SmartUGraph &) {}
deba@2190
   408
alpar@2128
   409
  public:
deba@2190
   410
deba@2190
   411
    typedef ExtendedSmartUGraphBase Parent;
deba@2190
   412
alpar@2128
   413
    /// Constructor
alpar@2128
   414
    
alpar@2128
   415
    /// Constructor.
alpar@2128
   416
    ///
alpar@2128
   417
    SmartUGraph() {}
deba@2190
   418
deba@2190
   419
    ///Add a new node to the graph.
deba@2190
   420
    
deba@2190
   421
    /// \return the new node.
deba@2190
   422
    ///
deba@2190
   423
    Node addNode() { return Parent::addNode(); }
deba@2190
   424
    
deba@2190
   425
    ///Add a new undirected edge to the graph.
deba@2190
   426
    
deba@2190
   427
    ///Add a new undirected edge to the graph with node \c s
deba@2190
   428
    ///and \c t.
deba@2190
   429
    ///\return the new undirected edge.
deba@2190
   430
    UEdge addEdge(const Node& s, const Node& t) { 
deba@2190
   431
      return Parent::addEdge(s, t); 
deba@2190
   432
    }
deba@2190
   433
deba@2190
   434
    ///Clear the graph.
deba@2190
   435
    
deba@2190
   436
    ///Erase all the nodes and edges from the graph.
deba@2190
   437
    ///
deba@2190
   438
    void clear() {
deba@2190
   439
      Parent::clear();
deba@2190
   440
    }
deba@2190
   441
deba@2190
   442
  public:
deba@2190
   443
    
deba@2190
   444
    class Snapshot;
deba@2190
   445
deba@2190
   446
  protected:
deba@2190
   447
deba@2190
   448
deba@2190
   449
    void restoreSnapshot(const Snapshot &s)
deba@2190
   450
    {
deba@2190
   451
      while(s.edge_num<edges.size()) {
deba@2190
   452
        UEdge edge = uEdgeFromId(edges.size()-1);
deba@2190
   453
	Parent::getNotifier(UEdge()).erase(edge);
deba@2190
   454
        std::vector<Edge> dir;
deba@2190
   455
        dir.push_back(Parent::direct(edge, true));
deba@2190
   456
        dir.push_back(Parent::direct(edge, false));
deba@2190
   457
	Parent::getNotifier(Edge()).erase(dir);
deba@2190
   458
	nodes[edges.back().source].first_out=edges.back().next_out;
deba@2190
   459
	nodes[edges.back().target].first_in=edges.back().next_in;
deba@2190
   460
	edges.pop_back();
deba@2190
   461
      }
deba@2190
   462
      while(s.node_num<nodes.size()) {
deba@2190
   463
        Node node = nodeFromId(nodes.size()-1);
deba@2190
   464
	Parent::getNotifier(Node()).erase(node);
deba@2190
   465
	nodes.pop_back();
deba@2190
   466
      }
deba@2190
   467
    }    
deba@2190
   468
deba@2190
   469
  public:
deba@2190
   470
deba@2190
   471
    ///Class to make a snapshot of the graph and to restrore to it later.
deba@2190
   472
deba@2190
   473
    ///Class to make a snapshot of the graph and to restrore to it later.
deba@2190
   474
    ///
deba@2190
   475
    ///The newly added nodes and edges can be removed using the
deba@2190
   476
    ///restore() function.
deba@2190
   477
    ///
deba@2190
   478
    ///\note After you restore a state, you cannot restore
deba@2190
   479
    ///a later state, in other word you cannot add again the edges deleted
deba@2190
   480
    ///by restore() using another one Snapshot instance.
deba@2190
   481
    ///
deba@2190
   482
    ///\warning If you do not use correctly the snapshot that can cause
deba@2190
   483
    ///either broken program, invalid state of the graph, valid but
deba@2190
   484
    ///not the restored graph or no change. Because the runtime performance
deba@2190
   485
    ///the validity of the snapshot is not stored.
deba@2190
   486
    class Snapshot 
deba@2190
   487
    {
deba@2190
   488
      SmartUGraph *g;
deba@2190
   489
    protected:
deba@2190
   490
      friend class SmartUGraph;
deba@2190
   491
      unsigned int node_num;
deba@2190
   492
      unsigned int edge_num;
deba@2190
   493
    public:
deba@2190
   494
      ///Default constructor.
deba@2190
   495
      
deba@2190
   496
      ///Default constructor.
deba@2190
   497
      ///To actually make a snapshot you must call save().
deba@2190
   498
      ///
deba@2190
   499
      Snapshot() : g(0) {}
deba@2190
   500
      ///Constructor that immediately makes a snapshot
deba@2190
   501
      
deba@2190
   502
      ///This constructor immediately makes a snapshot of the graph.
deba@2190
   503
      ///\param _g The graph we make a snapshot of.
deba@2190
   504
      Snapshot(SmartUGraph &_g) :g(&_g) {
deba@2190
   505
	node_num=g->nodes.size();
deba@2190
   506
	edge_num=g->edges.size();
deba@2190
   507
      }
deba@2190
   508
deba@2190
   509
      ///Make a snapshot.
deba@2190
   510
deba@2190
   511
      ///Make a snapshot of the graph.
deba@2190
   512
      ///
deba@2190
   513
      ///This function can be called more than once. In case of a repeated
deba@2190
   514
      ///call, the previous snapshot gets lost.
deba@2190
   515
      ///\param _g The graph we make the snapshot of.
deba@2190
   516
      void save(SmartUGraph &_g) 
deba@2190
   517
      {
deba@2190
   518
	g=&_g;
deba@2190
   519
	node_num=g->nodes.size();
deba@2190
   520
	edge_num=g->edges.size();
deba@2190
   521
      }
deba@2190
   522
deba@2190
   523
      ///Undo the changes until a snapshot.
deba@2190
   524
      
deba@2190
   525
      ///Undo the changes until a snapshot created by save().
deba@2190
   526
      ///
deba@2190
   527
      ///\note After you restored a state, you cannot restore
deba@2190
   528
      ///a later state, in other word you cannot add again the edges deleted
deba@2190
   529
      ///by restore().
deba@2190
   530
      void restore()
deba@2190
   531
      {
deba@2190
   532
	g->restoreSnapshot(*this);
deba@2190
   533
      }
deba@2190
   534
    };
deba@2116
   535
  };
deba@2116
   536
deba@2116
   537
deba@2116
   538
  class SmartBpUGraphBase {
deba@2116
   539
  public:
deba@2116
   540
deba@2116
   541
    class NodeSetError : public LogicError {
deba@2162
   542
    public:
alpar@2151
   543
      virtual const char* what() const throw() { 
deba@2116
   544
	return "lemon::SmartBpUGraph::NodeSetError";
deba@2116
   545
      }
deba@2116
   546
    };
deba@2116
   547
deba@2116
   548
  protected:
deba@2116
   549
deba@2116
   550
    struct NodeT {
deba@2116
   551
      int first;
deba@2116
   552
      NodeT() {}
deba@2116
   553
      NodeT(int _first) : first(_first) {}
deba@2116
   554
    };
deba@2116
   555
deba@2116
   556
    struct UEdgeT {
deba@2116
   557
      int aNode, next_out;
deba@2116
   558
      int bNode, next_in;
deba@2116
   559
    };
deba@2116
   560
deba@2116
   561
    std::vector<NodeT> aNodes;
deba@2116
   562
    std::vector<NodeT> bNodes;
deba@2116
   563
deba@2116
   564
    std::vector<UEdgeT> edges;
deba@2116
   565
deba@2116
   566
  public:
deba@2116
   567
  
deba@2116
   568
    class Node {
deba@2116
   569
      friend class SmartBpUGraphBase;
deba@2116
   570
    protected:
deba@2116
   571
      int id;
deba@2116
   572
deba@2190
   573
      explicit Node(int _id) : id(_id) {}
deba@2116
   574
    public:
deba@2116
   575
      Node() {}
deba@2190
   576
      Node(Invalid) : id(-1) {}
deba@2116
   577
      bool operator==(const Node i) const {return id==i.id;}
deba@2116
   578
      bool operator!=(const Node i) const {return id!=i.id;}
deba@2116
   579
      bool operator<(const Node i) const {return id<i.id;}
deba@2116
   580
    };
deba@2116
   581
deba@2116
   582
    class UEdge {
deba@2116
   583
      friend class SmartBpUGraphBase;
deba@2116
   584
    protected:
deba@2116
   585
      int id;
deba@2116
   586
deba@2190
   587
      UEdge(int _id) : id(_id) {}
deba@2116
   588
    public:
deba@2116
   589
      UEdge() {}
deba@2190
   590
      UEdge(Invalid) : id(-1) {}
deba@2116
   591
      bool operator==(const UEdge i) const {return id==i.id;}
deba@2116
   592
      bool operator!=(const UEdge i) const {return id!=i.id;}
deba@2116
   593
      bool operator<(const UEdge i) const {return id<i.id;}
deba@2116
   594
    };
deba@2116
   595
deba@2116
   596
    void firstANode(Node& node) const {
deba@2116
   597
      node.id = 2 * aNodes.size() - 2;
deba@2116
   598
      if (node.id < 0) node.id = -1; 
deba@2116
   599
    }
deba@2116
   600
    void nextANode(Node& node) const {
deba@2116
   601
      node.id -= 2;
deba@2116
   602
      if (node.id < 0) node.id = -1; 
deba@2116
   603
    }
deba@2116
   604
deba@2116
   605
    void firstBNode(Node& node) const {
deba@2116
   606
      node.id = 2 * bNodes.size() - 1;
deba@2116
   607
    }
deba@2116
   608
    void nextBNode(Node& node) const {
deba@2116
   609
      node.id -= 2;
deba@2116
   610
    }
deba@2116
   611
deba@2116
   612
    void first(Node& node) const {
deba@2116
   613
      if (aNodes.size() > 0) {
deba@2116
   614
	node.id = 2 * aNodes.size() - 2;
deba@2116
   615
      } else {
deba@2116
   616
	node.id = 2 * bNodes.size() - 1;
deba@2116
   617
      }
deba@2116
   618
    }
deba@2116
   619
    void next(Node& node) const {
deba@2116
   620
      node.id -= 2;
deba@2116
   621
      if (node.id == -2) {
deba@2116
   622
	node.id = 2 * bNodes.size() - 1;
deba@2116
   623
      }
deba@2116
   624
    }
deba@2116
   625
  
deba@2116
   626
    void first(UEdge& edge) const {
deba@2116
   627
      edge.id = edges.size() - 1;
deba@2116
   628
    }
deba@2116
   629
    void next(UEdge& edge) const {
deba@2116
   630
      --edge.id;
deba@2116
   631
    }
deba@2116
   632
deba@2116
   633
    void firstFromANode(UEdge& edge, const Node& node) const {
deba@2116
   634
      LEMON_ASSERT((node.id & 1) == 0, NodeSetError());
deba@2116
   635
      edge.id = aNodes[node.id >> 1].first;
deba@2116
   636
    }
deba@2116
   637
    void nextFromANode(UEdge& edge) const {
deba@2116
   638
      edge.id = edges[edge.id].next_out;
deba@2116
   639
    }
deba@2116
   640
deba@2116
   641
    void firstFromBNode(UEdge& edge, const Node& node) const {
deba@2116
   642
      LEMON_ASSERT((node.id & 1) == 1, NodeSetError());
deba@2116
   643
      edge.id = bNodes[node.id >> 1].first;
deba@2116
   644
    }
deba@2116
   645
    void nextFromBNode(UEdge& edge) const {
deba@2116
   646
      edge.id = edges[edge.id].next_in;
deba@2116
   647
    }
deba@2116
   648
deba@2116
   649
    static int id(const Node& node) {
deba@2116
   650
      return node.id;
deba@2116
   651
    }
deba@2116
   652
    static Node nodeFromId(int id) {
deba@2116
   653
      return Node(id);
deba@2116
   654
    }
deba@2116
   655
    int maxNodeId() const {
deba@2116
   656
      return aNodes.size() > bNodes.size() ?
deba@2116
   657
	aNodes.size() * 2 - 2 : bNodes.size() * 2 - 1;
deba@2116
   658
    }
deba@2116
   659
  
deba@2116
   660
    static int id(const UEdge& edge) {
deba@2116
   661
      return edge.id;
deba@2116
   662
    }
deba@2116
   663
    static UEdge uEdgeFromId(int id) {
deba@2116
   664
      return UEdge(id);
deba@2116
   665
    }
deba@2116
   666
    int maxUEdgeId() const {
deba@2116
   667
      return edges.size();
deba@2116
   668
    }
deba@2116
   669
  
deba@2116
   670
    static int aNodeId(const Node& node) {
deba@2116
   671
      return node.id >> 1;
deba@2116
   672
    }
deba@2231
   673
    static Node nodeFromANodeId(int id) {
deba@2116
   674
      return Node(id << 1);
deba@2116
   675
    }
deba@2116
   676
    int maxANodeId() const {
deba@2116
   677
      return aNodes.size();
deba@2116
   678
    }
deba@2116
   679
deba@2116
   680
    static int bNodeId(const Node& node) {
deba@2116
   681
      return node.id >> 1;
deba@2116
   682
    }
deba@2231
   683
    static Node nodeFromBNodeId(int id) {
deba@2116
   684
      return Node((id << 1) + 1);
deba@2116
   685
    }
deba@2116
   686
    int maxBNodeId() const {
deba@2116
   687
      return bNodes.size();
deba@2116
   688
    }
deba@2116
   689
deba@2116
   690
    Node aNode(const UEdge& edge) const {
deba@2116
   691
      return Node(edges[edge.id].aNode);
deba@2116
   692
    }
deba@2116
   693
    Node bNode(const UEdge& edge) const {
deba@2116
   694
      return Node(edges[edge.id].bNode);
deba@2116
   695
    }
deba@2116
   696
deba@2116
   697
    static bool aNode(const Node& node) {
deba@2116
   698
      return (node.id & 1) == 0;
deba@2116
   699
    }
deba@2116
   700
deba@2116
   701
    static bool bNode(const Node& node) {
deba@2116
   702
      return (node.id & 1) == 1;
deba@2116
   703
    }
deba@2116
   704
deba@2116
   705
    Node addANode() {
deba@2116
   706
      NodeT nodeT;
deba@2116
   707
      nodeT.first = -1;
deba@2116
   708
      aNodes.push_back(nodeT);
deba@2116
   709
      return Node(aNodes.size() * 2 - 2);
deba@2116
   710
    }
deba@2116
   711
deba@2116
   712
    Node addBNode() {
deba@2116
   713
      NodeT nodeT;
deba@2116
   714
      nodeT.first = -1;
deba@2116
   715
      bNodes.push_back(nodeT);
deba@2116
   716
      return Node(bNodes.size() * 2 - 1);
deba@2116
   717
    }
deba@2116
   718
deba@2116
   719
    UEdge addEdge(const Node& source, const Node& target) {
deba@2116
   720
      LEMON_ASSERT(((source.id ^ target.id) & 1) == 1, NodeSetError());
deba@2116
   721
      UEdgeT edgeT;
deba@2116
   722
      if ((source.id & 1) == 0) {
deba@2116
   723
	edgeT.aNode = source.id;
deba@2116
   724
	edgeT.bNode = target.id;
deba@2116
   725
      } else {
deba@2116
   726
	edgeT.aNode = target.id;
deba@2116
   727
	edgeT.bNode = source.id;
deba@2116
   728
      }
deba@2116
   729
      edgeT.next_out = aNodes[edgeT.aNode >> 1].first;
deba@2116
   730
      aNodes[edgeT.aNode >> 1].first = edges.size();
deba@2116
   731
      edgeT.next_in = bNodes[edgeT.bNode >> 1].first;
deba@2116
   732
      bNodes[edgeT.bNode >> 1].first = edges.size();
deba@2116
   733
      edges.push_back(edgeT);
deba@2116
   734
      return UEdge(edges.size() - 1);
deba@2116
   735
    }
deba@2116
   736
deba@2116
   737
    void clear() {
deba@2116
   738
      aNodes.clear();
deba@2116
   739
      bNodes.clear();
deba@2116
   740
      edges.clear();
deba@2116
   741
    }
deba@2116
   742
deba@2116
   743
    typedef True NodeNumTag;
deba@2116
   744
    int nodeNum() const { return aNodes.size() + bNodes.size(); }
deba@2116
   745
    int aNodeNum() const { return aNodes.size(); }
deba@2116
   746
    int bNodeNum() const { return bNodes.size(); }
deba@2116
   747
deba@2116
   748
    typedef True EdgeNumTag;
deba@2116
   749
    int uEdgeNum() const { return edges.size(); }
deba@2116
   750
deba@2116
   751
  };
deba@2116
   752
deba@2116
   753
deba@2231
   754
  typedef BpUGraphExtender<BidirBpUGraphExtender<SmartBpUGraphBase> >
deba@2231
   755
  ExtendedSmartBpUGraphBase;
deba@2116
   756
deba@2116
   757
  /// \ingroup graphs
deba@2116
   758
  ///
deba@2116
   759
  /// \brief A smart bipartite undirected graph class.
deba@2116
   760
  ///
deba@2116
   761
  /// This is a simple and fast bipartite undirected graph implementation.
deba@2116
   762
  /// It is also quite memory efficient, but at the price
deba@2116
   763
  /// that <b> it does not support node and edge deletions</b>.
deba@2116
   764
  /// Except from this it conforms to 
alpar@2123
   765
  /// the \ref concept::BpUGraph "BpUGraph concept".
alpar@2256
   766
  ///
alpar@2256
   767
  ///It also has an
alpar@2256
   768
  ///important extra feature that
alpar@2256
   769
  ///its maps are real \ref concept::ReferenceMap "reference map"s.
alpar@2256
   770
  ///
deba@2116
   771
  /// \sa concept::BpUGraph.
deba@2116
   772
  ///
deba@2190
   773
  class SmartBpUGraph : public ExtendedSmartBpUGraphBase {
deba@2190
   774
  private:
deba@2190
   775
deba@2190
   776
    /// \brief SmartBpUGraph is \e not copy constructible.
deba@2190
   777
    ///
deba@2190
   778
    ///SmartBpUGraph is \e not copy constructible.
deba@2190
   779
    SmartBpUGraph(const SmartBpUGraph &) : ExtendedSmartBpUGraphBase() {};
deba@2190
   780
deba@2190
   781
    /// \brief Assignment of SmartBpUGraph to another one is \e not
deba@2190
   782
    /// allowed.
deba@2190
   783
    ///
deba@2190
   784
    /// Assignment of SmartBpUGraph to another one is \e not allowed.
deba@2190
   785
    void operator=(const SmartBpUGraph &) {}
deba@2190
   786
deba@2190
   787
  public:
deba@2190
   788
deba@2190
   789
    typedef ExtendedSmartBpUGraphBase Parent;
deba@2190
   790
deba@2190
   791
    ///Constructor
deba@2190
   792
    
deba@2190
   793
    ///Constructor.
deba@2190
   794
    ///
deba@2190
   795
    SmartBpUGraph() : ExtendedSmartBpUGraphBase() {}
deba@2190
   796
deba@2190
   797
    ///Add a new ANode to the graph.
deba@2190
   798
    
deba@2190
   799
    /// \return the new node.
deba@2190
   800
    ///
deba@2190
   801
    Node addANode() { return Parent::addANode(); }
deba@2190
   802
deba@2190
   803
    ///Add a new BNode to the graph.
deba@2190
   804
    
deba@2190
   805
    /// \return the new node.
deba@2190
   806
    ///
deba@2190
   807
    Node addBNode() { return Parent::addBNode(); }
deba@2190
   808
    
deba@2190
   809
    ///Add a new undirected edge to the graph.
deba@2190
   810
    
deba@2190
   811
    ///Add a new undirected edge to the graph with node \c s
deba@2190
   812
    ///and \c t.
deba@2190
   813
    ///\return the new undirected edge.
deba@2190
   814
    UEdge addEdge(const Node& s, const Node& t) { 
deba@2190
   815
      return Parent::addEdge(s, t); 
deba@2190
   816
    }
deba@2190
   817
deba@2190
   818
    ///Clear the graph.
deba@2190
   819
    
deba@2190
   820
    ///Erase all the nodes and edges from the graph.
deba@2190
   821
    ///
deba@2190
   822
    void clear() {
deba@2190
   823
      Parent::clear();
deba@2190
   824
    }
deba@2190
   825
    
deba@2190
   826
  public:
deba@2190
   827
deba@2190
   828
    class Snapshot;
deba@2190
   829
deba@2190
   830
  protected:
deba@2190
   831
    
deba@2190
   832
    void restoreSnapshot(const Snapshot &s)
deba@2190
   833
    {
deba@2190
   834
      while(s.edge_num<edges.size()) {
deba@2190
   835
        UEdge edge = uEdgeFromId(edges.size()-1);
deba@2190
   836
	Parent::getNotifier(UEdge()).erase(edge);
deba@2190
   837
        std::vector<Edge> dir;
deba@2190
   838
        dir.push_back(Parent::direct(edge, true));
deba@2190
   839
        dir.push_back(Parent::direct(edge, false));
deba@2190
   840
	Parent::getNotifier(Edge()).erase(dir);
deba@2190
   841
	aNodes[edges.back().aNode >> 1].first=edges.back().next_out;
deba@2190
   842
	bNodes[edges.back().bNode >> 1].first=edges.back().next_in;
deba@2190
   843
	edges.pop_back();
deba@2190
   844
      }
deba@2190
   845
      while(s.anode_num<aNodes.size()) {
deba@2231
   846
        Node node = nodeFromANodeId(aNodes.size() - 1);
deba@2190
   847
	Parent::getNotifier(ANode()).erase(node);
deba@2190
   848
	Parent::getNotifier(Node()).erase(node);
deba@2190
   849
	aNodes.pop_back();
deba@2190
   850
      }
deba@2190
   851
      while(s.bnode_num<bNodes.size()) {
deba@2231
   852
        Node node = nodeFromBNodeId(bNodes.size() - 1);
deba@2190
   853
	Parent::getNotifier(BNode()).erase(node);
deba@2190
   854
	Parent::getNotifier(Node()).erase(node);
deba@2190
   855
	bNodes.pop_back();
deba@2190
   856
      }
deba@2190
   857
    }    
deba@2190
   858
deba@2190
   859
  public:
deba@2190
   860
deba@2190
   861
    ///Class to make a snapshot of the graph and to restrore to it later.
deba@2190
   862
deba@2190
   863
    ///Class to make a snapshot of the graph and to restrore to it later.
deba@2190
   864
    ///
deba@2190
   865
    ///The newly added nodes and edges can be removed using the
deba@2190
   866
    ///restore() function.
deba@2190
   867
    ///
deba@2190
   868
    ///\note After you restore a state, you cannot restore
deba@2190
   869
    ///a later state, in other word you cannot add again the edges deleted
deba@2190
   870
    ///by restore() using another one Snapshot instance.
deba@2190
   871
    ///
deba@2190
   872
    ///\warning If you do not use correctly the snapshot that can cause
deba@2190
   873
    ///either broken program, invalid state of the graph, valid but
deba@2190
   874
    ///not the restored graph or no change. Because the runtime performance
deba@2190
   875
    ///the validity of the snapshot is not stored.
deba@2190
   876
    class Snapshot 
deba@2190
   877
    {
deba@2190
   878
      SmartBpUGraph *g;
deba@2190
   879
    protected:
deba@2190
   880
      friend class SmartBpUGraph;
deba@2190
   881
      unsigned int anode_num;
deba@2190
   882
      unsigned int bnode_num;
deba@2190
   883
      unsigned int edge_num;
deba@2190
   884
    public:
deba@2190
   885
      ///Default constructor.
deba@2190
   886
      
deba@2190
   887
      ///Default constructor.
deba@2190
   888
      ///To actually make a snapshot you must call save().
deba@2190
   889
      ///
deba@2190
   890
      Snapshot() : g(0) {}
deba@2190
   891
deba@2190
   892
      ///Constructor that immediately makes a snapshot
deba@2190
   893
      
deba@2190
   894
      ///This constructor immediately makes a snapshot of the graph.
deba@2190
   895
      ///\param _g The graph we make a snapshot of.
deba@2190
   896
      Snapshot(SmartBpUGraph &_g) : g(&_g) {
deba@2190
   897
	anode_num=g->aNodes.size();
deba@2190
   898
	bnode_num=g->bNodes.size();
deba@2190
   899
	edge_num=g->edges.size();
deba@2190
   900
      }
deba@2190
   901
deba@2190
   902
      ///Make a snapshot.
deba@2190
   903
deba@2190
   904
      ///Make a snapshot of the graph.
deba@2190
   905
      ///
deba@2190
   906
      ///This function can be called more than once. In case of a repeated
deba@2190
   907
      ///call, the previous snapshot gets lost.
deba@2190
   908
      ///\param _g The graph we make the snapshot of.
deba@2190
   909
      void save(SmartBpUGraph &_g) 
deba@2190
   910
      {
deba@2190
   911
	g=&_g;
deba@2190
   912
	anode_num=g->aNodes.size();
deba@2190
   913
	bnode_num=g->bNodes.size();
deba@2190
   914
	edge_num=g->edges.size();
deba@2190
   915
      }
deba@2190
   916
deba@2190
   917
      ///Undo the changes until a snapshot.
deba@2190
   918
      
deba@2190
   919
      ///Undo the changes until a snapshot created by save().
deba@2190
   920
      ///
deba@2190
   921
      ///\note After you restored a state, you cannot restore
deba@2190
   922
      ///a later state, in other word you cannot add again the edges deleted
deba@2190
   923
      ///by restore().
deba@2190
   924
      void restore()
deba@2190
   925
      {
deba@2190
   926
	g->restoreSnapshot(*this);
deba@2190
   927
      }
deba@2190
   928
    };
deba@2190
   929
  };
deba@2116
   930
deba@2116
   931
  
deba@2116
   932
  /// @}  
alpar@921
   933
} //namespace lemon
alpar@104
   934
alpar@157
   935
alpar@921
   936
#endif //LEMON_SMART_GRAPH_H