Cleanup of BBP code
[libdai.git] / include / dai / bp.h
index 8853c94..2d0a1f8 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 class BP
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_bp_h
 #define __defined_libdai_bp_h
 
 namespace dai {
 
 
+/// Approximate inference algorithm "(Loopy) Belief Propagation"
 class BP : public DAIAlgFG {
     private:
         typedef std::vector<size_t> ind_t;
+           typedef std::multimap<double, std::pair<std::size_t, std::size_t> > LutType;
         struct EdgeProp {
             ind_t  index;
             Prob   message;
@@ -43,86 +51,126 @@ class BP : public DAIAlgFG {
             double residual;
         };
         std::vector<std::vector<EdgeProp> > _edges;
+        std::vector<std::vector<LutType::iterator> > _edge2lut;
+        LutType _lut;
         /// Maximum difference encountered so far
         double _maxdiff;
         /// Number of iterations needed
         size_t _iters;
+        /// The history of message updates (only recorded if recordSentMessages is true)
+        std::vector<std::pair<std::size_t, std::size_t> > _sentMessages;
     
     public:
+        /// Parameters of this inference algorithm
         struct Properties {
+            /// Enumeration of possible update schedules
+            DAI_ENUM(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL);
+
+            /// Enumeration of inference variants
+            DAI_ENUM(InfType,SUMPROD,MAXPROD);
+        
+            /// Verbosity
             size_t verbose;
+
+            /// Maximum number of iterations
             size_t maxiter;
+
+            /// Tolerance
             double tol;
+
+            /// Do updates in logarithmic domain?
             bool logdomain;
+
+            /// Damping constant
             double damping;
-            DAI_ENUM(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL)
+
+            /// Update schedule
             UpdateType updates;
+
+            /// Type of inference: sum-product or max-product?
+            InfType inference;
         } props;
+
+        /// Name of this inference algorithm
         static const char *Name;
 
+        /// Specifies whether the history of message updates should be recorded
+        bool recordSentMessages;
+
     public:
         /// Default constructor
-        BP() : DAIAlgFG(), _edges(), _maxdiff(0.0), _iters(0U), props() {}
-
-        /// Construct from FactorGraph fg and PropertySet opts
-        BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), _edges(), _maxdiff(0.0), _iters(0U), props() {
-            setProperties( opts );
-            construct();
-        }
+        BP() : DAIAlgFG(), _edges(), _edge2lut(), _lut(), _maxdiff(0.0), _iters(0U), _sentMessages(), props(), recordSentMessages(false) {}
 
         /// Copy constructor
-        BP( const BP & x ) : DAIAlgFG(x), _edges(x._edges), _maxdiff(x._maxdiff), _iters(x._iters), props(x.props) {}
-
-        /// Clone *this (virtual copy constructor)
-        virtual BP* clone() const { return new BP(*this); }
-
-        /// Create (virtual constructor)
-        virtual BP* create() const { return new BP(); }
+        BP( const BP &x ) : DAIAlgFG(x), _edges(x._edges), _edge2lut(x._edge2lut),
+            _lut(x._lut), _maxdiff(x._maxdiff), _iters(x._iters), _sentMessages(x._sentMessages), 
+            props(x.props), recordSentMessages(x.recordSentMessages) 
+        {
+            for( LutType::iterator l = _lut.begin(); l != _lut.end(); ++l )
+                _edge2lut[l->second.first][l->second.second] = l;
+        }
 
         /// Assignment operator
-        BP& operator=( const BP & x ) {
+        BP& operator=( const BP &x ) {
             if( this != &x ) {
                 DAIAlgFG::operator=( x );
                 _edges = x._edges;
+                _lut = x._lut;
+                for( LutType::iterator l = _lut.begin(); l != _lut.end(); ++l )
+                    _edge2lut[l->second.first][l->second.second] = l;
                 _maxdiff = x._maxdiff;
                 _iters = x._iters;
+                _sentMessages = x._sentMessages;
                 props = x.props;
+                recordSentMessages = x.recordSentMessages;
             }
             return *this;
         }
 
-        /// Return number of passes over the factorgraph
-        size_t Iterations() const { return _iters; }
-
-        /// Return maximum difference between single node beliefs for two consecutive iterations
-        double maxDiff() const { return _maxdiff; }
-
-        /// Identifies itself for logging purposes
-        std::string identify() const;
-
-        /// Get single node belief
-        Factor belief( const Var &n ) const;
-
-        /// Get general belief
-        Factor belief( const VarSet &n ) const;
-
-        /// Get all beliefs
-        std::vector<Factor> beliefs() const;
-
-        /// Get log partition sum
-        Real logZ() const;
+        /// Construct from FactorGraph fg and PropertySet opts
+        BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), _edges(), _maxdiff(0.0), _iters(0U), _sentMessages(), props(), recordSentMessages(false) {
+            setProperties( opts );
+            construct();
+        }
 
-        /// Clear messages and beliefs
-        void init();
 
-        /// Clear messages and beliefs corresponding to the nodes in ns
+        /// @name General InfAlg interface
+        //@{
+        virtual BP* clone() const { return new BP(*this); }
+        virtual BP* create() const { return new BP(); }
+        virtual std::string identify() const;
+        virtual Factor belief( const Var &n ) const;
+        virtual Factor belief( const VarSet &ns ) const;
+        virtual std::vector<Factor> beliefs() const;
+        virtual Real logZ() const;
+        virtual void init();
         virtual void init( const VarSet &ns );
+        virtual double run();
+        virtual double maxDiff() const { return _maxdiff; }
+        virtual size_t Iterations() const { return _iters; }
+        //@}
 
-        /// The actual approximate inference algorithm
-        double run();
 
+        /// @name Additional interface specific for BP
+        //@{
         Factor beliefV( size_t i ) const;
         Factor beliefF( size_t I ) const;
+        //@}
+
+        /// Calculates the joint state of all variables that has maximum probability
+        /** Assumes that run() has been called and that props.inference == MAXPROD
+         */
+        std::vector<std::size_t> findMaximum() const;
+
+        /// Returns history of sent messages
+        const std::vector<std::pair<std::size_t, std::size_t> >& getSentMessages() const {
+            return _sentMessages;
+        }
+
+        /// Clears history of sent messages
+        void clearSentMessages() {
+            _sentMessages.clear();
+        }
 
     private:
         const Prob & message(size_t i, size_t _I) const { return _edges[i][_I].message; }
@@ -135,16 +183,16 @@ class BP : public DAIAlgFG {
         const double & residual(size_t i, size_t _I) const { return _edges[i][_I].residual; }
 
         void calcNewMessage( size_t i, size_t _I );
-        void updateMessage( size_t i, size_t _I ) {
-            if( props.damping == 0.0 )
-                message(i,_I) = newMessage(i,_I);
-            else
-                message(i,_I) = (message(i,_I) ^ props.damping) * (newMessage(i,_I) ^ (1.0 - props.damping));
-        }
+        void updateMessage( size_t i, size_t _I );
+        void updateResidual( size_t i, size_t _I, double r );
         void findMaxResidual( size_t &i, size_t &_I );
+        /// Calculates unnormalized belief of variable
+        void calcBeliefV( size_t i, Prob &p ) const;
+        /// Calculates unnormalized belief of factor
+        void calcBeliefF( size_t I, Prob &p ) const;
 
-        /// Set Props according to the PropertySet opts, where the values can be stored as std::strings or as the type of the corresponding Props member
         void construct();
+        /// Set Props according to the PropertySet opts, where the values can be stored as std::strings or as the type of the corresponding Props member
         void setProperties( const PropertySet &opts );
         PropertySet getProperties() const;
         std::string printProperties() const;