Merged SVN head ...
[libdai.git] / include / dai / bp.h
index 04cfd7b..f5b4886 100644 (file)
@@ -1,6 +1,6 @@
 /*  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
@@ -34,7 +34,7 @@ namespace dai {
 
 
 class BP : public DAIAlgFG {
-    protected:
+    private:
         typedef std::vector<size_t> ind_t;
         struct EdgeProp {
             ind_t  index;
@@ -42,7 +42,11 @@ class BP : public DAIAlgFG {
             Prob   newMessage;
             double residual;
         };
-        std::vector<std::vector<EdgeProp> > edges;
+        std::vector<std::vector<EdgeProp> > _edges;
+        /// Maximum difference encountered so far
+        double _maxdiff;
+        /// Number of iterations needed
+        size_t _iters;
     
     public:
         struct Properties {
@@ -50,65 +54,104 @@ class BP : public DAIAlgFG {
             size_t maxiter;
             double tol;
             bool logdomain;
-            ENUM4(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL)
+            double damping;
+            DAI_ENUM(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL)
             UpdateType updates;
         } props;
-        double maxdiff;
+        static const char *Name;
 
     public:
         /// Default constructor
-        BP() : DAIAlgFG(), edges(), props(), maxdiff(0.0) {};
-        /// Copy constructor
-        BP( const BP & x ) : DAIAlgFG(x), edges(x.edges), props(x.props), maxdiff(x.maxdiff) {};
-        /// Clone *this
-        BP* clone() const { return new BP(*this); }
+        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(), props(), maxdiff(0.0) {
+        BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), _edges(), _maxdiff(0.0), _iters(0U), props() {
             setProperties( opts );
-            create();
+            construct();
         }
+
+        /// 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 default constructor)
+        virtual BP* create() const { return new BP(); }
+
         /// Assignment operator
-        BP& operator=( const BP & x ) {
+        BP& operator=( const BP &x ) {
             if( this != &x ) {
                 DAIAlgFG::operator=( x );
-                edges = x.edges;
+                _edges = x._edges;
+                _maxdiff = x._maxdiff;
+                _iters = x._iters;
                 props = x.props;
-                maxdiff = x.maxdiff;
             }
             return *this;
         }
 
-        static const char *Name;
+        /// Identifies itself for logging purposes
+        virtual std::string identify() const;
 
-        Prob & message(size_t i, size_t _I) { return edges[i][_I].message; }
-        const Prob & message(size_t i, size_t _I) const { return edges[i][_I].message; }
-        Prob & newMessage(size_t i, size_t _I) { return edges[i][_I].newMessage; }
-        const Prob & newMessage(size_t i, size_t _I) const { return edges[i][_I].newMessage; }
-        ind_t & index(size_t i, size_t _I) { return edges[i][_I].index; }
-        const ind_t & index(size_t i, size_t _I) const { return edges[i][_I].index; }
-        double & residual(size_t i, size_t _I) { return edges[i][_I].residual; }
-        const double & residual(size_t i, size_t _I) const { return edges[i][_I].residual; }
+        /// Get single node belief
+        virtual Factor belief( const Var &n ) const;
 
-        std::string identify() const;
-        void create();
-        void init();
-        double run();
+        /// Get general belief
+        virtual Factor belief( const VarSet &ns ) const;
 
-        void findMaxResidual( size_t &i, size_t &_I );
-        void calcNewMessage( size_t i, size_t _I );
-        Factor beliefV (size_t i) const;
-        Factor beliefF (size_t I) const;
-        Factor belief (const Var &n) const;
-        Factor belief (const VarSet &n) const;
-        std::vector<Factor> beliefs() const;
-        Real logZ() const;
+        /// Get all beliefs
+        virtual std::vector<Factor> beliefs() const;
 
-        void init( const VarSet &ns );
-        void undoProbs( const VarSet &ns ) { FactorGraph::undoProbs(ns); init(ns); }
+        /// Get log partition sum
+        virtual Real logZ() const;
+
+        /// Clear messages and beliefs
+        virtual void init();
+
+        /// Clear messages and beliefs corresponding to the nodes in ns
+        virtual void init( const VarSet &ns );
+
+        /// The actual approximate inference algorithm
+        virtual double run();
+
+        /// Return maximum difference between single node beliefs in the last pass
+        virtual double maxDiff() const { return _maxdiff; }
+
+        /// Return number of passes over the factorgraph
+        virtual size_t Iterations() const { return _iters; }
+
+
+        Factor beliefV( size_t i ) const;
+        Factor beliefF( size_t I ) const;
+
+    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; }
+        Prob & newMessage(size_t i, size_t _I) { return _edges[i][_I].newMessage; }
+        const Prob & newMessage(size_t i, size_t _I) const { return _edges[i][_I].newMessage; }
+        ind_t & index(size_t i, size_t _I) { return _edges[i][_I].index; }
+        const ind_t & index(size_t i, size_t _I) const { return _edges[i][_I].index; }
+        double & residual(size_t i, size_t _I) { return _edges[i][_I].residual; }
+        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 findMaxResidual( size_t &i, size_t &_I );
 
+        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;
-        double maxDiff() const { return maxdiff; }
+        std::string printProperties() const;
 };