Cleanup of BBP code
[libdai.git] / include / dai / factorgraph.h
index 3cc0a9f..863b694 100644 (file)
@@ -1,6 +1,7 @@
-/*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
-    Radboud University Nijmegen, The Netherlands
-    
+/*  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
 */
 
 
+/// \file
+/// \brief Defines the FactorGraph class
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_factorgraph_h
 #define __defined_libdai_factorgraph_h
 
 namespace dai {
 
 
+/// Represents a factor graph.
+/** Both Bayesian Networks and Markov random fields can be represented in a 
+ *  unifying representation, called <em>factor graph</em> [\ref KFL01], 
+ *  implemented in libDAI by the FactorGraph class.
+ *  
+ *  Consider a probability distribution over \f$N\f$ discrete random variables 
+ *  \f$x_0,x_1,\dots,x_N\f$ that factorizes as a product of factors, each of
+ *  which depends on some subset of the variables:
+ *  \f[
+ *    P(x_0,x_1,\dots,x_N) = \frac{1}{Z} \prod_{I=0}^M f_I(x_I), \qquad
+ *    Z = \sum_{x_0}\dots\sum_{x_N} \prod_{I=0}^M f_I(X_I).
+ *  \f]
+ *  Each factor \f$f_I\f$ is a function from an associated subset
+ *  of variables \f$X_I \subset \{x_0,x_1,\dots,x_N\}\f$ to the nonnegative
+ *  real numbers.
+ * 
+ *  For a Bayesian network, each factor corresponds to a (conditional) 
+ *  probability table, whereas for a Markov random field, each factor 
+ *  corresponds to a maximal clique of the undirected graph.
+ *
+ *  Factor graphs explicitly express the factorization structure of the
+ *  corresponding probability distribution.
+ *
+ *  \todo Alternative implementation of undo factor changes: the only things that have to be
+ *  undone currently are setting a factor to 1 and setting a factor to a Kronecker delta. This
+ *  could also be implemented in the TFactor itself, which could maintain its state 
+ *  (ones/delta/full) and act accordingly.
+ */ 
 class FactorGraph {
     public:
-        BipartiteGraph         G;
-        std::vector<Var>       vars;
+        /// Stores the neighborhood structure
+        BipartiteGraph                    G;
+
+        /// Shorthand for BipartiteGraph::Neighbor
         typedef BipartiteGraph::Neighbor  Neighbor;
+
+        /// Shorthand for BipartiteGraph::Neighbors
         typedef BipartiteGraph::Neighbors Neighbors;
+
+        /// Shorthand for BipartiteGraph::Edge
         typedef BipartiteGraph::Edge      Edge;
+        
+        /// Iterator over factors
+        typedef std::vector<Factor>::iterator iterator;
+        
+        /// Const iterator over factors
+        typedef std::vector<Factor>::const_iterator const_iterator;
+        
 
     private:
+        std::vector<Var>         _vars;
         std::vector<Factor>      _factors;
         std::map<size_t,Factor>  _backup;
 
     public:
         /// Default constructor
-        FactorGraph() : G(), vars(), _factors(), _backup() {}
-        /// Copy constructor
-        FactorGraph(const FactorGraph & x) : G(x.G), vars(x.vars), _factors(x._factors), _backup(x._backup) {}
-        /// Construct FactorGraph from vector of Factors
+        FactorGraph() : G(), _vars(), _factors(), _backup() {}
+
+        /// Constructs a FactorGraph from a vector of factors
         FactorGraph(const std::vector<Factor> &P);
-        // Construct a FactorGraph from given factor and variable iterators
+
+        /// Constructs a FactorGraph from given factor and variable iterators
+        /** \tparam FactorInputIterator Iterator with value_type Factor
+         *  \tparam VarInputIterator Iterator with value_type Var
+         *  \pre Assumes that the set of variables in [var_begin,var_end) is the union of the variables in the factors in [fact_begin, fact_end)
+         */
         template<typename FactorInputIterator, typename VarInputIterator>
         FactorGraph(FactorInputIterator fact_begin, FactorInputIterator fact_end, VarInputIterator var_begin, VarInputIterator var_end, size_t nr_fact_hint = 0, size_t nr_var_hint = 0 );
-        
-        /// Assignment operator
-        FactorGraph & operator=(const FactorGraph & x) {
-            if( this != &x ) {
-                G          = x.G;
-                vars       = x.vars;
-                _factors   = x._factors;
-                _backup    = x._backup;
-            }
-            return *this;
-        }
+
+        /// Destructor        
         virtual ~FactorGraph() {}
 
-        /// Create (virtual default constructor)
-        virtual FactorGraph* create() const {
-            return new FactorGraph(*this);
-        }
+        /// Clone *this (virtual copy constructor)
+        virtual FactorGraph* clone() const { return new FactorGraph(); }
 
-        /// Clone (virtual copy constructor)
-        virtual FactorGraph* clone() const {
-            return new FactorGraph();
-        }
+        /// Create (virtual default constructor)
+        virtual FactorGraph* create() const { return new FactorGraph(*this); }
 
-        // aliases
-        Var & var(size_t i) { return vars[i]; }
-        /// Get const reference to i'th variable
-        const Var & var(size_t i) const { return vars[i]; }
-        /// Get const reference to I'th factor
+        /// Returns const reference to i'th variable
+        const Var & var(size_t i) const { return _vars[i]; }
+        /// Returns const reference to all factors
+        const std::vector<Var> & vars() const { return _vars; }
+        /// Returns reference to I'th factor
         Factor & factor(size_t I) { return _factors[I]; }
-        /// Get const reference to I'th factor
+        /// Returns const reference to I'th factor
         const Factor & factor(size_t I) const { return _factors[I]; }
-        /// Get const reference to all factors
+        /// Returns const reference to all factors
         const std::vector<Factor> & factors() const { return _factors; }
-
-        /// Get number of variables
-        size_t nrVars() const { return vars.size(); }
-        /// Get number of factors
-        size_t nrFactors() const { return _factors.size(); }
+        /// Returns iterator pointing to first factor
+        iterator begin() { return _factors.begin(); }
+        /// Returns const iterator pointing to first factor
+        const_iterator begin() const { return _factors.begin(); }
+        /// Returns iterator pointing beyond last factor
+        iterator end() { return _factors.end(); }
+        /// Returns const iterator pointing beyond last factor
+        const_iterator end() const { return _factors.end(); }
+
+        /// Returns number of variables
+        size_t nrVars() const { return vars().size(); }
+        /// Returns number of factors
+        size_t nrFactors() const { return factors().size(); }
+        /// Calculates number of edges
         size_t nrEdges() const { return G.nrEdges(); }
 
         /// Provides read access to neighbors of variable
@@ -111,14 +159,14 @@ class FactorGraph {
         /// Provides full access to neighbor of factor
         Neighbor & nbF( size_t I, size_t _i ) { return G.nb2(I)[_i]; }
 
-        /// Get index of variable n
+        /// Returns the index of a particular variable
         size_t findVar( const Var & n ) const {
-            size_t i = find( vars.begin(), vars.end(), n ) - vars.begin();
+            size_t i = find( vars().begin(), vars().end(), n ) - vars().begin();
             assert( i != nrVars() );
             return i;
         }
 
-        /// Get set of indexes for set of variables
+        /// Returns a set of indexes corresponding to a set of variables
         std::set<size_t> findVars( VarSet &ns ) const {
             std::set<size_t> indexes;
             for( VarSet::const_iterator n = ns.begin(); n != ns.end(); n++ )
@@ -126,7 +174,7 @@ class FactorGraph {
             return indexes;
         }
 
-        /// Get index of first factor involving ns
+        /// Returns index of the first factor that depends on the variables
         size_t findFactor(const VarSet &ns) const {
             size_t I;
             for( I = 0; I < nrFactors(); I++ )
@@ -167,10 +215,21 @@ class FactorGraph {
             }
         }
 
-        /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$);
-        /// If backup == true, make a backup of all factors that are changed
+        /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$)
+        /** If backup == true, make a backup of all factors that are changed
+         */
         virtual void clamp( const Var & n, size_t i, bool backup = false );
 
+        /// Clamp a variable in a factor graph to have one out of a list of values
+        /** If backup == true, make a backup of all factors that are changed
+         */
+        void clampVar( size_t i, const std::vector<size_t> &xis, bool backup = false );
+
+        /// Clamp a factor in a factor graph to have one out of a list of values
+        /** If backup == true, make a backup of all factors that are changed
+         */
+        void clampFactor( size_t I, const std::vector<size_t> &xIs, bool backup = false );
+
         /// Set all factors interacting with the i'th variable 1
         virtual void makeCavity( unsigned i, bool backup = false );
 
@@ -180,38 +239,69 @@ class FactorGraph {
         /// Restore all factors to the backup copies
         virtual void restoreFactors();
 
+        /// Returns true if the FactorGraph is connected
         bool isConnected() const { return G.isConnected(); }
+
+        /// Returns true if the FactorGraph is a tree
         bool isTree() const { return G.isTree(); }
 
-        friend std::ostream& operator << (std::ostream& os, const FactorGraph& fg);
-        friend std::istream& operator >> (std::istream& is, FactorGraph& fg);
+        /// Returns true if each factor depends on at most two variables
+        bool isPairwise() const;
+
+        /// Returns true if each variable has only two possible values
+        bool isBinary() const;
 
+        /// Reads a FactorGraph from a file
         void ReadFromFile(const char *filename);
+
+        /// Writes a FactorGraph to a file
         void WriteToFile(const char *filename) const;
+
+        /// Writes a FactorGraph to a GraphViz .dot file
         void printDot( std::ostream& os ) const;
         
+        /// Returns the cliques in this FactorGraph
         std::vector<VarSet> Cliques() const;
 
-        // Clamp variable v_i to value state (i.e. multiply with a Kronecker delta \f$\delta_{x_{v_i},x}\f$);
-        // This version changes the factor graph structure and thus returns a newly constructed FactorGraph
-        // and keeps the current one constant, contrary to clamp()
+        /// Clamp variable v_i to value state (i.e. multiply with a Kronecker delta \f$\delta_{x_{v_i},x}\f$);
+        /** This version changes the factor graph structure and thus returns a newly constructed FactorGraph
+         *  and keeps the current one constant, contrary to clamp()
+         */
         FactorGraph clamped( const Var & v_i, size_t x ) const;
 
+        /// Returns a copy of *this, where all factors that are subsumed by some larger factor are merged with the larger factors.
         FactorGraph maximalFactors() const;
 
-        bool isPairwise() const;
-        bool isBinary() const;
-
+        /// Makes a backup of the I'th Factor
         void restoreFactor( size_t I );
+
+        /// Restores the I'th Factor from the backup (it should be backed up first)
         void backupFactor( size_t I );
-        void restoreFactors( const VarSet &ns );
+
+        /// Makes a backup of all factors connected to a set of variables
         void backupFactors( const VarSet &ns );
+        /// Restores all factors connected to a set of variables from their backups
+        void restoreFactors( const VarSet &ns );
+
+        // Friends
+        friend std::ostream& operator << (std::ostream& os, const FactorGraph& fg);
+        friend std::istream& operator >> (std::istream& is, FactorGraph& fg);
+
+        /// @name Backwards compatibility layer (to be removed soon)
+        //@{
+        size_t VV2E(size_t n1, size_t n2) const { return G.VV2E(n1,n2); }
+        const Edge& edge(size_t e) const { return G.edge(e); }
+        void indexEdges() { G.indexEdges(); }
+        size_t nr_edges() const { return G.nr_edges(); }
+        const std::vector<Edge>& edges() const { return G.edges(); }
+        //}@
+
+    private:
         /// Part of constructors (creates edges, neighbors and adjacency matrix)
-        void createGraph( size_t nrEdges );
+        void constructGraph( size_t nrEdges );
 };
 
 
-// assumes that the set of variables in [var_begin,var_end) is the union of the variables in the factors in [fact_begin, fact_end)
 template<typename FactorInputIterator, typename VarInputIterator>
 FactorGraph::FactorGraph(FactorInputIterator fact_begin, FactorInputIterator fact_end, VarInputIterator var_begin, VarInputIterator var_end, size_t nr_fact_hint, size_t nr_var_hint ) : G(), _backup() {
     // add factors
@@ -223,12 +313,12 @@ FactorGraph::FactorGraph(FactorInputIterator fact_begin, FactorInputIterator fac
     }
 
     // add variables
-    vars.reserve( nr_var_hint );
+    _vars.reserve( nr_var_hint );
     for( VarInputIterator p1 = var_begin; p1 != var_end; ++p1 )
-        vars.push_back( *p1 );
+        _vars.push_back( *p1 );
 
     // create graph structure
-    createGraph( nrEdges );
+    constructGraph( nrEdges );
 }