lemon/smart_graph.h
author Akos Ladanyi <ladanyi@tmit.bme.hu>
Sun, 13 Apr 2008 13:22:52 +0200
changeset 141 96f81c791f0c
parent 109 abddaa08b507
child 138 a0f755a30cf1
permissions -rw-r--r--
CMake based build system
deba@109
     1
/* -*- C++ -*-
deba@109
     2
 *
deba@109
     3
 * This file is a part of LEMON, a generic C++ optimization library
deba@109
     4
 *
deba@109
     5
 * Copyright (C) 2003-2008
deba@109
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
deba@109
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
deba@109
     8
 *
deba@109
     9
 * Permission to use, modify and distribute this software is granted
deba@109
    10
 * provided that this copyright notice appears in all copies. For
deba@109
    11
 * precise terms see the accompanying LICENSE file.
deba@109
    12
 *
deba@109
    13
 * This software is provided "AS IS" with no warranty of any kind,
deba@109
    14
 * express or implied, and with no claim as to its suitability for any
deba@109
    15
 * purpose.
deba@109
    16
 *
deba@109
    17
 */
deba@109
    18
deba@109
    19
#ifndef LEMON_SMART_GRAPH_H
deba@109
    20
#define LEMON_SMART_GRAPH_H
deba@109
    21
deba@109
    22
///\ingroup graphs
deba@109
    23
///\file
deba@109
    24
///\brief SmartDigraph and SmartGraph classes.
deba@109
    25
deba@109
    26
#include <vector>
deba@109
    27
deba@109
    28
#include <lemon/bits/invalid.h>
deba@109
    29
deba@109
    30
#include <lemon/bits/base_extender.h>
deba@109
    31
#include <lemon/bits/graph_extender.h>
deba@109
    32
deba@109
    33
#include <lemon/bits/utility.h>
deba@109
    34
#include <lemon/error.h>
deba@109
    35
deba@109
    36
#include <lemon/bits/graph_extender.h>
deba@109
    37
deba@109
    38
namespace lemon {
deba@109
    39
deba@109
    40
  class SmartDigraph;
deba@109
    41
  ///Base of SmartDigraph
deba@109
    42
deba@109
    43
  ///Base of SmartDigraph
deba@109
    44
  ///
deba@109
    45
  class SmartDigraphBase {
deba@109
    46
  protected:
deba@109
    47
deba@109
    48
    struct NodeT 
deba@109
    49
    {
deba@109
    50
      int first_in, first_out;      
deba@109
    51
      NodeT() {}
deba@109
    52
    };
deba@109
    53
    struct ArcT 
deba@109
    54
    {
deba@109
    55
      int target, source, next_in, next_out;      
deba@109
    56
      ArcT() {}  
deba@109
    57
    };
deba@109
    58
deba@109
    59
    std::vector<NodeT> nodes;
deba@109
    60
    std::vector<ArcT> arcs;
deba@109
    61
        
deba@109
    62
  public:
deba@109
    63
deba@109
    64
    typedef SmartDigraphBase Graph;
deba@109
    65
deba@109
    66
    class Node;
deba@109
    67
    class Arc;
deba@109
    68
deba@109
    69
  public:
deba@109
    70
deba@109
    71
    SmartDigraphBase() : nodes(), arcs() { }
deba@109
    72
    SmartDigraphBase(const SmartDigraphBase &_g) 
deba@109
    73
      : nodes(_g.nodes), arcs(_g.arcs) { }
deba@109
    74
    
deba@109
    75
    typedef True NodeNumTag;
deba@109
    76
    typedef True ArcNumTag;
deba@109
    77
deba@109
    78
    int nodeNum() const { return nodes.size(); }
deba@109
    79
    int arcNum() const { return arcs.size(); }
deba@109
    80
deba@109
    81
    int maxNodeId() const { return nodes.size()-1; }
deba@109
    82
    int maxArcId() const { return arcs.size()-1; }
deba@109
    83
deba@109
    84
    Node addNode() {
deba@109
    85
      int n = nodes.size();     
deba@109
    86
      nodes.push_back(NodeT());
deba@109
    87
      nodes[n].first_in = -1;
deba@109
    88
      nodes[n].first_out = -1;
deba@109
    89
      return Node(n);
deba@109
    90
    }
deba@109
    91
    
deba@109
    92
    Arc addArc(Node u, Node v) {
deba@109
    93
      int n = arcs.size(); 
deba@109
    94
      arcs.push_back(ArcT());
deba@109
    95
      arcs[n].source = u._id; 
deba@109
    96
      arcs[n].target = v._id;
deba@109
    97
      arcs[n].next_out = nodes[u._id].first_out;
deba@109
    98
      arcs[n].next_in = nodes[v._id].first_in;
deba@109
    99
      nodes[u._id].first_out = nodes[v._id].first_in = n;
deba@109
   100
deba@109
   101
      return Arc(n);
deba@109
   102
    }
deba@109
   103
deba@109
   104
    void clear() {
deba@109
   105
      arcs.clear();
deba@109
   106
      nodes.clear();
deba@109
   107
    }
deba@109
   108
deba@109
   109
    Node source(Arc a) const { return Node(arcs[a._id].source); }
deba@109
   110
    Node target(Arc a) const { return Node(arcs[a._id].target); }
deba@109
   111
deba@109
   112
    static int id(Node v) { return v._id; }
deba@109
   113
    static int id(Arc a) { return a._id; }
deba@109
   114
deba@109
   115
    static Node nodeFromId(int id) { return Node(id);}
deba@109
   116
    static Arc arcFromId(int id) { return Arc(id);}
deba@109
   117
deba@109
   118
    class Node {
deba@109
   119
      friend class SmartDigraphBase;
deba@109
   120
      friend class SmartDigraph;
deba@109
   121
deba@109
   122
    protected:
deba@109
   123
      int _id;
deba@109
   124
      explicit Node(int id) : _id(id) {}
deba@109
   125
    public:
deba@109
   126
      Node() {}
deba@109
   127
      Node (Invalid) : _id(-1) {}
deba@109
   128
      bool operator==(const Node i) const {return _id == i._id;}
deba@109
   129
      bool operator!=(const Node i) const {return _id != i._id;}
deba@109
   130
      bool operator<(const Node i) const {return _id < i._id;}
deba@109
   131
    };
deba@109
   132
    
deba@109
   133
deba@109
   134
    class Arc {
deba@109
   135
      friend class SmartDigraphBase;
deba@109
   136
      friend class SmartDigraph;
deba@109
   137
deba@109
   138
    protected:
deba@109
   139
      int _id;
deba@109
   140
      explicit Arc(int id) : _id(id) {}
deba@109
   141
    public:
deba@109
   142
      Arc() { }
deba@109
   143
      Arc (Invalid) : _id(-1) {}
deba@109
   144
      bool operator==(const Arc i) const {return _id == i._id;}
deba@109
   145
      bool operator!=(const Arc i) const {return _id != i._id;}
deba@109
   146
      bool operator<(const Arc i) const {return _id < i._id;}
deba@109
   147
    };
deba@109
   148
deba@109
   149
    void first(Node& node) const {
deba@109
   150
      node._id = nodes.size() - 1;
deba@109
   151
    }
deba@109
   152
deba@109
   153
    static void next(Node& node) {
deba@109
   154
      --node._id;
deba@109
   155
    }
deba@109
   156
deba@109
   157
    void first(Arc& arc) const {
deba@109
   158
      arc._id = arcs.size() - 1;
deba@109
   159
    }
deba@109
   160
deba@109
   161
    static void next(Arc& arc) {
deba@109
   162
      --arc._id;
deba@109
   163
    }
deba@109
   164
deba@109
   165
    void firstOut(Arc& arc, const Node& node) const {
deba@109
   166
      arc._id = nodes[node._id].first_out;
deba@109
   167
    }
deba@109
   168
deba@109
   169
    void nextOut(Arc& arc) const {
deba@109
   170
      arc._id = arcs[arc._id].next_out;
deba@109
   171
    }
deba@109
   172
deba@109
   173
    void firstIn(Arc& arc, const Node& node) const {
deba@109
   174
      arc._id = nodes[node._id].first_in;
deba@109
   175
    }
deba@109
   176
    
deba@109
   177
    void nextIn(Arc& arc) const {
deba@109
   178
      arc._id = arcs[arc._id].next_in;
deba@109
   179
    }
deba@109
   180
deba@109
   181
  };
deba@109
   182
deba@109
   183
  typedef DigraphExtender<SmartDigraphBase> ExtendedSmartDigraphBase;
deba@109
   184
deba@109
   185
  ///\ingroup graphs
deba@109
   186
  ///
deba@109
   187
  ///\brief A smart directed graph class.
deba@109
   188
  ///
deba@109
   189
  ///This is a simple and fast digraph implementation.
deba@109
   190
  ///It is also quite memory efficient, but at the price
deba@109
   191
  ///that <b> it does support only limited (only stack-like)
deba@109
   192
  ///node and arc deletions</b>.
deba@109
   193
  ///It conforms to the \ref concepts::Digraph "Digraph concept" with
deba@109
   194
  ///an important extra feature that its maps are real \ref
deba@109
   195
  ///concepts::ReferenceMap "reference map"s.
deba@109
   196
  ///
deba@109
   197
  ///\sa concepts::Digraph.
deba@109
   198
  ///
deba@109
   199
  ///\author Alpar Juttner
deba@109
   200
  class SmartDigraph : public ExtendedSmartDigraphBase {
deba@109
   201
  public:
deba@109
   202
deba@109
   203
    typedef ExtendedSmartDigraphBase Parent;
deba@109
   204
deba@109
   205
  private:
deba@109
   206
deba@109
   207
    ///SmartDigraph is \e not copy constructible. Use DigraphCopy() instead.
deba@109
   208
deba@109
   209
    ///SmartDigraph is \e not copy constructible. Use DigraphCopy() instead.
deba@109
   210
    ///
deba@109
   211
    SmartDigraph(const SmartDigraph &) : ExtendedSmartDigraphBase() {};
deba@109
   212
    ///\brief Assignment of SmartDigraph to another one is \e not allowed.
deba@109
   213
    ///Use DigraphCopy() instead.
deba@109
   214
deba@109
   215
    ///Assignment of SmartDigraph to another one is \e not allowed.
deba@109
   216
    ///Use DigraphCopy() instead.
deba@109
   217
    void operator=(const SmartDigraph &) {}
deba@109
   218
deba@109
   219
  public:
deba@109
   220
    
deba@109
   221
    /// Constructor
deba@109
   222
    
deba@109
   223
    /// Constructor.
deba@109
   224
    ///
deba@109
   225
    SmartDigraph() {};
deba@109
   226
    
deba@109
   227
    ///Add a new node to the digraph.
deba@109
   228
    
deba@109
   229
    /// \return the new node.
deba@109
   230
    ///
deba@109
   231
    Node addNode() { return Parent::addNode(); }
deba@109
   232
    
deba@109
   233
    ///Add a new arc to the digraph.
deba@109
   234
    
deba@109
   235
    ///Add a new arc to the digraph with source node \c s
deba@109
   236
    ///and target node \c t.
deba@109
   237
    ///\return the new arc.
deba@109
   238
    Arc addArc(const Node& s, const Node& t) { 
deba@109
   239
      return Parent::addArc(s, t); 
deba@109
   240
    }
deba@109
   241
deba@109
   242
    /// \brief Using this it is possible to avoid the superfluous memory
deba@109
   243
    /// allocation.
deba@109
   244
deba@109
   245
    /// Using this it is possible to avoid the superfluous memory
deba@109
   246
    /// allocation: if you know that the digraph you want to build will
deba@109
   247
    /// be very large (e.g. it will contain millions of nodes and/or arcs)
deba@109
   248
    /// then it is worth reserving space for this amount before starting
deba@109
   249
    /// to build the digraph.
deba@109
   250
    /// \sa reserveArc
deba@109
   251
    void reserveNode(int n) { nodes.reserve(n); };
deba@109
   252
deba@109
   253
    /// \brief Using this it is possible to avoid the superfluous memory
deba@109
   254
    /// allocation.
deba@109
   255
deba@109
   256
    /// Using this it is possible to avoid the superfluous memory
deba@109
   257
    /// allocation: if you know that the digraph you want to build will
deba@109
   258
    /// be very large (e.g. it will contain millions of nodes and/or arcs)
deba@109
   259
    /// then it is worth reserving space for this amount before starting
deba@109
   260
    /// to build the digraph.
deba@109
   261
    /// \sa reserveNode
deba@109
   262
    void reserveArc(int m) { arcs.reserve(m); };
deba@109
   263
deba@109
   264
    ///Clear the digraph.
deba@109
   265
    
deba@109
   266
    ///Erase all the nodes and arcs from the digraph.
deba@109
   267
    ///
deba@109
   268
    void clear() {
deba@109
   269
      Parent::clear();
deba@109
   270
    }
deba@109
   271
deba@109
   272
    ///Split a node.
deba@109
   273
    
deba@109
   274
    ///This function splits a node. First a new node is added to the digraph,
deba@109
   275
    ///then the source of each outgoing arc of \c n is moved to this new node.
deba@109
   276
    ///If \c connect is \c true (this is the default value), then a new arc
deba@109
   277
    ///from \c n to the newly created node is also added.
deba@109
   278
    ///\return The newly created node.
deba@109
   279
    ///
deba@109
   280
    ///\note The <tt>Arc</tt>s
deba@109
   281
    ///referencing a moved arc remain
deba@109
   282
    ///valid. However <tt>InArc</tt>'s and <tt>OutArc</tt>'s
deba@109
   283
    ///may be invalidated.
deba@109
   284
    ///\warning This functionality cannot be used together with the Snapshot
deba@109
   285
    ///feature.
deba@109
   286
    ///\todo It could be implemented in a bit faster way.
deba@109
   287
    Node split(Node n, bool connect = true)
deba@109
   288
    {
deba@109
   289
      Node b = addNode();
deba@109
   290
      nodes[b._id].first_out=nodes[n._id].first_out;
deba@109
   291
      nodes[n._id].first_out=-1;
deba@109
   292
      for(int i=nodes[b._id].first_out;i!=-1;i++) arcs[i].source=b._id;
deba@109
   293
      if(connect) addArc(n,b);
deba@109
   294
      return b;
deba@109
   295
    }
deba@109
   296
deba@109
   297
  public:
deba@109
   298
    
deba@109
   299
    class Snapshot;
deba@109
   300
deba@109
   301
  protected:
deba@109
   302
deba@109
   303
    void restoreSnapshot(const Snapshot &s)
deba@109
   304
    {
deba@109
   305
      while(s.arc_num<arcs.size()) {
deba@109
   306
        Arc arc = arcFromId(arcs.size()-1);
deba@109
   307
	Parent::notifier(Arc()).erase(arc);
deba@109
   308
	nodes[arcs.back().source].first_out=arcs.back().next_out;
deba@109
   309
	nodes[arcs.back().target].first_in=arcs.back().next_in;
deba@109
   310
	arcs.pop_back();
deba@109
   311
      }
deba@109
   312
      while(s.node_num<nodes.size()) {
deba@109
   313
        Node node = nodeFromId(nodes.size()-1);
deba@109
   314
	Parent::notifier(Node()).erase(node);
deba@109
   315
	nodes.pop_back();
deba@109
   316
      }
deba@109
   317
    }    
deba@109
   318
deba@109
   319
  public:
deba@109
   320
deba@109
   321
    ///Class to make a snapshot of the digraph and to restrore to it later.
deba@109
   322
deba@109
   323
    ///Class to make a snapshot of the digraph and to restrore to it later.
deba@109
   324
    ///
deba@109
   325
    ///The newly added nodes and arcs can be removed using the
deba@109
   326
    ///restore() function.
deba@109
   327
    ///\note After you restore a state, you cannot restore
deba@109
   328
    ///a later state, in other word you cannot add again the arcs deleted
deba@109
   329
    ///by restore() using another one Snapshot instance.
deba@109
   330
    ///
deba@109
   331
    ///\warning If you do not use correctly the snapshot that can cause
deba@109
   332
    ///either broken program, invalid state of the digraph, valid but
deba@109
   333
    ///not the restored digraph or no change. Because the runtime performance
deba@109
   334
    ///the validity of the snapshot is not stored.
deba@109
   335
    class Snapshot 
deba@109
   336
    {
deba@109
   337
      SmartDigraph *_graph;
deba@109
   338
    protected:
deba@109
   339
      friend class SmartDigraph;
deba@109
   340
      unsigned int node_num;
deba@109
   341
      unsigned int arc_num;
deba@109
   342
    public:
deba@109
   343
      ///Default constructor.
deba@109
   344
      
deba@109
   345
      ///Default constructor.
deba@109
   346
      ///To actually make a snapshot you must call save().
deba@109
   347
      ///
deba@109
   348
      Snapshot() : _graph(0) {}
deba@109
   349
      ///Constructor that immediately makes a snapshot
deba@109
   350
      
deba@109
   351
      ///This constructor immediately makes a snapshot of the digraph.
deba@109
   352
      ///\param _g The digraph we make a snapshot of.
deba@109
   353
      Snapshot(SmartDigraph &graph) : _graph(&graph) {
deba@109
   354
	node_num=_graph->nodes.size();
deba@109
   355
	arc_num=_graph->arcs.size();
deba@109
   356
      }
deba@109
   357
deba@109
   358
      ///Make a snapshot.
deba@109
   359
deba@109
   360
      ///Make a snapshot of the digraph.
deba@109
   361
      ///
deba@109
   362
      ///This function can be called more than once. In case of a repeated
deba@109
   363
      ///call, the previous snapshot gets lost.
deba@109
   364
      ///\param _g The digraph we make the snapshot of.
deba@109
   365
      void save(SmartDigraph &graph) 
deba@109
   366
      {
deba@109
   367
	_graph=&graph;
deba@109
   368
	node_num=_graph->nodes.size();
deba@109
   369
	arc_num=_graph->arcs.size();
deba@109
   370
      }
deba@109
   371
deba@109
   372
      ///Undo the changes until a snapshot.
deba@109
   373
      
deba@109
   374
      ///Undo the changes until a snapshot created by save().
deba@109
   375
      ///
deba@109
   376
      ///\note After you restored a state, you cannot restore
deba@109
   377
      ///a later state, in other word you cannot add again the arcs deleted
deba@109
   378
      ///by restore().
deba@109
   379
      void restore()
deba@109
   380
      {
deba@109
   381
	_graph->restoreSnapshot(*this);
deba@109
   382
      }
deba@109
   383
    };
deba@109
   384
  };
deba@109
   385
deba@109
   386
deba@109
   387
  class SmartGraphBase {
deba@109
   388
deba@109
   389
  protected:
deba@109
   390
deba@109
   391
    struct NodeT {
deba@109
   392
      int first_out;
deba@109
   393
    };
deba@109
   394
 
deba@109
   395
    struct ArcT {
deba@109
   396
      int target;
deba@109
   397
      int next_out;
deba@109
   398
    };
deba@109
   399
deba@109
   400
    std::vector<NodeT> nodes;
deba@109
   401
    std::vector<ArcT> arcs;
deba@109
   402
deba@109
   403
    int first_free_arc;
deba@109
   404
    
deba@109
   405
  public:
deba@109
   406
    
deba@109
   407
    typedef SmartGraphBase Digraph;
deba@109
   408
deba@109
   409
    class Node;
deba@109
   410
    class Arc;
deba@109
   411
    class Edge;
deba@109
   412
    
deba@109
   413
    class Node {
deba@109
   414
      friend class SmartGraphBase;
deba@109
   415
    protected:
deba@109
   416
deba@109
   417
      int _id;
deba@109
   418
      explicit Node(int id) { _id = id;}
deba@109
   419
deba@109
   420
    public:
deba@109
   421
      Node() {}
deba@109
   422
      Node (Invalid) { _id = -1; }
deba@109
   423
      bool operator==(const Node& node) const {return _id == node._id;}
deba@109
   424
      bool operator!=(const Node& node) const {return _id != node._id;}
deba@109
   425
      bool operator<(const Node& node) const {return _id < node._id;}
deba@109
   426
    };
deba@109
   427
deba@109
   428
    class Edge {
deba@109
   429
      friend class SmartGraphBase;
deba@109
   430
    protected:
deba@109
   431
deba@109
   432
      int _id;
deba@109
   433
      explicit Edge(int id) { _id = id;}
deba@109
   434
deba@109
   435
    public:
deba@109
   436
      Edge() {}
deba@109
   437
      Edge (Invalid) { _id = -1; }
deba@109
   438
      bool operator==(const Edge& arc) const {return _id == arc._id;}
deba@109
   439
      bool operator!=(const Edge& arc) const {return _id != arc._id;}
deba@109
   440
      bool operator<(const Edge& arc) const {return _id < arc._id;}
deba@109
   441
    };
deba@109
   442
deba@109
   443
    class Arc {
deba@109
   444
      friend class SmartGraphBase;
deba@109
   445
    protected:
deba@109
   446
deba@109
   447
      int _id;
deba@109
   448
      explicit Arc(int id) { _id = id;}
deba@109
   449
deba@109
   450
    public:
deba@109
   451
      operator Edge() const { return edgeFromId(_id / 2); }
deba@109
   452
deba@109
   453
      Arc() {}
deba@109
   454
      Arc (Invalid) { _id = -1; }
deba@109
   455
      bool operator==(const Arc& arc) const {return _id == arc._id;}
deba@109
   456
      bool operator!=(const Arc& arc) const {return _id != arc._id;}
deba@109
   457
      bool operator<(const Arc& arc) const {return _id < arc._id;}
deba@109
   458
    };
deba@109
   459
deba@109
   460
deba@109
   461
deba@109
   462
    SmartGraphBase()
deba@109
   463
      : nodes(), arcs() {}
deba@109
   464
deba@109
   465
    
deba@109
   466
    int maxNodeId() const { return nodes.size()-1; } 
deba@109
   467
    int maxEdgeId() const { return arcs.size() / 2 - 1; }
deba@109
   468
    int maxArcId() const { return arcs.size()-1; }
deba@109
   469
deba@109
   470
    Node source(Arc e) const { return Node(arcs[e._id ^ 1].target); }
deba@109
   471
    Node target(Arc e) const { return Node(arcs[e._id].target); }
deba@109
   472
deba@125
   473
    Node u(Edge e) const { return Node(arcs[2 * e._id].target); }
deba@125
   474
    Node v(Edge e) const { return Node(arcs[2 * e._id + 1].target); }
deba@109
   475
deba@109
   476
    static bool direction(Arc e) {
deba@109
   477
      return (e._id & 1) == 1;
deba@109
   478
    }
deba@109
   479
deba@109
   480
    static Arc direct(Edge e, bool d) {
deba@109
   481
      return Arc(e._id * 2 + (d ? 1 : 0));
deba@109
   482
    }
deba@109
   483
deba@109
   484
    void first(Node& node) const { 
deba@109
   485
      node._id = nodes.size() - 1;
deba@109
   486
    }
deba@109
   487
deba@109
   488
    void next(Node& node) const {
deba@109
   489
      --node._id;
deba@109
   490
    }
deba@109
   491
deba@109
   492
    void first(Arc& arc) const { 
deba@109
   493
      arc._id = arcs.size() - 1;
deba@109
   494
    }
deba@109
   495
deba@109
   496
    void next(Arc& arc) const {
deba@109
   497
      --arc._id;
deba@109
   498
    }
deba@109
   499
deba@109
   500
    void first(Edge& arc) const { 
deba@109
   501
      arc._id = arcs.size() / 2 - 1;
deba@109
   502
    }
deba@109
   503
deba@109
   504
    void next(Edge& arc) const {
deba@109
   505
      --arc._id;
deba@109
   506
    }
deba@109
   507
deba@109
   508
    void firstOut(Arc &arc, const Node& v) const {
deba@109
   509
      arc._id = nodes[v._id].first_out;
deba@109
   510
    }
deba@109
   511
    void nextOut(Arc &arc) const {
deba@109
   512
      arc._id = arcs[arc._id].next_out;
deba@109
   513
    }
deba@109
   514
deba@109
   515
    void firstIn(Arc &arc, const Node& v) const {
deba@109
   516
      arc._id = ((nodes[v._id].first_out) ^ 1);
deba@109
   517
      if (arc._id == -2) arc._id = -1;
deba@109
   518
    }
deba@109
   519
    void nextIn(Arc &arc) const {
deba@109
   520
      arc._id = ((arcs[arc._id ^ 1].next_out) ^ 1);
deba@109
   521
      if (arc._id == -2) arc._id = -1;
deba@109
   522
    }
deba@109
   523
deba@109
   524
    void firstInc(Edge &arc, bool& d, const Node& v) const {
deba@109
   525
      int de = nodes[v._id].first_out;
deba@109
   526
      if (de != -1) {
deba@109
   527
        arc._id = de / 2;
deba@109
   528
        d = ((de & 1) == 1);
deba@109
   529
      } else {
deba@109
   530
        arc._id = -1;
deba@109
   531
        d = true;
deba@109
   532
      }
deba@109
   533
    }
deba@109
   534
    void nextInc(Edge &arc, bool& d) const {
deba@109
   535
      int de = (arcs[(arc._id * 2) | (d ? 1 : 0)].next_out);
deba@109
   536
      if (de != -1) {
deba@109
   537
        arc._id = de / 2;
deba@109
   538
        d = ((de & 1) == 1);
deba@109
   539
      } else {
deba@109
   540
        arc._id = -1;
deba@109
   541
        d = true;      
deba@109
   542
      }
deba@109
   543
    }
deba@109
   544
    
deba@109
   545
    static int id(Node v) { return v._id; }
deba@109
   546
    static int id(Arc e) { return e._id; }
deba@109
   547
    static int id(Edge e) { return e._id; }
deba@109
   548
deba@109
   549
    static Node nodeFromId(int id) { return Node(id);}
deba@109
   550
    static Arc arcFromId(int id) { return Arc(id);}
deba@109
   551
    static Edge edgeFromId(int id) { return Edge(id);}
deba@109
   552
deba@109
   553
    Node addNode() {     
deba@109
   554
      int n = nodes.size();
deba@109
   555
      nodes.push_back(NodeT());
deba@109
   556
      nodes[n].first_out = -1;
deba@109
   557
      
deba@109
   558
      return Node(n);
deba@109
   559
    }
deba@109
   560
    
deba@109
   561
    Edge addArc(Node u, Node v) {
deba@109
   562
      int n = arcs.size();
deba@109
   563
      arcs.push_back(ArcT());
deba@109
   564
      arcs.push_back(ArcT());
deba@109
   565
      
deba@109
   566
      arcs[n].target = u._id;
deba@109
   567
      arcs[n | 1].target = v._id;
deba@109
   568
deba@109
   569
      arcs[n].next_out = nodes[v._id].first_out;
deba@109
   570
      nodes[v._id].first_out = n;
deba@109
   571
deba@109
   572
      arcs[n | 1].next_out = nodes[u._id].first_out;	
deba@109
   573
      nodes[u._id].first_out = (n | 1);
deba@109
   574
deba@109
   575
      return Edge(n / 2);
deba@109
   576
    }
deba@109
   577
    
deba@109
   578
    void clear() {
deba@109
   579
      arcs.clear();
deba@109
   580
      nodes.clear();
deba@109
   581
    }
deba@109
   582
deba@109
   583
  };
deba@109
   584
deba@109
   585
  typedef GraphExtender<SmartGraphBase> ExtendedSmartGraphBase;
deba@109
   586
deba@109
   587
  /// \ingroup graphs
deba@109
   588
  ///
deba@109
   589
  /// \brief A smart undirected graph class.
deba@109
   590
  ///
deba@109
   591
  /// This is a simple and fast graph implementation.
deba@109
   592
  /// It is also quite memory efficient, but at the price
deba@109
   593
  /// that <b> it does support only limited (only stack-like)
deba@109
   594
  /// node and arc deletions</b>.
deba@109
   595
  /// Except from this it conforms to 
deba@109
   596
  /// the \ref concepts::Graph "Graph concept".
deba@109
   597
  ///
deba@109
   598
  /// It also has an
deba@109
   599
  /// important extra feature that
deba@109
   600
  /// its maps are real \ref concepts::ReferenceMap "reference map"s.
deba@109
   601
  ///
deba@109
   602
  /// \sa concepts::Graph.
deba@109
   603
  ///
deba@109
   604
  class SmartGraph : public ExtendedSmartGraphBase {
deba@109
   605
  private:
deba@109
   606
deba@109
   607
    ///SmartGraph is \e not copy constructible. Use GraphCopy() instead.
deba@109
   608
deba@109
   609
    ///SmartGraph is \e not copy constructible. Use GraphCopy() instead.
deba@109
   610
    ///
deba@109
   611
    SmartGraph(const SmartGraph &) : ExtendedSmartGraphBase() {};
deba@109
   612
deba@109
   613
    ///\brief Assignment of SmartGraph to another one is \e not allowed.
deba@109
   614
    ///Use GraphCopy() instead.
deba@109
   615
deba@109
   616
    ///Assignment of SmartGraph to another one is \e not allowed.
deba@109
   617
    ///Use GraphCopy() instead.
deba@109
   618
    void operator=(const SmartGraph &) {}
deba@109
   619
deba@109
   620
  public:
deba@109
   621
deba@109
   622
    typedef ExtendedSmartGraphBase Parent;
deba@109
   623
deba@109
   624
    /// Constructor
deba@109
   625
    
deba@109
   626
    /// Constructor.
deba@109
   627
    ///
deba@109
   628
    SmartGraph() {}
deba@109
   629
deba@109
   630
    ///Add a new node to the graph.
deba@109
   631
    
deba@109
   632
    /// \return the new node.
deba@109
   633
    ///
deba@109
   634
    Node addNode() { return Parent::addNode(); }
deba@109
   635
    
deba@109
   636
    ///Add a new edge to the graph.
deba@109
   637
    
deba@109
   638
    ///Add a new edge to the graph with node \c s
deba@109
   639
    ///and \c t.
deba@109
   640
    ///\return the new edge.
deba@109
   641
    Edge addEdge(const Node& s, const Node& t) { 
deba@109
   642
      return Parent::addArc(s, t); 
deba@109
   643
    }
deba@109
   644
deba@109
   645
    ///Clear the graph.
deba@109
   646
    
deba@109
   647
    ///Erase all the nodes and edges from the graph.
deba@109
   648
    ///
deba@109
   649
    void clear() {
deba@109
   650
      Parent::clear();
deba@109
   651
    }
deba@109
   652
deba@109
   653
  public:
deba@109
   654
    
deba@109
   655
    class Snapshot;
deba@109
   656
deba@109
   657
  protected:
deba@109
   658
deba@109
   659
    void saveSnapshot(Snapshot &s)
deba@109
   660
    {
deba@109
   661
      s._graph = this;
deba@109
   662
      s.node_num = nodes.size();
deba@109
   663
      s.arc_num = arcs.size();
deba@109
   664
    }
deba@109
   665
deba@109
   666
    void restoreSnapshot(const Snapshot &s)
deba@109
   667
    {
deba@109
   668
      while(s.arc_num<arcs.size()) {
deba@109
   669
        int n=arcs.size()-1;
deba@109
   670
        Edge arc=edgeFromId(n/2);
deba@109
   671
	Parent::notifier(Edge()).erase(arc);
deba@109
   672
        std::vector<Arc> dir;
deba@109
   673
        dir.push_back(arcFromId(n));
deba@109
   674
        dir.push_back(arcFromId(n-1));
deba@109
   675
	Parent::notifier(Arc()).erase(dir);
deba@109
   676
	nodes[arcs[n].target].first_out=arcs[n].next_out;
deba@109
   677
	nodes[arcs[n-1].target].first_out=arcs[n-1].next_out;
deba@109
   678
	arcs.pop_back();
deba@109
   679
	arcs.pop_back();
deba@109
   680
      }
deba@109
   681
      while(s.node_num<nodes.size()) {
deba@109
   682
        int n=nodes.size()-1;
deba@109
   683
        Node node = nodeFromId(n);
deba@109
   684
	Parent::notifier(Node()).erase(node);
deba@109
   685
	nodes.pop_back();
deba@109
   686
      }
deba@109
   687
    }    
deba@109
   688
deba@109
   689
  public:
deba@109
   690
deba@109
   691
    ///Class to make a snapshot of the digraph and to restrore to it later.
deba@109
   692
deba@109
   693
    ///Class to make a snapshot of the digraph and to restrore to it later.
deba@109
   694
    ///
deba@109
   695
    ///The newly added nodes and arcs can be removed using the
deba@109
   696
    ///restore() function.
deba@109
   697
    ///
deba@109
   698
    ///\note After you restore a state, you cannot restore
deba@109
   699
    ///a later state, in other word you cannot add again the arcs deleted
deba@109
   700
    ///by restore() using another one Snapshot instance.
deba@109
   701
    ///
deba@109
   702
    ///\warning If you do not use correctly the snapshot that can cause
deba@109
   703
    ///either broken program, invalid state of the digraph, valid but
deba@109
   704
    ///not the restored digraph or no change. Because the runtime performance
deba@109
   705
    ///the validity of the snapshot is not stored.
deba@109
   706
    class Snapshot 
deba@109
   707
    {
deba@109
   708
      SmartGraph *_graph;
deba@109
   709
    protected:
deba@109
   710
      friend class SmartGraph;
deba@109
   711
      unsigned int node_num;
deba@109
   712
      unsigned int arc_num;
deba@109
   713
    public:
deba@109
   714
      ///Default constructor.
deba@109
   715
      
deba@109
   716
      ///Default constructor.
deba@109
   717
      ///To actually make a snapshot you must call save().
deba@109
   718
      ///
deba@109
   719
      Snapshot() : _graph(0) {}
deba@109
   720
      ///Constructor that immediately makes a snapshot
deba@109
   721
      
deba@109
   722
      ///This constructor immediately makes a snapshot of the digraph.
deba@109
   723
      ///\param g The digraph we make a snapshot of.
deba@109
   724
      Snapshot(SmartGraph &graph) {
deba@109
   725
        graph.saveSnapshot(*this);
deba@109
   726
      }
deba@109
   727
deba@109
   728
      ///Make a snapshot.
deba@109
   729
deba@109
   730
      ///Make a snapshot of the graph.
deba@109
   731
      ///
deba@109
   732
      ///This function can be called more than once. In case of a repeated
deba@109
   733
      ///call, the previous snapshot gets lost.
deba@109
   734
      ///\param g The digraph we make the snapshot of.
deba@109
   735
      void save(SmartGraph &graph) 
deba@109
   736
      {
deba@109
   737
        graph.saveSnapshot(*this);
deba@109
   738
      }
deba@109
   739
deba@109
   740
      ///Undo the changes until a snapshot.
deba@109
   741
      
deba@109
   742
      ///Undo the changes until a snapshot created by save().
deba@109
   743
      ///
deba@109
   744
      ///\note After you restored a state, you cannot restore
deba@109
   745
      ///a later state, in other word you cannot add again the arcs deleted
deba@109
   746
      ///by restore().
deba@109
   747
      void restore()
deba@109
   748
      {
deba@109
   749
        _graph->restoreSnapshot(*this);
deba@109
   750
      }
deba@109
   751
    };
deba@109
   752
  };
deba@109
   753
  
deba@109
   754
} //namespace lemon
deba@109
   755
deba@109
   756
deba@109
   757
#endif //LEMON_SMART_GRAPH_H