Added DAG class and various minor improvements
[libdai.git] / include / dai / bipgraph.h
index d32ddfe..4dbd543 100644 (file)
@@ -4,13 +4,13 @@
  *  2, or (at your option) any later version. libDAI is distributed without any
  *  warranty. See the file COPYING for more details.
  *
- *  Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at libdai dot org]
+ *  Copyright (C) 2006-2010  Joris Mooij  [joris dot mooij at libdai dot org]
  *  Copyright (C) 2006-2007  Radboud University Nijmegen, The Netherlands
  */
 
 
 /// \file
-/// \brief Defines BipartiteGraph class
+/// \brief Defines the BipartiteGraph class, which represents a bipartite graph
 
 
 #ifndef __defined_libdai_bipgraph_h
 
 #include <ostream>
 #include <vector>
-#include <cassert>
 #include <algorithm>
 #include <dai/util.h>
+#include <dai/smallset.h>
+#include <dai/exceptions.h>
 
 
 namespace dai {
 
 
-/// Represents the neighborhood structure of nodes in a bipartite graph.
+/// Represents the neighborhood structure of nodes in an undirected, bipartite graph.
 /** A bipartite graph has two types of nodes: type 1 and type 2. Edges can occur only between
- *  nodes of different type. Nodes are indexed by an unsigned integer. If there are nr1()
- *  nodes of type 1 and nr2() nodes of type 2, the nodes of type 1 are numbered
- *  0,1,2,...,nr1()-1 and the nodes of type 2 are numbered 0,1,2,...,nr2()-1. An edge
+ *  nodes of different type. Nodes are indexed by an unsigned integer. If there are nrNodes1()
+ *  nodes of type 1 and nrNodes2() nodes of type 2, the nodes of type 1 are numbered
+ *  0,1,2,...,nrNodes1()-1 and the nodes of type 2 are numbered 0,1,2,...,nrNodes2()-1. An edge
  *  between node \a n1 of type 1 and node \a n2 of type 2 is represented by a BipartiteGraph::Edge(\a n1,\a n2).
  *
  *  A BipartiteGraph is implemented as a sparse adjacency list, i.e., it stores for each node a list of
- *  its neighboring nodes. In particular, it stores for each node of type 1 a vector of Neighbor structures
+ *  its neighboring nodes. More precisely: it stores for each node of type 1 a vector of Neighbor structures
  *  (accessible by the nb1() method) describing the neighboring nodes of type 2; similarly, for each node
  *  of type 2 it stores a vector of Neighbor structures (accessibly by the nb2() method) describing the
  *  neighboring nodes of type 1.
@@ -51,12 +52,13 @@ class BipartiteGraph {
          *  will be sparse, so we need some way of storing a set of
          *  the neighbors of a node, which is both fast and
          *  memory-efficient. We also need to be able to go between
-         *  viewing node \a A as a neighbor of node \a B, and node \a
-         *  B as a neighbor of node \a A. The Neighbor struct solves
+         *  viewing node \a a as a neighbor of node \a b, and node \a b
+         *  as a neighbor of node \a a. The Neighbor struct solves
          *  both of these problems. Each node has a list of neighbors,
-         *  stored as a vector<Neighbor>, and extra information is
-         *  included in the Neighbor struct which allows us to access
-         *  a node as a neighbor of its neighbor (the \a dual member).
+         *  stored as a std::vector<\link Neighbor \endlink>, and 
+         *  extra information is included in the Neighbor struct which 
+         *  allows us to access a node as a neighbor of its neighbor 
+         *  (the \c dual member).
          *
          *  By convention, variable identifiers naming indices into a
          *  vector of neighbors are prefixed with an underscore ("_").
@@ -68,14 +70,14 @@ class BipartiteGraph {
          *  \endcode
          *
          *  Here, \a i is the "absolute" index of node i, but \a _I is
-         *  understood as a "relative" index, giving node I's entry in
-         *  nb1(i). The corresponding Neighbor structure can be
-         *  accessed as nb1(i,_I) or nb1(i)[_I]. The absolute index of
-         *  \a _I, which would be called \a I, can be recovered from
-         *  the \a node member: nb1(i,_I).node. The \a iter member
-         *  gives the relative index \a _I, and the \a dual member
-         *  gives the "dual" relative index, i.e. the index of \a i in
-         *  \a I's neighbor list.
+         *  understood as a "relative" index, giving node \a I 's entry in
+         *  <tt>nb1(i)</tt>. The corresponding Neighbor structure can be
+         *  accessed as <tt>nb1(i,_I)</tt> or <tt>nb1(i)[_I]</tt>. The 
+         *  absolute index of \a _I, which would be called \a I, can be 
+         *  recovered from the \c node member: <tt>nb1(i,_I).node</tt>. 
+         *  The \c iter member gives the relative index \a _I, and the 
+         *  \c dual member gives the "dual" relative index, i.e., the 
+         *  index of \a i in \a I 's neighbor list.
          *
          *  \code
          *  Neighbor n = nb1(i,_I);
@@ -84,8 +86,9 @@ class BipartiteGraph {
          *  nb2(n.node,n.dual).node == i
          *  \endcode
          *
-         *  In a FactorGraph, nb1 is called nbV, and nb2 is called
-         *  nbF.
+         *  In a FactorGraph, the nodes of type 1 represent variables, and
+         *  the nodes of type 2 represent factors. For convenience, nb1() is 
+         *  called FactorGraph::nbV(), and nb2() is called FactorGraph::nbF().
          *
          *  There is no easy way to transform a pair of absolute node
          *  indices \a i and \a I into a Neighbor structure relative
@@ -112,7 +115,7 @@ class BipartiteGraph {
             /// Constructor that sets the Neighbor members according to the parameters
             Neighbor( size_t iter, size_t node, size_t dual ) : iter(iter), node(node), dual(dual) {}
 
-            /// Cast to size_t returns node member
+            /// Cast to \c size_t returns \c node member
             operator size_t () const { return node; }
         };
 
@@ -131,290 +134,299 @@ class BipartiteGraph {
 
         /// Used internally by isTree()
         struct levelType {
-            std::vector<size_t> ind1;       // indices of nodes of type 1
-            std::vector<size_t> ind2;       // indices of nodes of type 2
+            /// Indices of nodes of type 1
+            std::vector<size_t> ind1;       
+            /// Indices of nodes of type 2
+            std::vector<size_t> ind2;
         };
 
-        // OBSOLETE
-        /// @name Backwards compatibility layer (to be removed soon)
-        //@{
-        /// Enable backwards compatibility layer?
-        bool _edge_indexed;
-        /// Call indexEdges() first to initialize these members
-        std::vector<Edge> _edges;
-        /// Call indexEdges() first to initialize these members
-        hash_map<Edge,size_t> _vv2e;
-        //}@
-
     public:
+    /// \name Constructors and destructors
+    //@{
         /// Default constructor (creates an empty bipartite graph)
-        BipartiteGraph() : _nb1(), _nb2(), _edge_indexed(false) {}
+        BipartiteGraph() : _nb1(), _nb2() {}
+
+        /// Constructs BipartiteGraph with \a nr1 nodes of type 1, \a nr2 nodes of type 2 and no edges.
+        BipartiteGraph( size_t nr1, size_t nr2 ) : _nb1(nr1), _nb2(nr2) {}
 
         /// Constructs BipartiteGraph from a range of edges.
         /** \tparam EdgeInputIterator Iterator that iterates over instances of BipartiteGraph::Edge.
-         *  \param nr1 The number of nodes of type 1.
-         *  \param nr2 The number of nodes of type 2.
+         *  \param nrNodes1 The number of nodes of type 1.
+         *  \param nrNodes2 The number of nodes of type 2.
          *  \param begin Points to the first edge.
          *  \param end Points just beyond the last edge.
+         *  \param check Whether to only add an edge if it does not exist already.
          */
         template<typename EdgeInputIterator>
-        BipartiteGraph( size_t nr1, size_t nr2, EdgeInputIterator begin, EdgeInputIterator end ) : _nb1( nr1 ), _nb2( nr2 ), _edge_indexed(false) {
-            construct( nr1, nr2, begin, end );
+        BipartiteGraph( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end, bool check=true ) : _nb1(), _nb2() {
+            construct( nrNodes1, nrNodes2, begin, end, check );
         }
+    //@}
 
-        /// (Re)constructs BipartiteGraph from a range of edges.
-        /** \tparam EdgeInputIterator Iterator that iterates over instances of BipartiteGraph::Edge.
-         *  \param nr1 The number of nodes of type 1.
-         *  \param nr2 The number of nodes of type 2.
-         *  \param begin Points to the first edge.
-         *  \param end Points just beyond the last edge.
-         */
-        template<typename EdgeInputIterator>
-        void construct( size_t nr1, size_t nr2, EdgeInputIterator begin, EdgeInputIterator end );
-
-        /// Returns constant reference to the _i2'th neighbor of node i1 of type 1
+    /// \name Accessors and mutators
+    //@{
+        /// Returns constant reference to the \a _i2 'th neighbor of node \a i1 of type 1
         const Neighbor & nb1( size_t i1, size_t _i2 ) const {
             DAI_DEBASSERT( i1 < _nb1.size() );
             DAI_DEBASSERT( _i2 < _nb1[i1].size() );
             return _nb1[i1][_i2];
         }
-        /// Returns reference to the _i2'th neighbor of node i1 of type 1
+        /// Returns reference to the \a _i2 'th neighbor of node \a i1 of type 1
         Neighbor & nb1( size_t i1, size_t _i2 ) {
             DAI_DEBASSERT( i1 < _nb1.size() );
             DAI_DEBASSERT( _i2 < _nb1[i1].size() );
             return _nb1[i1][_i2];
         }
 
-        /// Returns constant reference to the _i1'th neighbor of node i2 of type 2
+        /// Returns constant reference to the \a _i1 'th neighbor of node \a i2 of type 2
         const Neighbor & nb2( size_t i2, size_t _i1 ) const {
             DAI_DEBASSERT( i2 < _nb2.size() );
             DAI_DEBASSERT( _i1 < _nb2[i2].size() );
             return _nb2[i2][_i1];
         }
-        /// Returns reference to the _i1'th neighbor of node i2 of type 2
+        /// Returns reference to the \a _i1 'th neighbor of node \a i2 of type 2
         Neighbor & nb2( size_t i2, size_t _i1 ) {
             DAI_DEBASSERT( i2 < _nb2.size() );
             DAI_DEBASSERT( _i1 < _nb2[i2].size() );
             return _nb2[i2][_i1];
         }
 
-        /// Returns constant reference to all neighbors of node i1 of type 1
+        /// Returns constant reference to all neighbors of node \a i1 of type 1
         const Neighbors & nb1( size_t i1 ) const {
             DAI_DEBASSERT( i1 < _nb1.size() );
             return _nb1[i1];
         }
-        /// Returns reference to all neighbors of node of i1 type 1
+        /// Returns reference to all neighbors of node \a i1 of type 1
         Neighbors & nb1( size_t i1 ) {
             DAI_DEBASSERT( i1 < _nb1.size() );
             return _nb1[i1];
         }
 
-        /// Returns constant reference to all neighbors of node i2 of type 2
+        /// Returns constant reference to all neighbors of node \a i2 of type 2
         const Neighbors & nb2( size_t i2 ) const {
             DAI_DEBASSERT( i2 < _nb2.size() );
             return _nb2[i2];
         }
-        /// Returns reference to all neighbors of node i2 of type 2
+        /// Returns reference to all neighbors of node \a i2 of type 2
         Neighbors & nb2( size_t i2 ) {
             DAI_DEBASSERT( i2 < _nb2.size() );
             return _nb2[i2];
         }
+    //@}
 
-        /// Returns number of nodes of type 1
-        size_t nr1() const { return _nb1.size(); }
-        /// Returns number of nodes of type 2
-        size_t nr2() const { return _nb2.size(); }
+    /// \name Adding nodes and edges
+    //@{
+        /// (Re)constructs BipartiteGraph from a range of edges.
+        /** \tparam EdgeInputIterator Iterator that iterates over instances of BipartiteGraph::Edge.
+         *  \param nrNodes1 The number of nodes of type 1.
+         *  \param nrNodes2 The number of nodes of type 2.
+         *  \param begin Points to the first edge.
+         *  \param end Points just beyond the last edge.
+         *  \param check Whether to only add an edge if it does not exist already.
+         */
+        template<typename EdgeInputIterator>
+        void construct( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end, bool check=true );
 
-        /// Calculates the number of edges, time complexity: O(nr1())
-        size_t nrEdges() const {
-            size_t sum = 0;
-            for( size_t i1 = 0; i1 < nr1(); i1++ )
-                sum += nb1(i1).size();
-            return sum;
-        }
+        /// Adds a node of type 1 without neighbors and returns the index of the added node.
+        size_t addNode1() { _nb1.push_back( Neighbors() ); return _nb1.size() - 1; }
 
-        /// Adds a node of type 1 without neighbors.
-        void add1() { _nb1.push_back( Neighbors() ); }
+        /// Adds a node of type 2 without neighbors and returns the index of the added node.
+        size_t addNode2() { _nb2.push_back( Neighbors() ); return _nb2.size() - 1; }
 
-        /// Adds a node of type 2 without neighbors.
-        void add2() { _nb2.push_back( Neighbors() ); }
 
         /// Adds a node of type 1, with neighbors specified by a range of nodes of type 2.
-        /** \tparam NodeInputIterator Iterator that iterates over instances of size_t.
+        /** \tparam NodeInputIterator Iterator that iterates over instances of \c size_t.
          *  \param begin Points to the first index of the nodes of type 2 that should become neighbors of the added node.
          *  \param end Points just beyond the last index of the nodes of type 2 that should become neighbors of the added node.
-         *  \param sizeHint For improved efficiency, the size of the range may be specified by sizeHint.
+         *  \param sizeHint For improved efficiency, the size of the range may be specified by \a sizeHint.
+         *  \returns Index of the added node.
          */
         template <typename NodeInputIterator>
-        void add1( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
+        size_t addNode1( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
             Neighbors nbs1new;
             nbs1new.reserve( sizeHint );
             size_t iter = 0;
             for( NodeInputIterator it = begin; it != end; ++it ) {
-                assert( *it < nr2() );
+                DAI_ASSERT( *it < nrNodes2() );
                 Neighbor nb1new( iter, *it, nb2(*it).size() );
-                Neighbor nb2new( nb2(*it).size(), nr1(), iter++ );
+                Neighbor nb2new( nb2(*it).size(), nrNodes1(), iter++ );
                 nbs1new.push_back( nb1new );
                 nb2( *it ).push_back( nb2new );
             }
             _nb1.push_back( nbs1new );
+            return _nb1.size() - 1;
         }
 
         /// Adds a node of type 2, with neighbors specified by a range of nodes of type 1.
-        /** \tparam NodeInputIterator Iterator that iterates over instances of size_t.
+        /** \tparam NodeInputIterator Iterator that iterates over instances of \c size_t.
          *  \param begin Points to the first index of the nodes of type 1 that should become neighbors of the added node.
          *  \param end Points just beyond the last index of the nodes of type 1 that should become neighbors of the added node.
-         *  \param sizeHint For improved efficiency, the size of the range may be specified by sizeHint.
+         *  \param sizeHint For improved efficiency, the size of the range may be specified by \a sizeHint.
+         *  \returns Index of the added node.
          */
         template <typename NodeInputIterator>
-        void add2( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
+        size_t addNode2( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
             Neighbors nbs2new;
             nbs2new.reserve( sizeHint );
             size_t iter = 0;
             for( NodeInputIterator it = begin; it != end; ++it ) {
-                assert( *it < nr1() );
+                DAI_ASSERT( *it < nrNodes1() );
                 Neighbor nb2new( iter, *it, nb1(*it).size() );
-                Neighbor nb1new( nb1(*it).size(), nr2(), iter++ );
+                Neighbor nb1new( nb1(*it).size(), nrNodes2(), iter++ );
                 nbs2new.push_back( nb2new );
                 nb1( *it ).push_back( nb1new );
             }
             _nb2.push_back( nbs2new );
+            return _nb2.size() - 1;
         }
 
-        /// Removes node n1 of type 1 and all incident edges.
-        void erase1( size_t n1 );
-
-        /// Removes node n2 of type 2 and all incident edges.
-        void erase2( size_t n2 );
-
-        /// Removes edge between node n1 of type 1 and node n2 of type 2.
-        void eraseEdge( size_t n1, size_t n2 ) {
-            assert( n1 < nr1() );
-            assert( n2 < nr2() );
-            for( Neighbors::iterator i1 = _nb1[n1].begin(); i1 != _nb1[n1].end(); i1++ )
-                if( i1->node == n2 ) {
-                    _nb1[n1].erase( i1 );
-                    break;
-                }
-            for( Neighbors::iterator i2 = _nb2[n2].begin(); i2 != _nb2[n2].end(); i2++ )
-                if( i2->node == n1 ) {
-                    _nb2[n2].erase( i2 );
-                    break;
-                }
+        /// Adds an edge between node \a n1 of type 1 and node \a n2 of type 2.
+        /** If \a check == \c true, only adds the edge if it does not exist already.
+         */
+        BipartiteGraph& addEdge( size_t n1, size_t n2, bool check = true );
+    //@}
+
+    /// \name Erasing nodes and edges
+    //@{
+        /// Removes node \a n1 of type 1 and all incident edges; indices of other nodes are changed accordingly.
+        void eraseNode1( size_t n1 );
+
+        /// Removes node \a n2 of type 2 and all incident edges; indices of other nodes are changed accordingly.
+        void eraseNode2( size_t n2 );
+
+        /// Removes edge between node \a n1 of type 1 and node \a n2 of type 2.
+        void eraseEdge( size_t n1, size_t n2 );
+    //@}
+
+    /// \name Queries
+    //@{
+        /// Returns number of nodes of type 1
+        size_t nrNodes1() const { return _nb1.size(); }
+        /// Returns number of nodes of type 2
+        size_t nrNodes2() const { return _nb2.size(); }
+
+        /// Calculates the number of edges, time complexity: O(nrNodes1())
+        size_t nrEdges() const {
+            size_t sum = 0;
+            for( size_t i1 = 0; i1 < nrNodes1(); i1++ )
+                sum += nb1(i1).size();
+            return sum;
         }
 
-        /// Adds an edge between node n1 of type 1 and node n2 of type 2.
-        /** If check == true, only adds the edge if it does not exist already.
+        /// Returns true if the graph contains an edge between node \a n1 of type 1 and node \a n2 of type 2.
+        /** \note The time complexity is linear in the number of neighbors of \a n1 or \a n2
          */
-        void addEdge( size_t n1, size_t n2, bool check = true ) {
-            assert( n1 < nr1() );
-            assert( n2 < nr2() );
-            bool exists = false;
-            if( check ) {
-                // Check whether the edge already exists
-                foreach( const Neighbor &nb2, nb1(n1) )
-                    if( nb2 == n2 ) {
-                        exists = true;
-                        break;
-                    }
-            }
-            if( !exists ) { // Add edge
-                Neighbor nb_1( _nb1[n1].size(), n2, _nb2[n2].size() );
-                Neighbor nb_2( nb_1.dual, n1, nb_1.iter );
-                _nb1[n1].push_back( nb_1 );
-                _nb2[n2].push_back( nb_2 );
+        bool hasEdge( size_t n1, size_t n2 ) const {
+            if( nb1(n1).size() < nb2(n2).size() ) {
+                for( size_t _n2 = 0; _n2 < nb1(n1).size(); _n2++ )
+                    if( nb1( n1, _n2 ) == n2 )
+                        return true;
+            } else {
+                for( size_t _n1 = 0; _n1 < nb2(n2).size(); _n1++ )
+                    if( nb2( n2, _n1 ) == n1 )
+                        return true;
             }
+            return false;
         }
 
-        /// Calculates second-order neighbors (i.e., neighbors of neighbors) of node n1 of type 1.
-        /** If include == true, includes n1 itself, otherwise excludes n1.
+        /// Returns the index of a given node \a n2 of type 2 amongst the neighbors of node \a n1 of type 1
+        /** \note The time complexity is linear in the number of neighbors of \a n1
+         *  \throw OBJECT_NOT_FOUND if \a n2 is not a neighbor of \a n1
          */
-        std::vector<size_t> delta1( size_t n1, bool include = false ) const;
+        size_t findNb1( size_t n1, size_t n2 ) {
+            for( size_t _n2 = 0; _n2 < nb1(n1).size(); _n2++ )
+                if( nb1( n1, _n2 ) == n2 )
+                    return _n2;
+            DAI_THROW(OBJECT_NOT_FOUND);
+            return nb1(n1).size();
+        }
 
-        /// Calculates second-order neighbors (i.e., neighbors of neighbors) of node n2 of type 2.
-        /** If include == true, includes n2 itself, otherwise excludes n2.
+        /// Returns the index of a given node \a n1 of type 1 amongst the neighbors of node \a n2 of type 2
+        /** \note The time complexity is linear in the number of neighbors of \a n2
+         *  \throw OBJECT_NOT_FOUND if \a n1 is not a neighbor of \a n2
          */
-        std::vector<size_t> delta2( size_t n2, bool include = false ) const;
+        size_t findNb2( size_t n1, size_t n2 ) {
+            for( size_t _n1 = 0; _n1 < nb2(n2).size(); _n1++ )
+                if( nb2( n2, _n1 ) == n1 )
+                    return _n1;
+            DAI_THROW(OBJECT_NOT_FOUND);
+            return nb2(n2).size();
+        }
 
-        /// Returns true if the graph is connected
-        /** \todo Should be optimized by invoking boost::graph library
+        /// Returns neighbors of node \a n1 of type 1 as a SmallSet<size_t>.
+        SmallSet<size_t> nb1Set( size_t n1 ) const;
+
+        /// Returns neighbors of node \a n2 of type 2 as a SmallSet<size_t>.
+        SmallSet<size_t> nb2Set( size_t n2 ) const;
+
+        /// Calculates second-order neighbors (i.e., neighbors of neighbors) of node \a n1 of type 1.
+        /** If \a include == \c true, includes \a n1 itself, otherwise excludes \a n1.
+         *  \note In libDAI versions 0.2.4 and earlier, this function used to return a std::vector<size_t>
+         */
+        SmallSet<size_t> delta1( size_t n1, bool include = false ) const;
+
+        /// Calculates second-order neighbors (i.e., neighbors of neighbors) of node \a n2 of type 2.
+        /** If \a include == \c true, includes \a n2 itself, otherwise excludes \a n2.
+         *  \note In libDAI versions 0.2.4 and earlier, this function used to return a std::vector<size_t>
          */
+        SmallSet<size_t> delta2( size_t n2, bool include = false ) const;
+
+        /// Returns true if the graph is connected
         bool isConnected() const;
 
         /// Returns true if the graph is a tree, i.e., if it is singly connected and connected.
         bool isTree() const;
 
-        /// Writes this BipartiteGraph to an output stream in GraphViz .dot syntax
-        void printDot( std::ostream& os ) const;
-
-        // OBSOLETE
-        /// @name Backwards compatibility layer (to be removed soon)
-        //@{
-        void indexEdges() {
-            std::cerr << "Warning: this BipartiteGraph edge interface is obsolete!" << std::endl;
-            _edges.clear();
-            _vv2e.clear();
-            size_t i=0;
-            foreach(const Neighbors &nb1s, _nb1) {
-                foreach(const Neighbor &n2, nb1s) {
-                    Edge e(i, n2.node);
-                    _edges.push_back(e);
-                }
-                i++;
-            }
-            sort(_edges.begin(), _edges.end()); // unnecessary?
-
-            i=0;
-            foreach(const Edge& e, _edges) {
-                _vv2e[e] = i++;
+        /// Comparison operator which returns true if two graphs are identical
+        /** \note Two graphs are called identical if they have the same number of nodes
+         *  of both types and the same edges (i.e., \a x has an edge between nodes
+         *  \a n1 and \a n2 if and only if \c *this has an edge between nodes \a n1 and \a n2).
+         */
+        bool operator==( const BipartiteGraph& x ) const {
+            if( nrNodes1() != x.nrNodes1() )
+                return false;
+            if( nrNodes2() != x.nrNodes2() )
+                return false;
+            for( size_t n1 = 0; n1 < nrNodes1(); n1++ ) {
+                if( nb1(n1).size() != x.nb1(n1).size() )
+                    return false;
+                foreach( const Neighbor &n2, nb1(n1) )
+                    if( !x.hasEdge( n1, n2 ) )
+                        return false;
+                foreach( const Neighbor &n2, x.nb1(n1) )
+                    if( !hasEdge( n1, n2 ) )
+                        return false;
             }
-
-            _edge_indexed = true;
+            return true;
         }
 
-        const Edge& edge(size_t e) const {
-            assert(_edge_indexed);
-            return _edges[e];
-        }
+        /// Asserts internal consistency
+        void checkConsistency() const;
+    //@}
 
-        const std::vector<Edge>& edges() const {
-            return _edges;
-        }
-
-        size_t VV2E(size_t n1, size_t n2) const {
-            assert(_edge_indexed);
-            Edge e(n1,n2);
-            hash_map<Edge,size_t>::const_iterator i = _vv2e.find(e);
-            assert(i != _vv2e.end());
-            return i->second;
-        }
+    /// \name Input and output
+    //@{
+        /// Writes this BipartiteGraph to an output stream in GraphViz .dot syntax
+        void printDot( std::ostream& os ) const;
 
-        size_t nr_edges() const {
-            assert(_edge_indexed);
-            return _edges.size();
+        /// Writes this BipartiteGraph to an output stream
+        friend std::ostream& operator<<( std::ostream& os, const BipartiteGraph& g ) {
+            g.printDot( os );
+            return os;
         }
-        //}@
-
-    private:
-        /// Checks internal consistency
-        void check() const;
+    //@}
 };
 
 
 template<typename EdgeInputIterator>
-void BipartiteGraph::construct( size_t nr1, size_t nr2, EdgeInputIterator begin, EdgeInputIterator end ) {
+void BipartiteGraph::construct( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end, bool check ) {
     _nb1.clear();
-    _nb1.resize( nr1 );
+    _nb1.resize( nrNodes1 );
     _nb2.clear();
-    _nb2.resize( nr2 );
+    _nb2.resize( nrNodes2 );
 
-    for( EdgeInputIterator e = begin; e != end; e++ ) {
-#ifdef DAI_DEBUG
-        addEdge( e->first, e->second, true );
-#else
-        addEdge( e->first, e->second, false );
-#endif
-    }
+    for( EdgeInputIterator e = begin; e != end; e++ )
+        addEdge( e->first, e->second, check );
 }