Cleanup of BBP code
[libdai.git] / include / dai / lc.h
index 86034f7..3bfb51a 100644 (file)
@@ -1,5 +1,6 @@
-/*  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.
 
 */
 
 
+/// \file
+/// \brief Defines class LC
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_lc_h
 #define __defined_libdai_lc_h
 
@@ -34,8 +40,9 @@
 namespace dai {
 
 
+/// Approximate inference algorithm "Loop Corrected Belief Propagation" by Mooij and Kappen
 class LC : public DAIAlgFG {
-    protected:
+    private:
         std::vector<Factor>      _pancakes;      // used by all LC types (psi_I is stored in the pancake)
         std::vector<Factor>      _cavitydists;   // used by all LC types to store the approximate cavity distribution
         /// _phis[i][_I] corresponds to \f$ \phi^{\setminus i}_I(x_{I \setminus i}) \f$
@@ -44,91 +51,94 @@ class LC : public DAIAlgFG {
         /// Single variable beliefs
         std::vector<Factor>      _beliefs;
 
+        /// Maximum difference encountered so far
+        double                  _maxdiff;
+        /// Number of iterations needed
+        size_t                  _iters;
+
     public:
+        /// Parameters of this inference algorithm
         struct Properties {
+            /// Enumeration of possible ways to initialize the cavities
+            DAI_ENUM(CavityType,FULL,PAIR,PAIR2,UNIFORM);
+
+            /// Enumeration of different update schedules
+            DAI_ENUM(UpdateType,SEQFIX,SEQRND,NONE);
+
+            /// Verbosity
             size_t verbose;
+
+            /// Maximum number of iterations
             size_t maxiter;
+
+            /// Tolerance
             double tol;
-            DAI_ENUM(CavityType,FULL,PAIR,PAIR2,PAIRINT,PAIRCUM,UNIFORM)
+
+            /// Complete or partial reinit of cavity graphs?
+            bool reinit;
+
+            /// Damping constant
+            double damping;
+
+            /// How to initialize the cavities
             CavityType cavity;
-            DAI_ENUM(UpdateType,SEQFIX,SEQRND,NONE)
+
+            /// What update schedule to use
             UpdateType updates;
-            std::string cavainame;
-            PropertySet cavaiopts;
-            bool reinit;
+
+            /// Name of the algorithm used to initialize the cavity distributions
+            std::string cavainame;      // FIXME: needs assignment operator?
+
+            /// Parameters for the algorithm used to initialize the cavity distributions
+            PropertySet cavaiopts;      // FIXME: needs assignment operator?
         } props;
-        double maxdiff;
+
+        /// Name of this inference algorithm
+        static const char *Name;
 
     public:
         /// Default constructor
-        LC() : DAIAlgFG(), _pancakes(), _cavitydists(), _phis(), _beliefs(), props(), maxdiff() {}
-        /// Copy constructor
-        LC(const LC & x) : DAIAlgFG(x), _pancakes(x._pancakes), _cavitydists(x._cavitydists), _phis(x._phis), _beliefs(x._beliefs), props(x.props), maxdiff(x.maxdiff) {}
-        /// Clone function
-        LC* clone() const { return new LC(*this); }
-        /// Create (virtual constructor)
-        virtual LC* create() const { return new LC(); }
-        /// Construct LC object from a FactorGraph and parameters
-        LC( const FactorGraph & fg, const PropertySet &opts );
-        /// Assignment operator
-        LC& operator=(const LC & x) {
-            if( this != &x ) {
-                DAIAlgFG::operator=(x);
-                _pancakes       = x._pancakes;
-                _cavitydists    = x._cavitydists;
-                _phis           = x._phis;
-                _beliefs        = x._beliefs;
-                props           = x.props;
-                maxdiff         = x.maxdiff;
-            }
-            return *this;
-        }
+        LC() : DAIAlgFG(), _pancakes(), _cavitydists(), _phis(), _beliefs(), _maxdiff(), _iters(), props() {}
 
-        static const char *Name;
+        /// Construct from FactorGraph fg and PropertySet opts
+        LC( const FactorGraph &fg, const PropertySet &opts );
+
+
+        /// @name General InfAlg interface
+        //@{
+        virtual LC* clone() const { return new LC(*this); }
+        virtual LC* create() const { return new LC(); }
+        virtual std::string identify() const;
+        virtual Factor belief( const Var &n ) const { return( _beliefs[findVar(n)] ); }
+        virtual Factor belief( const VarSet &/*ns*/ ) const { DAI_THROW(NOT_IMPLEMENTED); return Factor(); }
+        virtual std::vector<Factor> beliefs() const { return _beliefs; }
+        virtual Real logZ() const { DAI_THROW(NOT_IMPLEMENTED); return 0.0; }
+        virtual void init();
+        virtual void init( const VarSet &/*ns*/ ) { init(); }
+        virtual double run();
+        virtual double maxDiff() const { return _maxdiff; }
+        virtual size_t Iterations() const { return _iters; }
+        //@}
+
+
+        /// @name Additional interface specific for LC
+        //@{ 
         double CalcCavityDist( size_t i, const std::string &name, const PropertySet &opts );
         double InitCavityDists( const std::string &name, const PropertySet &opts );
         long SetCavityDists( std::vector<Factor> &Q );
 
-        void init();
-        /// Clear messages and beliefs corresponding to the nodes in ns
-        virtual void init( const VarSet &/*ns*/ ) {
-            DAI_THROW(NOT_IMPLEMENTED);
-        }
         Factor NewPancake (size_t i, size_t _I, bool & hasNaNs);
-        double run();
-
-        std::string identify() const;
-        Factor belief (const Var &n) const { return( _beliefs[findVar(n)] ); }
-        Factor belief (const VarSet &/*ns*/) const { 
-            DAI_THROW(NOT_IMPLEMENTED);
-            return Factor(); 
-        }
-        std::vector<Factor> beliefs() const { return _beliefs; }
-        Real logZ() const { 
-            DAI_THROW(NOT_IMPLEMENTED);
-            return 0.0; 
-        }
+
         void CalcBelief (size_t i);
         const Factor &belief (size_t i) const { return _beliefs[i]; };
         const Factor &pancake (size_t i) const { return _pancakes[i]; };
         const Factor &cavitydist (size_t i) const { return _cavitydists[i]; };
+        //@}
 
-        void clamp( const Var &/*n*/, size_t /*i*/ ) { 
-            DAI_THROW(NOT_IMPLEMENTED);
-        }
-        void restoreFactors( const VarSet &/*ns*/ ) { 
-            DAI_THROW(NOT_IMPLEMENTED);
-        }
-        void backupFactors( const VarSet &/*ns*/ ) { 
-            DAI_THROW(NOT_IMPLEMENTED);
-        }
-        virtual void makeCavity(const Var & /*n*/) { 
-            DAI_THROW(NOT_IMPLEMENTED);
-        }
+    private:
         void setProperties( const PropertySet &opts );
         PropertySet getProperties() const;
         std::string printProperties() const;
-        double maxDiff() const { return maxdiff; }
 };