Cleanup of BBP code
[libdai.git] / include / dai / bp.h
index 5d3eb81..2d0a1f8 100644 (file)
@@ -43,6 +43,7 @@ namespace dai {
 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;
@@ -50,19 +51,23 @@ 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)
+            DAI_ENUM(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL);
 
             /// Enumeration of inference variants
-            DAI_ENUM(InfType,SUMPROD,MAXPROD)
+            DAI_ENUM(InfType,SUMPROD,MAXPROD);
         
             /// Verbosity
             size_t verbose;
@@ -89,27 +94,41 @@ class BP : public DAIAlgFG {
         /// 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() {}
+        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) {}
+        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 ) {
             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;
         }
 
         /// Construct from FactorGraph fg and PropertySet opts
-        BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), _edges(), _maxdiff(0.0), _iters(0U), props() {
+        BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), _edges(), _maxdiff(0.0), _iters(0U), _sentMessages(), props(), recordSentMessages(false) {
             setProperties( opts );
             construct();
         }
@@ -138,6 +157,21 @@ class BP : public DAIAlgFG {
         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; }
         Prob & message(size_t i, size_t _I) { return _edges[i][_I].message; }
@@ -149,16 +183,13 @@ 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);
-                residual(i,_I) = 0.0;
-            } else {
-                message(i,_I) = (message(i,_I) ^ props.damping) * (newMessage(i,_I) ^ (1.0 - props.damping));
-                residual(i,_I) = dist( newMessage(i,_I), message(i,_I), Prob::DISTLINF );
-            }
-        }
+        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;
 
         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