Removed obsolete/deprecated stuff
[libdai.git] / include / dai / weightedgraph.h
index 231a37d..cc723bc 100644 (file)
@@ -1,22 +1,18 @@
-/*  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.
-
-    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.
+/*  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 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 some utility functions for (weighted) undirected graphs, trees and rooted trees.
+ *  \todo Improve general support for graphs and trees.
+ */
 
 
 #ifndef __defined_libdai_weightedgraph_h
 #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 {
 
 
-/// Directed edge
+/// Represents a directed edge
 class DEdge {
     public:
-        size_t  n1, n2;
-    
+        /// First node index (source of edge)
+        size_t n1;
+
+        /// Second node index (sink of edge)
+        size_t n2;
+
+        /// Default constructor
         DEdge() {}
+
+        /// Constructs a directed edge pointing from \a m1 to \a m2
         DEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
-        bool operator==( const DEdge &x ) const {
-            return ((n1 == x.n1) && (n2 == x.n2));
-        }
-        bool operator!=( const DEdge &x ) const {
-            return !(*this == x);
-        }
+
+        /// Tests for equality
+        bool operator==( const DEdge &x ) const { return ((n1 == x.n1) && (n2 == x.n2)); }
+
+        /// Tests for inequality
+        bool operator!=( const DEdge &x ) const { return !(*this == x); }
+
+        /// Smaller-than operator (performs lexicographical comparison)
         bool operator<( const DEdge &x ) const {
             return( (n1 < x.n1) || ((n1 == x.n1) && (n2 < x.n2)) );
         }
+
+        /// 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;
@@ -61,17 +67,29 @@ class DEdge {
 };
 
 
-/// Undirected edge
+/// Represents an undirected edge
 class UEdge {
     public:
-        size_t  n1, n2;
-    
+        /// First node index
+        size_t  n1;
+        /// Second node index
+        size_t  n2;
+
+        /// Default constructor
         UEdge() {}
+
+        /// Constructs an undirected edge between \a m1 and \a m2
         UEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
-        UEdge( const DEdge & e ) : n1(e.n1), n2(e.n2) {}
+
+        /// Construct from DEdge
+        UEdge( const DEdge &e ) : n1(e.n1), n2(e.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));
         }
+
+        /// Smaller-than operator
         bool operator<( const UEdge &x ) const {
             size_t s = n1, l = n2;
             if( s > l )
@@ -81,6 +99,8 @@ class UEdge {
                 std::swap( xs, xl );
             return( (s < xs) || ((s == xs) && (l < xl)) );
         }
+
+        /// 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 << "}";
@@ -91,17 +111,47 @@ class UEdge {
 };
 
 
-typedef std::vector<UEdge>  UEdgeVec;
-typedef std::vector<DEdge>  DEdgeVec;
+/// 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 );
+        }
+};
+
+
+/// 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> {};
-typedef std::set<UEdge>     Graph;
 
 
-/// Use Prim's algorithm to construct a minimal spanning tree from the weighted graph Graph
-/// The weights should be positive. Use implementation in Boost Graph Library.
-template<typename T> DEdgeVec MinSpanningTreePrims( const WeightedGraph<T> & Graph ) {
-    DEdgeVec result;
-    if( Graph.size() > 0 ) {
+/// 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() {}
+
+        /// 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> RootedTree MinSpanningTreePrims( const WeightedGraph<T> &G ) {
+    RootedTree result;
+    if( G.size() > 0 ) {
         using namespace boost;
         using namespace std;
         typedef adjacency_list< vecS, vecS, undirectedS, property<vertex_distance_t, int>, property<edge_weight_t, double> > boostGraph;
@@ -110,9 +160,9 @@ template<typename T> DEdgeVec MinSpanningTreePrims( const WeightedGraph<T> & Gra
         set<size_t> nodes;
         vector<E> edges;
         vector<double> weights;
-        edges.reserve( Graph.size() );
-        weights.reserve( Graph.size() );
-        for( typename WeightedGraph<T>::const_iterator e = Graph.begin(); e != Graph.end(); e++ ) {
+        edges.reserve( G.size() );
+        weights.reserve( G.size() );
+        for( typename WeightedGraph<T>::const_iterator e = G.begin(); e != G.end(); e++ ) {
             weights.push_back( e->second );
             edges.push_back( E( e->first.n1, e->first.n2 ) );
             nodes.insert( e->first.n1 );
@@ -124,149 +174,50 @@ template<typename T> DEdgeVec MinSpanningTreePrims( const WeightedGraph<T> & Gra
         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 maximal spanning tree from the weighted graph Graph
-/// The weights should be positive. Use 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 );
+/// 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> 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 );
+    }
 }
 
 
-/// Calculate rooted tree from a tree T and a root
-DEdgeVec GrowRootedTree( const Graph & T, size_t Root );
-
-
-UEdgeVec RandomDRegularGraph( size_t N, size_t d );
-
-
-/// Use Dijkstra's algorithm to solve the shortest path problem for the weighted graph Graph and source vertex index s
-template<typename T>
-std::map<size_t,size_t> DijkstraShortestPaths( const WeightedGraph<T> & Graph, size_t s ) {
-/*
- * from wikipedia 
- *
-In the following algorithm, u := Extract_Min(Q) searches for the vertex u in the vertex set Q that has the least d[u] value. That vertex is removed from the set Q and returned to the user.
-
-  function Dijkstra(G, w, s)
-     for each vertex v in V[G]                        // Initializations
-           d[v] := infinity                                 // Unknown distance function from s to v
-           previous[v] := undefined
-     d[s] := 0                                        // Distance from s to s
-     S := empty set                                   // Set of all visited vertices
-     Q := V[G]                                        // Set of all unvisited vertices
-     while Q is not an empty set                      // The algorithm itself
-           u := Extract_Min(Q)                        // Remove best vertex from priority queue
-           S := S union {u}                           // Mark it 'visited'
-           for each edge (u,v) outgoing from u
-                  if d[u] + w(u,v) < d[v]             // Relax (u,v)
-                        d[v] := d[u] + w(u,v) 
-                        previous[v] := u
-
-To find the shortest path from s to t:
-
-u := t
-while defined previous[u]
-      insert u to the beginning of S
-      u := previous[u]
-       
-*/
-
-    // Calculate set of nodes in G
-    std::set<size_t> nodes;
-    for( typename WeightedGraph<T>::const_iterator e = Graph.begin(); e != Graph.end(); e++ ) {
-        nodes.insert( e->n1.n1 );
-        nodes.insert( e->n1.n2 );
-    }
-    if( !nodes.count( s ) )
-        return std::map<size_t, size_t>();
-
-    std::map<size_t, double> d;
-    std::map<size_t, size_t> previous;
-    for( std::set<size_t>::const_iterator n = nodes.begin(); n != nodes.end(); n++ )
-        d[*n] = std::numeric_limits<double>::infinity();
-
-    d[s] = 0;
-    std::set<size_t> S;
-    std::set<size_t> Q = nodes;
-
-    while( Q.size() ) {
-        double least = d[*Q.begin()];
-        std::set<size_t>::iterator u_least = Q.begin();
-        for( std::set<size_t>::iterator _u = Q.begin(); _u != Q.end(); _u++ )
-            if( d[*_u] < least ) {
-                u_least = _u;
-                least = d[*_u];
-            }
-        size_t u = *u_least;
-        Q.erase( u_least );
-            
-        S.insert( u );
-        for( typename WeightedGraph<T>::const_iterator e = Graph.begin(); e != Graph.end(); e++ ) {
-            size_t v;
-            if( e->n1.n1 == u )
-                v = e->n1.n2;
-            else if( e->n1.n2 == u )
-                v = e->n1.n1;
-            else
-                continue;
-            if( d[u] + e->n2 < d[v] ) {
-                d[v] = d[u] + e->n2;
-                previous[v] = u;
-            }
-        }
-    }
-
-    return previous;
-}
+/// 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