Cleaned up variable elimination code in ClusterGraph
[libdai.git] / include / dai / bipgraph.h
index d7decba..62f1f57 100644 (file)
-/*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
-    Radboud University Nijmegen, The Netherlands
-    
-    This file is part of libDAI.
+/*  This file is part of libDAI - http://www.libdai.org/
+ *
+ *  libDAI is licensed under the terms of the GNU General Public License version
+ *  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-2007  Radboud University Nijmegen, The Netherlands
+ */
 
-    libDAI is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
 
-    libDAI is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with libDAI; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-*/
+/// \file
+/// \brief Defines the BipartiteGraph class, which represents a bipartite graph
 
 
 #ifndef __defined_libdai_bipgraph_h
 #define __defined_libdai_bipgraph_h
 
 
+#include <ostream>
 #include <vector>
 #include <algorithm>
-#include <boost/numeric/ublas/vector_sparse.hpp>
+#include <dai/util.h>
+#include <dai/exceptions.h>
 
 
 namespace dai {
 
 
-/// A BipartiteGraph represents a graph with two types of nodes
-template <class T1, class T2> class BipartiteGraph {
+/// 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 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. 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.
+ *  Thus, each node has an associated variable of type BipartiteGraph::Neighbors, which is a vector of
+ *  Neighbor structures, describing its neighboring nodes of the other type.
+ *  \idea Cache second-order neighborhoods in BipartiteGraph.
+ */
+class BipartiteGraph {
     public:
-        typedef std::pair<size_t,size_t>    _edge_t;
-        typedef std::vector<size_t>         _nb_t;
-        typedef _nb_t::const_iterator       _nb_cit;
-        
+        /// Describes the neighbor relationship of two nodes in a BipartiteGraph.
+        /** Sometimes we want to do an action, such as sending a
+         *  message, for all edges in a graph. However, most graphs
+         *  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
+         *  both of these problems. Each node has a list of neighbors,
+         *  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 ("_").
+         *  The neighbor list which they point into is then understood
+         *  from context. For example:
+         *
+         *  \code
+         *  void BP::calcNewMessage( size_t i, size_t _I )
+         *  \endcode
+         *
+         *  Here, \a i is the "absolute" index of node i, but \a _I is
+         *  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);
+         *  n.node == I &&
+         *  n.iter == _I &&
+         *  nb2(n.node,n.dual).node == i
+         *  \endcode
+         *
+         *  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
+         *  to one of the nodes. Such a feature has never yet been
+         *  found to be necessary. Iteration over edges can always be
+         *  accomplished using the Neighbor lists, and by writing
+         *  functions that accept relative indices:
+         *  \code
+         *  for( size_t i = 0; i < nrVars(); ++i )
+         *      foreach( const Neighbor &I, nbV(i) )
+         *          calcNewMessage( i, I.iter );
+         *  \endcode
+         */
+        struct Neighbor {
+            /// Corresponds to the index of this Neighbor entry in the vector of neighbors
+            size_t iter;
+            /// Contains the number of the neighboring node
+            size_t node;
+            /// Contains the "dual" iter
+            size_t dual;
+
+            /// Default constructor
+            Neighbor() {}
+            /// 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 \c size_t returns \c node member
+            operator size_t () const { return node; }
+        };
+
+        /// Describes the neighbors of some node.
+        typedef std::vector<Neighbor> Neighbors;
+
+        /// Represents an edge: an Edge(\a n1,\a n2) corresponds to the edge between node \a n1 of type 1 and node \a n2 of type 2.
+        typedef std::pair<size_t,size_t> Edge;
 
     private:
-        /// Vertices of first type
-        std::vector<T1>                     _V1;
+        /// Contains for each node of type 1 a vector of its neighbors
+        std::vector<Neighbors> _nb1;
 
-        /// Vertices of second type
-        std::vector<T2>                     _V2;
-        
-        /// Edges, which are pairs (v1,v2) with v1 in _V1 and v2 in _V2
-        std::vector<_edge_t>                _E12;
+        /// Contains for each node of type 2 a vector of its neighbors
+        std::vector<Neighbors> _nb2;
 
-        /// Conversion matrix that computes which index of _E12 corresponds to a vertex index pair (v1,v2)
-        std::vector<boost::numeric::ublas::mapped_vector<size_t> > _E12ind;
+        /// Used internally by isTree()
+        struct levelType {
+            /// Indices of nodes of type 1
+            std::vector<size_t> ind1;       
+            /// Indices of nodes of type 2
+            std::vector<size_t> ind2;
+        };
 
-        /// Neighbour indices of vertices of first type
-        std::vector<_nb_t>                  _nb1;
+    public:
+    /// \name Constructors and destructors
+    //@{
+        /// Default constructor (creates an empty bipartite graph)
+        BipartiteGraph() : _nb1(), _nb2() {}
+
+        /// 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.
+         */
+        template<typename EdgeInputIterator>
+        BipartiteGraph( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end ) : _nb1(), _nb2() {
+            construct( nrNodes1, nrNodes2, begin, end );
+        }
+    //@}
+
+    /// \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 \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];
+        }
 
-        /// Neighbour indices of vertices of second type
-        std::vector<_nb_t>                  _nb2;
+        /// 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 \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 \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 \a i1 of type 1
+        Neighbors & nb1( size_t i1 ) {
+            DAI_DEBASSERT( i1 < _nb1.size() );
+            return _nb1[i1];
+        }
 
-    public:
-        /// Default constructor
-        BipartiteGraph<T1,T2> () {};
-
-        /// Copy constructor
-        BipartiteGraph<T1,T2> ( const BipartiteGraph<T1,T2> & x ) : _V1(x._V1), _V2(x._V2), _E12(x._E12), _E12ind(x._E12ind), _nb1(x._nb1), _nb2(x._nb2) {};
-
-        /// Assignment operator
-        BipartiteGraph<T1,T2> & operator=(const BipartiteGraph<T1,T2> & x) {
-            if( this != &x ) {
-                _V1 =       x._V1;
-                _V2 =       x._V2;
-                _E12 =      x._E12;
-                _E12ind =   x._E12ind;
-                _nb1 =      x._nb1;
-                _nb2 =      x._nb2;
-            }
-            return *this;
+        /// 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];
         }
-        
-        /// Provides read access to node of first type
-        const T1 & V1( size_t i1 ) const { return _V1[i1]; }
-        /// Provides full access to node of first type
-        T1 & V1( size_t i1 ) { return _V1[i1]; }
-        /// Provides read access to all nodes of first type
-        const std::vector<T1> & V1s() const { return _V1; }
-        /// Provides full access to all nodes of first type
-        std::vector<T1> & V1s() { return _V1; }
-
-        /// Provides read access to node of second type
-        const T2 & V2( size_t i2 ) const { return _V2[i2]; }
-        /// Provides full access to node of second type
-        T2 & V2( size_t i2 ) { return _V2[i2]; }
-        /// Provides read access to all nodes of second type
-        const std::vector<T2> & V2s() const { return _V2; }
-        /// Provides full access to all nodes of second type
-        std::vector<T2> & V2s() { return _V2; }
-
-        /// Provides read access to edge
-        const _edge_t & edge(size_t ind) const { return _E12[ind]; }
-        /// Provides full access to edge
-        _edge_t & edge(size_t ind) { return _E12[ind]; }
-        /// Provides read access to all edges
-        const std::vector<_edge_t> & edges() const { return _E12; }
-        /// Provides full access to all edges
-        std::vector<_edge_t> & edges() { return _E12; }
-        /// Returns number of edges
-        size_t nr_edges() const { return _E12.size(); }
-
-        /// Provides read access to neighbours of node of first type
-        const _nb_t & nb1( size_t i1 ) const { return _nb1[i1]; }
-        /// Provides full access to neighbours of node of first type
-        _nb_t & nb1( size_t i1 ) { return _nb1[i1]; }
-
-        /// Provides read access to neighbours of node of second type
-        const _nb_t & nb2( size_t i2 ) const { return _nb2[i2]; }
-        /// Provides full access to neighbours of node of second type
-        _nb_t & nb2( size_t i2 ) { return _nb2[i2]; }
-
-        /// Converts the pair of indices (i1,i2) to the corresponding edge index
-        size_t VV2E( const size_t i1, const size_t i2 ) const { return _E12ind[i1](i2); }
-
-
-        /// Regenerates internal structures (_E12ind, _nb1 and _nb2) based upon _V1, _V2 and _E12
-        void Regenerate() {
-            // Calculate _nb1 and _nb2
-
-            // Start with empty vectors
-            _nb1.clear();
-            _nb1.resize(_V1.size());
-            // Start with empty vectors
-            _nb2.clear();
-            _nb2.resize(_V2.size());
-            // Each edge yields a neighbour pair
-            for( std::vector<_edge_t>::const_iterator e = _E12.begin(); e != _E12.end(); e++ ) {
-                _nb1[e->first].push_back(e->second);
-                _nb2[e->second].push_back(e->first);
-            }
-            // Remove duplicates from _nb1
-            for( size_t i1 = 0; i1 < _V1.size(); i1++ ) {
-                _nb_t::iterator new_end = unique(_nb1[i1].begin(), _nb1[i1].end());
-                _nb1[i1].erase( new_end, _nb1[i1].end() );
+        /// 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];
+        }
+    //@}
+
+    /// \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.
+         */
+        template<typename EdgeInputIterator>
+        void construct( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end );
+
+        /// 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 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 1 without neighbors and returns the index of the added node.
+        /** \deprecated Please use dai::BipartiteGraph::addNode1() instead.
+         */
+        size_t add1() { return addNode1(); }
+
+        /// Adds a node of type 2 without neighbors and returns the index of the added node.
+        /** \deprecated Please use dai::BipartiteGraph::addNode2() instead.
+         */
+        size_t add2() { return addNode2(); }
+
+        /// 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 \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 \a sizeHint.
+         *  \returns Index of the added node.
+         */
+        template <typename NodeInputIterator>
+        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 ) {
+                DAI_ASSERT( *it < nrNodes2() );
+                Neighbor nb1new( iter, *it, nb2(*it).size() );
+                Neighbor nb2new( nb2(*it).size(), nrNodes1(), iter++ );
+                nbs1new.push_back( nb1new );
+                nb2( *it ).push_back( nb2new );
             }
-            // Remove duplicates from _nb2
-            for( size_t i2 = 0; i2 < _V2.size(); i2++ ) {
-                _nb_t::iterator new_end = unique(_nb2[i2].begin(), _nb2[i2].end());
-                _nb2[i2].erase( new_end, _nb2[i2].end() );
+            _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 \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 \a sizeHint.
+         *  \returns Index of the added node.
+         */
+        template <typename NodeInputIterator>
+        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 ) {
+                DAI_ASSERT( *it < nrNodes1() );
+                Neighbor nb2new( iter, *it, nb1(*it).size() );
+                Neighbor nb1new( nb1(*it).size(), nrNodes2(), iter++ );
+                nbs2new.push_back( nb2new );
+                nb1( *it ).push_back( nb1new );
             }
+            _nb2.push_back( nbs2new );
+            return _nb2.size() - 1;
+        }
+
+        /// Adds a node of type 1, with neighbors specified by a range of nodes of type 2.
+        /** \deprecated Please use dai::BipartiteGraph::addNode1( NodeInputIterator, NodeInputIterator, size_t) instead.
+         */
+        template <typename NodeInputIterator>
+        size_t add1( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
+            return addNode1( begin, end, sizeHint );
+        }
 
-            // Calculate _E12ind
-            _E12ind = std::vector<boost::numeric::ublas::mapped_vector<size_t> >(_V1.size(), boost::numeric::ublas::mapped_vector<size_t>(_V2.size()) );            
-            for( size_t k = 0; k < _E12.size(); k++ )
-                _E12ind[_E12[k].first](_E12[k].second) = k;
-                    
+        /// Adds a node of type 2, with neighbors specified by a range of nodes of type 1.
+        /** \deprecated Please use dai::BipartiteGraph::addNode2( NodeInputIterator, NodeInputIterator, size_t) instead.
+         */
+        template <typename NodeInputIterator>
+        size_t add2( NodeInputIterator begin, NodeInputIterator end, size_t sizeHint = 0 ) {
+            return addNode2( begin, end, sizeHint );
+        }
+        
+        /// 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.
+         */
+        void 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 node \a n1 of type 1 and all incident edges; indices of other nodes are changed accordingly.
+        /** \deprecated Please use dai::BipartiteGraph::eraseNode1(size_t) instead.
+         */
+        void erase1( size_t n1 ) { eraseNode1( n1 ); }
+
+        /// Removes node \a n2 of type 2 and all incident edges; indices of other nodes are changed accordingly.
+        /** \deprecated Please use dai::BipartiteGraph::eraseNode2(size_t) instead.
+         */
+        void erase2( size_t n2 ) { eraseNode2( 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(); }
+
+        /// Returns number of nodes of type 1
+        /** \deprecated Please use dai::BipartiteGraph::nrNodes1() instead.
+         */
+        size_t nr1() const { return nrNodes1(); }
+
+        /// Returns number of nodes of type 2
+        /** \deprecated Please use dai::BipartiteGraph::nrNodes2() instead.
+         */
+        size_t nr2() const { return nrNodes2(); }
+
+        /// 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;
         }
+
+        /// 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.
+         */
+        std::vector<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.
+         */
+        std::vector<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;
+
+        /// Checks internal consistency
+        void checkConsistency() const;
+    //@}
+
+    /// \name Input and output
+    //@{
+        /// Writes this BipartiteGraph to an output stream in GraphViz .dot syntax
+        void printDot( std::ostream& os ) const;
+    //@}
 };
 
 
+template<typename EdgeInputIterator>
+void BipartiteGraph::construct( size_t nrNodes1, size_t nrNodes2, EdgeInputIterator begin, EdgeInputIterator end ) {
+    _nb1.clear();
+    _nb1.resize( nrNodes1 );
+    _nb2.clear();
+    _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
+    }
+}
+
+
 } // end of namespace dai
 
 
+/** \example example_bipgraph.cpp
+ *  This example deals with the following bipartite graph:
+ *  \dot
+ *  graph example {
+ *    ordering=out;
+ *    subgraph cluster_type1 {
+ *      node[shape=circle,width=0.4,fixedsize=true,style=filled];
+ *      12 [label="2"];
+ *      11 [label="1"];
+ *      10 [label="0"];
+ *    }
+ *    subgraph cluster_type2 {
+ *      node[shape=polygon,regular=true,sides=4,width=0.4,fixedsize=true,style=filled];
+ *      21 [label="1"];
+ *      20 [label="0"];
+ *    }
+ *    10 -- 20;
+ *    11 -- 20;
+ *    12 -- 20;
+ *    11 -- 21;
+ *    12 -- 21;
+ *  }
+ *  \enddot
+ *  It has three nodes of type 1 (drawn as circles) and two nodes of type 2 (drawn as rectangles).
+ *  Node 0 of type 1 has only one neighbor (node 0 of type 2), but node 0 of type 2 has three neighbors (nodes 0,1,2 of type 1).
+ *  The example code shows how to construct a BipartiteGraph object representing this bipartite graph and
+ *  how to iterate over nodes and their neighbors.
+ *
+ *  \section Output
+ *  \verbinclude examples/example_bipgraph.out
+ *
+ *  \section Source
+ */
+
+
 #endif