Cleanup of BBP code
[libdai.git] / include / dai / lc.h
index 70f7c69..3bfb51a 100644 (file)
 */
 
 
+/// \file
+/// \brief Defines class LC
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_lc_h
 #define __defined_libdai_lc_h
 
@@ -35,6 +40,7 @@
 namespace dai {
 
 
+/// Approximate inference algorithm "Loop Corrected Belief Propagation" by Mooij and Kappen
 class LC : public DAIAlgFG {
     private:
         std::vector<Factor>      _pancakes;      // used by all LC types (psi_I is stored in the pancake)
@@ -51,20 +57,43 @@ class LC : public DAIAlgFG {
         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;
+
+            /// Complete or partial reinit of cavity graphs?
             bool reinit;
+
+            /// Damping constant
             double damping;
-            DAI_ENUM(CavityType,FULL,PAIR,PAIR2,UNIFORM)
+
+            /// How to initialize the cavities
             CavityType cavity;
-            DAI_ENUM(UpdateType,SEQFIX,SEQRND,NONE)
+
+            /// What update schedule to use
             UpdateType updates;
+
+            /// 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;
-        /// Name of this inference method
+
+        /// Name of this inference algorithm
         static const char *Name;
 
     public:
@@ -74,66 +103,26 @@ class LC : public DAIAlgFG {
         /// Construct from FactorGraph fg and PropertySet opts
         LC( const FactorGraph &fg, const PropertySet &opts );
 
-        /// Copy constructor
-        LC( const LC &x ) : DAIAlgFG(x), _pancakes(x._pancakes), _cavitydists(x._cavitydists), _phis(x._phis), _beliefs(x._beliefs), _maxdiff(x._maxdiff), _iters(x._iters), props(x.props) {}
 
-        /// Clone *this (virtual copy constructor)
+        /// @name General InfAlg interface
+        //@{
         virtual LC* clone() const { return new LC(*this); }
-
-        /// Create (virtual default constructor)
         virtual LC* create() const { return new LC(); }
-
-        /// 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;
-                _maxdiff      = x._maxdiff;
-                _iters        = x._iters;
-                props         = x.props;
-            }
-            return *this;
-        }
-
-        /// Identifies itself for logging purposes
         virtual std::string identify() const;
-
-        /// Get single node belief
         virtual Factor belief( const Var &n ) const { return( _beliefs[findVar(n)] ); }
-
-        /// Get general belief
-        virtual Factor belief( const VarSet &/*ns*/ ) const {
-            DAI_THROW(NOT_IMPLEMENTED);
-            return Factor(); 
-        }
-
-        /// Get all beliefs
+        virtual Factor belief( const VarSet &/*ns*/ ) const { DAI_THROW(NOT_IMPLEMENTED); return Factor(); }
         virtual std::vector<Factor> beliefs() const { return _beliefs; }
-
-        /// Get log partition sum
-        virtual Real logZ() const { 
-            DAI_THROW(NOT_IMPLEMENTED);
-            return 0.0; 
-        }
-
-        /// Clear messages and beliefs
+        virtual Real logZ() const { DAI_THROW(NOT_IMPLEMENTED); return 0.0; }
         virtual void init();
-
-        /// Clear messages and beliefs corresponding to the nodes in ns
         virtual void init( const VarSet &/*ns*/ ) { init(); }
-
-        /// 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; }
+        //@}
+
 
+        /// @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 );
@@ -144,7 +133,9 @@ class LC : public DAIAlgFG {
         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]; };
+        //@}
 
+    private:
         void setProperties( const PropertySet &opts );
         PropertySet getProperties() const;
         std::string printProperties() const;