Removed obsolete/deprecated stuff
[libdai.git] / include / dai / weightedgraph.h
index 40ef21d..cc723bc 100644 (file)
@@ -1,28 +1,16 @@
-/*  Copyright (C) 2006-2008  Joris Mooij  [joris dot mooij at tuebingen dot mpg dot de]
-    Radboud University Nijmegen, The Netherlands /
-    Max Planck Institute for Biological Cybernetics, Germany
-
-    This file is part of libDAI.
-
-    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
-*/
+/*  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
+ */
 
 
 /** \file
- *  \brief Defines some utility functions for weighted graphs
- *  \todo Improve documentation
+ *  \brief Defines some utility functions for (weighted) undirected graphs, trees and rooted trees.
  *  \todo Improve general support for graphs and trees.
  */
 
@@ -35,8 +23,8 @@
 #include <map>
 #include <iostream>
 #include <set>
-#include <cassert>
 #include <limits>
+#include <climits>   // Work-around for bug in boost graph library
 
 #include <boost/graph/adjacency_list.hpp>
 #include <boost/graph/prim_minimum_spanning_tree.hpp>
 namespace dai {
 
 
-/// Represents a directed edge pointing from n1 to n2
+/// Represents a directed edge
 class DEdge {
     public:
-        size_t n1;  ///< First node index
-        size_t n2;  ///< Second node index
-    
+        /// First node index (source of edge)
+        size_t n1;
+
+        /// Second node index (sink of edge)
+        size_t n2;
+
         /// Default constructor
         DEdge() {}
 
-        /// Constructor
+        /// Constructs a directed edge pointing from \a m1 to \a m2
         DEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
 
         /// Tests for equality
@@ -68,7 +59,7 @@ class DEdge {
             return( (n1 < x.n1) || ((n1 == x.n1) && (n2 < x.n2)) );
         }
 
-        /// Writes a DEdge to an output stream
+        /// Writes a directed edge to an output stream
         friend std::ostream & operator << (std::ostream & os, const DEdge & e) {
             os << "(" << e.n1 << "," << e.n2 << ")";
             return os;
@@ -76,22 +67,24 @@ class DEdge {
 };
 
 
-/// Undirected edge between nodes n1 and n2
+/// Represents an undirected edge
 class UEdge {
     public:
-        size_t  n1;  ///< First node index
-        size_t  n2;  ///< Second node index
-    
+        /// First node index
+        size_t  n1;
+        /// Second node index
+        size_t  n2;
+
         /// Default constructor
         UEdge() {}
 
-        /// Constructor
+        /// Constructs an undirected edge between \a m1 and \a m2
         UEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
 
         /// Construct from DEdge
-        UEdge( const DEdge & e ) : n1(e.n1), n2(e.n2) {}
+        UEdge( const DEdge &e ) : n1(e.n1), n2(e.n2) {}
 
-        /// Tests for inequality (disregarding the ordering of n1 and n2)
+        /// Tests for inequality (disregarding the ordering of the nodes)
         bool operator==( const UEdge &x ) {
             return ((n1 == x.n1) && (n2 == x.n2)) || ((n1 == x.n2) && (n2 == x.n1));
         }
@@ -107,7 +100,7 @@ class UEdge {
             return( (s < xs) || ((s == xs) && (l < xl)) );
         }
 
-        /// Writes a UEdge to an output stream
+        /// Writes an undirected edge to an output stream
         friend std::ostream & operator << (std::ostream & os, const UEdge & e) {
             if( e.n1 < e.n2 )
                 os << "{" << e.n1 << "," << e.n2 << "}";
@@ -118,24 +111,46 @@ class UEdge {
 };
 
 
-/// Vector of UEdge
-typedef std::vector<UEdge>  UEdgeVec;
+/// Represents an undirected graph, implemented as a std::set of undirected edges
+class Graph : public std::set<UEdge> {
+    public:
+        /// Default constructor
+        Graph() {}
+
+        /// Construct from range of objects that can be cast to DEdge
+        template <class InputIterator>
+        Graph( InputIterator begin, InputIterator end ) {
+            insert( begin, end );
+        }
+};
 
-/// Vector of DEdge
-typedef std::vector<DEdge>  DEdgeVec;
 
-/// Represents an undirected weighted graph, with weights of type T
+/// Represents an undirected weighted graph, with weights of type \a T, implemented as a std::map mapping undirected edges to weights
 template<class T> class WeightedGraph : public std::map<UEdge, T> {};
 
-/// Represents an undirected graph
-typedef std::set<UEdge>     Graph;
 
+/// Represents a rooted tree, implemented as a vector of directed edges
+/** By convention, the edges are stored such that they point away from 
+ *  the root and such that edges nearer to the root come before edges
+ *  farther away from the root.
+ */
+class RootedTree : public std::vector<DEdge> {
+    public:
+        /// Default constructor
+        RootedTree() {}
 
-/// Uses Prim's algorithm to construct a minimal spanning tree from the (positively) weighted graph G.
+        /// Constructs a rooted tree from a tree and a root
+        /** \pre T has no cycles and contains node \a Root
+         */
+        RootedTree( const Graph &T, size_t Root );
+};
+
+
+/// Uses Prim's algorithm to construct a minimal spanning tree from the (positively) weighted graph \a G.
 /** Uses implementation in Boost Graph Library.
  */
-template<typename T> DEdgeVec MinSpanningTreePrims( const WeightedGraph<T> &G ) {
-    DEdgeVec result;
+template<typename T> RootedTree MinSpanningTreePrims( const WeightedGraph<T> &G ) {
+    RootedTree result;
     if( G.size() > 0 ) {
         using namespace boost;
         using namespace std;
@@ -159,70 +174,50 @@ template<typename T> DEdgeVec MinSpanningTreePrims( const WeightedGraph<T> &G )
         prim_minimum_spanning_tree( g, &(p[0]) );
 
         // Store tree edges in result
-        result.reserve( nodes.size() - 1 );
+        Graph tree;
         size_t root = 0;
         for( size_t i = 0; i != p.size(); i++ )
             if( p[i] != i )
-                result.push_back( DEdge( p[i], i ) );
+                tree.insert( UEdge( p[i], i ) );
             else
                 root = i;
-
-        // We have to store the minimum spanning tree in the right
-        // order, such that for all (i1, j1), (i2, j2) in result,
-        // if j1 == i2 then (i1, j1) comes before (i2, j2) in result.
-        // We do this by reordering the contents of result, effectively
-        // growing the tree starting at the root. At each step, 
-        // result[0..N-1] are the edges already added to the tree,
-        // whereas the other elements of result still have to be added.
-        // The elements of nodes are the vertices that still have to
-        // be added to the tree.
-
-        // Start with the root
-        nodes.erase( root );
-        size_t N = 0;
-
-        // Iteratively add edges and nodes to the growing tree
-        while( N != result.size() ) {
-            for( size_t e = N; e != result.size(); e++ ) {
-                bool e1_in_tree = !nodes.count( result[e].n1 );
-                if( e1_in_tree ) {
-                    nodes.erase( result[e].n2 );
-                    swap( result[N], result[e] );
-                    N++;
-                    break;
-                }
-            }
-        }
+        // Order them to obtain a rooted tree
+        result = RootedTree( tree, root );
     }
-
     return result;
 }
 
 
-/// Use Prim's algorithm to construct a minimal spanning tree from the (positively) weighted graph G.
+/// Use Prim's algorithm to construct a maximal spanning tree from the (positively) weighted graph \a G.
 /** Uses implementation in Boost Graph Library.
  */
-template<typename T> DEdgeVec MaxSpanningTreePrims( const WeightedGraph<T> & Graph ) {
-    T maxweight = Graph.begin()->second;
-    for( typename WeightedGraph<T>::const_iterator it = Graph.begin(); it != Graph.end(); it++ )
-        if( it->second > maxweight )
-            maxweight = it->second;
-    // make a copy of the graph
-    WeightedGraph<T> gr( Graph );
-    // invoke MinSpanningTreePrims with negative weights
-    // (which have to be shifted to satisfy positivity criterion)
-    for( typename WeightedGraph<T>::iterator it = gr.begin(); it != gr.end(); it++ )
-        it->second = maxweight - it->second;
-    return MinSpanningTreePrims( gr );
+template<typename T> RootedTree MaxSpanningTreePrims( const WeightedGraph<T> &G ) {
+    if( G.size() == 0 )
+        return RootedTree();
+    else {
+        T maxweight = G.begin()->second;
+        for( typename WeightedGraph<T>::const_iterator it = G.begin(); it != G.end(); it++ )
+            if( it->second > maxweight )
+                maxweight = it->second;
+        // make a copy of the graph
+        WeightedGraph<T> gr( G );
+        // invoke MinSpanningTreePrims with negative weights
+        // (which have to be shifted to satisfy positivity criterion)
+        for( typename WeightedGraph<T>::iterator it = gr.begin(); it != gr.end(); it++ )
+            it->second = maxweight - it->second;
+        return MinSpanningTreePrims( gr );
+    }
 }
 
 
-/// Constructs a rooted tree from a tree and a root
-DEdgeVec GrowRootedTree( const Graph & T, size_t Root );
-
-
-/// Constructs a random undirected graph of N nodes, where each node has connectivity d
-UEdgeVec RandomDRegularGraph( size_t N, size_t d );
+/// Constructs a random undirected graph of \a N nodes, where each node has connectivity \a d
+/** Algorithm 1 in [\ref StW99].
+ *  Draws a random graph of size \a N and uniform degree \a d
+ *  from an almost uniform probability distribution over these graphs
+ *  (which becomes uniform in the limit that \a d is small and \a N goes
+ *  to infinity).
+ */
+Graph RandomDRegularGraph( size_t N, size_t d );
 
 
 } // end of namespace dai