Changed license from GPL v2+ to FreeBSD (aka BSD 2-clause) license
[libdai.git] / include / dai / weightedgraph.h
index d28e8c8..edb1422 100644 (file)
@@ -1,17 +1,14 @@
 /*  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-2011, The libDAI authors. All rights reserved.
  *
- *  Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at libdai dot org]
- *  Copyright (C) 2006-2007  Radboud University Nijmegen, The Netherlands
+ *  Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
  */
 
 
 /** \file
  *  \brief Defines some utility functions for (weighted) undirected graphs, trees and rooted trees.
- *  \todo Improve general support for graphs and trees.
+ *  \todo Improve general support for graphs and trees (in particular, a good tree implementation is needed).
  */
 
 
 #include <set>
 #include <limits>
 #include <climits>   // Work-around for bug in boost graph library
+#include <dai/util.h>
+#include <dai/exceptions.h>
+#include <dai/graph.h>
 
 #include <boost/graph/adjacency_list.hpp>
 #include <boost/graph/prim_minimum_spanning_tree.hpp>
+#include <boost/graph/kruskal_min_spanning_tree.hpp>
 
 
 namespace dai {
@@ -37,31 +38,28 @@ namespace dai {
 class DEdge {
     public:
         /// First node index (source of edge)
-        size_t n1;
+        size_t first;
 
-        /// Second node index (sink of edge)
-        size_t n2;
+        /// Second node index (target of edge)
+        size_t second;
 
         /// Default constructor
-        DEdge() {}
+        DEdge() : first(0), second(0) {}
 
         /// Constructs a directed edge pointing from \a m1 to \a m2
-        DEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
+        DEdge( size_t m1, size_t m2 ) : first(m1), second(m2) {}
 
         /// 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); }
+        bool operator==( const DEdge &x ) const { return ((first == x.first) && (second == x.second)); }
 
         /// Smaller-than operator (performs lexicographical comparison)
         bool operator<( const DEdge &x ) const {
-            return( (n1 < x.n1) || ((n1 == x.n1) && (n2 < x.n2)) );
+            return( (first < x.first) || ((first == x.first) && (second < x.second)) );
         }
 
         /// Writes a directed edge to an output stream
         friend std::ostream & operator << (std::ostream & os, const DEdge & e) {
-            os << "(" << e.n1 << "," << e.n2 << ")";
+            os << "(" << e.first << "->" << e.second << ")";
             return os;
         }
 };
@@ -71,47 +69,40 @@ class DEdge {
 class UEdge {
     public:
         /// First node index
-        union {
-            size_t n1;
-            size_t first;   /// alias
-        };
+        size_t first;
+
         /// Second node index
-        union {
-            size_t n2;
-            size_t second;  /// alias
-        };
+        size_t second;
 
         /// Default constructor
-        UEdge() {}
+        UEdge() : first(0), second(0) {}
 
         /// Constructs an undirected edge between \a m1 and \a m2
-        UEdge( size_t m1, size_t m2 ) : n1(m1), n2(m2) {}
+        UEdge( size_t m1, size_t m2 ) : first(m1), second(m2) {}
 
         /// Construct from DEdge
-        UEdge( const DEdge &e ) : n1(e.n1), n2(e.n2) {}
+        UEdge( const DEdge &e ) : first(e.first), second(e.second) {}
 
         /// 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));
+            return ((first == x.first) && (second == x.second)) || ((first == x.second) && (second == x.first));
         }
 
         /// Smaller-than operator
         bool operator<( const UEdge &x ) const {
-            size_t s = n1, l = n2;
-            if( s > l )
-                std::swap( s, l );
-            size_t xs = x.n1, xl = x.n2;
-            if( xs > xl )
-                std::swap( xs, xl );
+            size_t s = std::min( first, second );
+            size_t l = std::max( first, second );
+            size_t xs = std::min( x.first, x.second );
+            size_t xl = std::max( x.first, x.second );
             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 << "}";
+            if( e.first < e.second )
+                os << "{" << e.first << "--" << e.second << "}";
             else
-                os << "{" << e.n2 << "," << e.n1 << "}";
+                os << "{" << e.second << "--" << e.first << "}";
             return os;
         }
 };
@@ -123,16 +114,20 @@ class GraphEL : public std::set<UEdge> {
         /// Default constructor
         GraphEL() {}
 
-        /// Construct from range of objects that can be cast to DEdge
+        /// Construct from range of objects that can be cast to UEdge
         template <class InputIterator>
         GraphEL( InputIterator begin, InputIterator end ) {
             insert( begin, end );
         }
-};
-
 
-/// \deprecated Please use dai::GraphEL instead.
-typedef GraphEL Graph;
+        /// Construct from GraphAL
+        GraphEL( const GraphAL& G ) {
+            for( size_t n1 = 0; n1 < G.nrNodes(); n1++ )
+                foreach( const Neighbor n2, G.nb(n1) )
+                    if( n1 < n2 )
+                        insert( UEdge( n1, n2 ) );
+        }
+};
 
 
 /// Represents an undirected weighted graph, with weights of type \a T, implemented as a std::map mapping undirected edges to weights
@@ -156,52 +151,78 @@ class RootedTree : public std::vector<DEdge> {
 };
 
 
-/// Uses Prim's algorithm to construct a minimal spanning tree from the (positively) weighted graph \a G.
-/** Uses implementation in Boost Graph Library.
+/// Constructs a minimum spanning tree from the (non-negatively) weighted graph \a G.
+/** \param G Weighted graph that should have non-negative weights.
+ *  \param usePrim If true, use Prim's algorithm (complexity O(E log(V))), otherwise, use Kruskal's algorithm (complexity O(E log(E))).
+ *  \note Uses implementation from Boost Graph Library.
+ *  \note The vertices of \a G must be in the range [0,N) where N is the number of vertices of \a G.
  */
-template<typename T> RootedTree MinSpanningTreePrims( const WeightedGraph<T> &G ) {
+template<typename T> RootedTree MinSpanningTree( const WeightedGraph<T> &G, bool usePrim ) {
     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;
-        typedef pair<size_t, size_t> E;
+        typedef adjacency_list< vecS, vecS, undirectedS, no_property, property<edge_weight_t, double> > boostGraph;
 
         set<size_t> nodes;
-        vector<E> edges;
+        vector<UEdge> edges;
         vector<double> weights;
         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 );
-            nodes.insert( e->first.n2 );
+            edges.push_back( e->first );
+            nodes.insert( e->first.first );
+            nodes.insert( e->first.second );
         }
 
-        boostGraph g( edges.begin(), edges.end(), weights.begin(), nodes.size() );
-        vector< graph_traits< boostGraph >::vertex_descriptor > p( num_vertices(g) );
-        prim_minimum_spanning_tree( g, &(p[0]) );
+        size_t N = nodes.size();
+        for( set<size_t>::const_iterator it = nodes.begin(); it != nodes.end(); it++ )
+            if( *it >= N )
+                DAI_THROWE(RUNTIME_ERROR,"Vertices must be in range [0..N) where N is the number of vertices.");
 
-        // Store tree edges in result
+        boostGraph g( edges.begin(), edges.end(), weights.begin(), nodes.size() );
+        size_t root = *(nodes.begin());
         GraphEL tree;
-        size_t root = 0;
-        for( size_t i = 0; i != p.size(); i++ )
-            if( p[i] != i )
-                tree.insert( UEdge( p[i], i ) );
-            else
-                root = i;
-        // Order them to obtain a rooted tree
+        if( usePrim ) {
+            // Prim's algorithm
+            vector< graph_traits< boostGraph >::vertex_descriptor > p(N);
+            prim_minimum_spanning_tree( g, &(p[0]) );
+
+            // Store tree edges in result
+            for( size_t i = 0; i != p.size(); i++ ) {
+                if( p[i] != i )
+                    tree.insert( UEdge( p[i], i ) );
+            }
+        } else {
+            // Kruskal's algorithm
+            vector< graph_traits< boostGraph >::edge_descriptor > t;
+            t.reserve(  N - 1 );
+            kruskal_minimum_spanning_tree( g, std::back_inserter(t) );
+
+            // Store tree edges in result
+            for( size_t i = 0; i != t.size(); i++ ) {
+                size_t v1 = source( t[i], g );
+                size_t v2 = target( t[i], g );
+                if( v1 != v2 )
+                    tree.insert( UEdge( v1, v2 ) );
+            }
+        }
+
+        // Direct edges in order to obtain a rooted tree
         result = RootedTree( tree, root );
     }
     return result;
 }
 
 
-/// Use Prim's algorithm to construct a maximal spanning tree from the (positively) weighted graph \a G.
-/** Uses implementation in Boost Graph Library.
+/// Constructs a minimum spanning tree from the (non-negatively) weighted graph \a G.
+/** \param G Weighted graph that should have non-negative weights.
+ *  \param usePrim If true, use Prim's algorithm (complexity O(E log(V))), otherwise, use Kruskal's algorithm (complexity O(E log(E))).
+ *  \note Uses implementation from Boost Graph Library.
+ *  \note The vertices of \a G must be in the range [0,N) where N is the number of vertices of \a G.
  */
-template<typename T> RootedTree MaxSpanningTreePrims( const WeightedGraph<T> &G ) {
+template<typename T> RootedTree MaxSpanningTree( const WeightedGraph<T> &G, bool usePrim ) {
     if( G.size() == 0 )
         return RootedTree();
     else {
@@ -211,25 +232,15 @@ template<typename T> RootedTree MaxSpanningTreePrims( const WeightedGraph<T> &G
                 maxweight = it->second;
         // make a copy of the graph
         WeightedGraph<T> gr( G );
-        // invoke MinSpanningTreePrims with negative weights
+        // invoke MinSpanningTree 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 );
+        return MinSpanningTree( gr, usePrim );
     }
 }
 
 
-/// 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).
- */
-GraphEL RandomDRegularGraph( size_t N, size_t d );
-
-
 } // end of namespace dai