lemon/bits/graph_adaptor_extender.h
author Balazs Dezso <deba@inf.elte.hu>
Sun, 30 Nov 2008 18:57:18 +0100
changeset 430 05357da973ce
child 432 76287c8caa26
permissions -rw-r--r--
Port graph adaptors from svn -r3498 (#67)
deba@430
     1
/* -*- C++ -*-
deba@430
     2
 *
deba@430
     3
 * This file is a part of LEMON, a generic C++ optimization library
deba@430
     4
 *
deba@430
     5
 * Copyright (C) 2003-2008
deba@430
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
deba@430
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
deba@430
     8
 *
deba@430
     9
 * Permission to use, modify and distribute this software is granted
deba@430
    10
 * provided that this copyright notice appears in all copies. For
deba@430
    11
 * precise terms see the accompanying LICENSE file.
deba@430
    12
 *
deba@430
    13
 * This software is provided "AS IS" with no warranty of any kind,
deba@430
    14
 * express or implied, and with no claim as to its suitability for any
deba@430
    15
 * purpose.
deba@430
    16
 *
deba@430
    17
 */
deba@430
    18
deba@430
    19
#ifndef LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
deba@430
    20
#define LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
deba@430
    21
deba@430
    22
#include <lemon/core.h>
deba@430
    23
#include <lemon/error.h>
deba@430
    24
deba@430
    25
#include <lemon/bits/default_map.h>
deba@430
    26
deba@430
    27
deba@430
    28
///\ingroup digraphbits
deba@430
    29
///\file
deba@430
    30
///\brief Extenders for the digraph adaptor types
deba@430
    31
namespace lemon {
deba@430
    32
deba@430
    33
  /// \ingroup digraphbits
deba@430
    34
  ///
deba@430
    35
  /// \brief Extender for the DigraphAdaptors
deba@430
    36
  template <typename _Digraph>
deba@430
    37
  class DigraphAdaptorExtender : public _Digraph {
deba@430
    38
  public:
deba@430
    39
deba@430
    40
    typedef _Digraph Parent;
deba@430
    41
    typedef _Digraph Digraph;
deba@430
    42
    typedef DigraphAdaptorExtender Adaptor;
deba@430
    43
deba@430
    44
    // Base extensions
deba@430
    45
deba@430
    46
    typedef typename Parent::Node Node;
deba@430
    47
    typedef typename Parent::Arc Arc;
deba@430
    48
deba@430
    49
    int maxId(Node) const {
deba@430
    50
      return Parent::maxNodeId();
deba@430
    51
    }
deba@430
    52
deba@430
    53
    int maxId(Arc) const {
deba@430
    54
      return Parent::maxArcId();
deba@430
    55
    }
deba@430
    56
deba@430
    57
    Node fromId(int id, Node) const {
deba@430
    58
      return Parent::nodeFromId(id);
deba@430
    59
    }
deba@430
    60
deba@430
    61
    Arc fromId(int id, Arc) const {
deba@430
    62
      return Parent::arcFromId(id);
deba@430
    63
    }
deba@430
    64
deba@430
    65
    Node oppositeNode(const Node &n, const Arc &e) const {
deba@430
    66
      if (n == Parent::source(e))
deba@430
    67
	return Parent::target(e);
deba@430
    68
      else if(n==Parent::target(e))
deba@430
    69
	return Parent::source(e);
deba@430
    70
      else
deba@430
    71
	return INVALID;
deba@430
    72
    }
deba@430
    73
deba@430
    74
    class NodeIt : public Node { 
deba@430
    75
      const Adaptor* _adaptor;
deba@430
    76
    public:
deba@430
    77
deba@430
    78
      NodeIt() {}
deba@430
    79
deba@430
    80
      NodeIt(Invalid i) : Node(i) { }
deba@430
    81
deba@430
    82
      explicit NodeIt(const Adaptor& adaptor) : _adaptor(&adaptor) {
deba@430
    83
	_adaptor->first(static_cast<Node&>(*this));
deba@430
    84
      }
deba@430
    85
deba@430
    86
      NodeIt(const Adaptor& adaptor, const Node& node) 
deba@430
    87
	: Node(node), _adaptor(&adaptor) {}
deba@430
    88
deba@430
    89
      NodeIt& operator++() { 
deba@430
    90
	_adaptor->next(*this);
deba@430
    91
	return *this; 
deba@430
    92
      }
deba@430
    93
deba@430
    94
    };
deba@430
    95
deba@430
    96
deba@430
    97
    class ArcIt : public Arc { 
deba@430
    98
      const Adaptor* _adaptor;
deba@430
    99
    public:
deba@430
   100
deba@430
   101
      ArcIt() { }
deba@430
   102
deba@430
   103
      ArcIt(Invalid i) : Arc(i) { }
deba@430
   104
deba@430
   105
      explicit ArcIt(const Adaptor& adaptor) : _adaptor(&adaptor) {
deba@430
   106
	_adaptor->first(static_cast<Arc&>(*this));
deba@430
   107
      }
deba@430
   108
deba@430
   109
      ArcIt(const Adaptor& adaptor, const Arc& e) : 
deba@430
   110
	Arc(e), _adaptor(&adaptor) { }
deba@430
   111
deba@430
   112
      ArcIt& operator++() { 
deba@430
   113
	_adaptor->next(*this);
deba@430
   114
	return *this; 
deba@430
   115
      }
deba@430
   116
deba@430
   117
    };
deba@430
   118
deba@430
   119
deba@430
   120
    class OutArcIt : public Arc { 
deba@430
   121
      const Adaptor* _adaptor;
deba@430
   122
    public:
deba@430
   123
deba@430
   124
      OutArcIt() { }
deba@430
   125
deba@430
   126
      OutArcIt(Invalid i) : Arc(i) { }
deba@430
   127
deba@430
   128
      OutArcIt(const Adaptor& adaptor, const Node& node) 
deba@430
   129
	: _adaptor(&adaptor) {
deba@430
   130
	_adaptor->firstOut(*this, node);
deba@430
   131
      }
deba@430
   132
deba@430
   133
      OutArcIt(const Adaptor& adaptor, const Arc& arc) 
deba@430
   134
	: Arc(arc), _adaptor(&adaptor) {}
deba@430
   135
deba@430
   136
      OutArcIt& operator++() { 
deba@430
   137
	_adaptor->nextOut(*this);
deba@430
   138
	return *this; 
deba@430
   139
      }
deba@430
   140
deba@430
   141
    };
deba@430
   142
deba@430
   143
deba@430
   144
    class InArcIt : public Arc { 
deba@430
   145
      const Adaptor* _adaptor;
deba@430
   146
    public:
deba@430
   147
deba@430
   148
      InArcIt() { }
deba@430
   149
deba@430
   150
      InArcIt(Invalid i) : Arc(i) { }
deba@430
   151
deba@430
   152
      InArcIt(const Adaptor& adaptor, const Node& node) 
deba@430
   153
	: _adaptor(&adaptor) {
deba@430
   154
	_adaptor->firstIn(*this, node);
deba@430
   155
      }
deba@430
   156
deba@430
   157
      InArcIt(const Adaptor& adaptor, const Arc& arc) : 
deba@430
   158
	Arc(arc), _adaptor(&adaptor) {}
deba@430
   159
deba@430
   160
      InArcIt& operator++() { 
deba@430
   161
	_adaptor->nextIn(*this);
deba@430
   162
	return *this; 
deba@430
   163
      }
deba@430
   164
deba@430
   165
    };
deba@430
   166
deba@430
   167
    /// \brief Base node of the iterator
deba@430
   168
    ///
deba@430
   169
    /// Returns the base node (ie. the source in this case) of the iterator
deba@430
   170
    Node baseNode(const OutArcIt &e) const {
deba@430
   171
      return Parent::source(e);
deba@430
   172
    }
deba@430
   173
    /// \brief Running node of the iterator
deba@430
   174
    ///
deba@430
   175
    /// Returns the running node (ie. the target in this case) of the
deba@430
   176
    /// iterator
deba@430
   177
    Node runningNode(const OutArcIt &e) const {
deba@430
   178
      return Parent::target(e);
deba@430
   179
    }
deba@430
   180
deba@430
   181
    /// \brief Base node of the iterator
deba@430
   182
    ///
deba@430
   183
    /// Returns the base node (ie. the target in this case) of the iterator
deba@430
   184
    Node baseNode(const InArcIt &e) const {
deba@430
   185
      return Parent::target(e);
deba@430
   186
    }
deba@430
   187
    /// \brief Running node of the iterator
deba@430
   188
    ///
deba@430
   189
    /// Returns the running node (ie. the source in this case) of the
deba@430
   190
    /// iterator
deba@430
   191
    Node runningNode(const InArcIt &e) const {
deba@430
   192
      return Parent::source(e);
deba@430
   193
    }
deba@430
   194
deba@430
   195
  };
deba@430
   196
deba@430
   197
deba@430
   198
  /// \ingroup digraphbits
deba@430
   199
  ///
deba@430
   200
  /// \brief Extender for the GraphAdaptors
deba@430
   201
  template <typename _Graph> 
deba@430
   202
  class GraphAdaptorExtender : public _Graph {
deba@430
   203
  public:
deba@430
   204
    
deba@430
   205
    typedef _Graph Parent;
deba@430
   206
    typedef _Graph Graph;
deba@430
   207
    typedef GraphAdaptorExtender Adaptor;
deba@430
   208
deba@430
   209
    typedef typename Parent::Node Node;
deba@430
   210
    typedef typename Parent::Arc Arc;
deba@430
   211
    typedef typename Parent::Edge Edge;
deba@430
   212
deba@430
   213
    // Graph extension    
deba@430
   214
deba@430
   215
    int maxId(Node) const {
deba@430
   216
      return Parent::maxNodeId();
deba@430
   217
    }
deba@430
   218
deba@430
   219
    int maxId(Arc) const {
deba@430
   220
      return Parent::maxArcId();
deba@430
   221
    }
deba@430
   222
deba@430
   223
    int maxId(Edge) const {
deba@430
   224
      return Parent::maxEdgeId();
deba@430
   225
    }
deba@430
   226
deba@430
   227
    Node fromId(int id, Node) const {
deba@430
   228
      return Parent::nodeFromId(id);
deba@430
   229
    }
deba@430
   230
deba@430
   231
    Arc fromId(int id, Arc) const {
deba@430
   232
      return Parent::arcFromId(id);
deba@430
   233
    }
deba@430
   234
deba@430
   235
    Edge fromId(int id, Edge) const {
deba@430
   236
      return Parent::edgeFromId(id);
deba@430
   237
    }
deba@430
   238
deba@430
   239
    Node oppositeNode(const Node &n, const Edge &e) const {
deba@430
   240
      if( n == Parent::u(e))
deba@430
   241
	return Parent::v(e);
deba@430
   242
      else if( n == Parent::v(e))
deba@430
   243
	return Parent::u(e);
deba@430
   244
      else
deba@430
   245
	return INVALID;
deba@430
   246
    }
deba@430
   247
deba@430
   248
    Arc oppositeArc(const Arc &a) const {
deba@430
   249
      return Parent::direct(a, !Parent::direction(a));
deba@430
   250
    }
deba@430
   251
deba@430
   252
    using Parent::direct;
deba@430
   253
    Arc direct(const Edge &e, const Node &s) const {
deba@430
   254
      return Parent::direct(e, Parent::u(e) == s);
deba@430
   255
    }
deba@430
   256
deba@430
   257
deba@430
   258
    class NodeIt : public Node { 
deba@430
   259
      const Adaptor* _adaptor;
deba@430
   260
    public:
deba@430
   261
deba@430
   262
      NodeIt() {}
deba@430
   263
deba@430
   264
      NodeIt(Invalid i) : Node(i) { }
deba@430
   265
deba@430
   266
      explicit NodeIt(const Adaptor& adaptor) : _adaptor(&adaptor) {
deba@430
   267
	_adaptor->first(static_cast<Node&>(*this));
deba@430
   268
      }
deba@430
   269
deba@430
   270
      NodeIt(const Adaptor& adaptor, const Node& node) 
deba@430
   271
	: Node(node), _adaptor(&adaptor) {}
deba@430
   272
deba@430
   273
      NodeIt& operator++() { 
deba@430
   274
	_adaptor->next(*this);
deba@430
   275
	return *this; 
deba@430
   276
      }
deba@430
   277
deba@430
   278
    };
deba@430
   279
deba@430
   280
deba@430
   281
    class ArcIt : public Arc { 
deba@430
   282
      const Adaptor* _adaptor;
deba@430
   283
    public:
deba@430
   284
deba@430
   285
      ArcIt() { }
deba@430
   286
deba@430
   287
      ArcIt(Invalid i) : Arc(i) { }
deba@430
   288
deba@430
   289
      explicit ArcIt(const Adaptor& adaptor) : _adaptor(&adaptor) {
deba@430
   290
	_adaptor->first(static_cast<Arc&>(*this));
deba@430
   291
      }
deba@430
   292
deba@430
   293
      ArcIt(const Adaptor& adaptor, const Arc& e) : 
deba@430
   294
	Arc(e), _adaptor(&adaptor) { }
deba@430
   295
deba@430
   296
      ArcIt& operator++() { 
deba@430
   297
	_adaptor->next(*this);
deba@430
   298
	return *this; 
deba@430
   299
      }
deba@430
   300
deba@430
   301
    };
deba@430
   302
deba@430
   303
deba@430
   304
    class OutArcIt : public Arc { 
deba@430
   305
      const Adaptor* _adaptor;
deba@430
   306
    public:
deba@430
   307
deba@430
   308
      OutArcIt() { }
deba@430
   309
deba@430
   310
      OutArcIt(Invalid i) : Arc(i) { }
deba@430
   311
deba@430
   312
      OutArcIt(const Adaptor& adaptor, const Node& node) 
deba@430
   313
	: _adaptor(&adaptor) {
deba@430
   314
	_adaptor->firstOut(*this, node);
deba@430
   315
      }
deba@430
   316
deba@430
   317
      OutArcIt(const Adaptor& adaptor, const Arc& arc) 
deba@430
   318
	: Arc(arc), _adaptor(&adaptor) {}
deba@430
   319
deba@430
   320
      OutArcIt& operator++() { 
deba@430
   321
	_adaptor->nextOut(*this);
deba@430
   322
	return *this; 
deba@430
   323
      }
deba@430
   324
deba@430
   325
    };
deba@430
   326
deba@430
   327
deba@430
   328
    class InArcIt : public Arc { 
deba@430
   329
      const Adaptor* _adaptor;
deba@430
   330
    public:
deba@430
   331
deba@430
   332
      InArcIt() { }
deba@430
   333
deba@430
   334
      InArcIt(Invalid i) : Arc(i) { }
deba@430
   335
deba@430
   336
      InArcIt(const Adaptor& adaptor, const Node& node) 
deba@430
   337
	: _adaptor(&adaptor) {
deba@430
   338
	_adaptor->firstIn(*this, node);
deba@430
   339
      }
deba@430
   340
deba@430
   341
      InArcIt(const Adaptor& adaptor, const Arc& arc) : 
deba@430
   342
	Arc(arc), _adaptor(&adaptor) {}
deba@430
   343
deba@430
   344
      InArcIt& operator++() { 
deba@430
   345
	_adaptor->nextIn(*this);
deba@430
   346
	return *this; 
deba@430
   347
      }
deba@430
   348
deba@430
   349
    };
deba@430
   350
deba@430
   351
    class EdgeIt : public Parent::Edge { 
deba@430
   352
      const Adaptor* _adaptor;
deba@430
   353
    public:
deba@430
   354
deba@430
   355
      EdgeIt() { }
deba@430
   356
deba@430
   357
      EdgeIt(Invalid i) : Edge(i) { }
deba@430
   358
deba@430
   359
      explicit EdgeIt(const Adaptor& adaptor) : _adaptor(&adaptor) {
deba@430
   360
	_adaptor->first(static_cast<Edge&>(*this));
deba@430
   361
      }
deba@430
   362
deba@430
   363
      EdgeIt(const Adaptor& adaptor, const Edge& e) : 
deba@430
   364
	Edge(e), _adaptor(&adaptor) { }
deba@430
   365
deba@430
   366
      EdgeIt& operator++() { 
deba@430
   367
	_adaptor->next(*this);
deba@430
   368
	return *this; 
deba@430
   369
      }
deba@430
   370
deba@430
   371
    };
deba@430
   372
deba@430
   373
    class IncEdgeIt : public Edge { 
deba@430
   374
      friend class GraphAdaptorExtender;
deba@430
   375
      const Adaptor* _adaptor;
deba@430
   376
      bool direction;
deba@430
   377
    public:
deba@430
   378
deba@430
   379
      IncEdgeIt() { }
deba@430
   380
deba@430
   381
      IncEdgeIt(Invalid i) : Edge(i), direction(false) { }
deba@430
   382
deba@430
   383
      IncEdgeIt(const Adaptor& adaptor, const Node &n) : _adaptor(&adaptor) {
deba@430
   384
	_adaptor->firstInc(static_cast<Edge&>(*this), direction, n);
deba@430
   385
      }
deba@430
   386
deba@430
   387
      IncEdgeIt(const Adaptor& adaptor, const Edge &e, const Node &n)
deba@430
   388
	: _adaptor(&adaptor), Edge(e) {
deba@430
   389
	direction = (_adaptor->u(e) == n);
deba@430
   390
      }
deba@430
   391
deba@430
   392
      IncEdgeIt& operator++() {
deba@430
   393
	_adaptor->nextInc(*this, direction);
deba@430
   394
	return *this; 
deba@430
   395
      }
deba@430
   396
    };
deba@430
   397
deba@430
   398
    /// \brief Base node of the iterator
deba@430
   399
    ///
deba@430
   400
    /// Returns the base node (ie. the source in this case) of the iterator
deba@430
   401
    Node baseNode(const OutArcIt &a) const {
deba@430
   402
      return Parent::source(a);
deba@430
   403
    }
deba@430
   404
    /// \brief Running node of the iterator
deba@430
   405
    ///
deba@430
   406
    /// Returns the running node (ie. the target in this case) of the
deba@430
   407
    /// iterator
deba@430
   408
    Node runningNode(const OutArcIt &a) const {
deba@430
   409
      return Parent::target(a);
deba@430
   410
    }
deba@430
   411
deba@430
   412
    /// \brief Base node of the iterator
deba@430
   413
    ///
deba@430
   414
    /// Returns the base node (ie. the target in this case) of the iterator
deba@430
   415
    Node baseNode(const InArcIt &a) const {
deba@430
   416
      return Parent::target(a);
deba@430
   417
    }
deba@430
   418
    /// \brief Running node of the iterator
deba@430
   419
    ///
deba@430
   420
    /// Returns the running node (ie. the source in this case) of the
deba@430
   421
    /// iterator
deba@430
   422
    Node runningNode(const InArcIt &a) const {
deba@430
   423
      return Parent::source(a);
deba@430
   424
    }
deba@430
   425
deba@430
   426
    /// Base node of the iterator
deba@430
   427
    ///
deba@430
   428
    /// Returns the base node of the iterator
deba@430
   429
    Node baseNode(const IncEdgeIt &e) const {
deba@430
   430
      return e.direction ? Parent::u(e) : Parent::v(e);
deba@430
   431
    }
deba@430
   432
    /// Running node of the iterator
deba@430
   433
    ///
deba@430
   434
    /// Returns the running node of the iterator
deba@430
   435
    Node runningNode(const IncEdgeIt &e) const {
deba@430
   436
      return e.direction ? Parent::v(e) : Parent::u(e);
deba@430
   437
    }
deba@430
   438
deba@430
   439
  };
deba@430
   440
deba@430
   441
}
deba@430
   442
deba@430
   443
deba@430
   444
#endif