Cleanup of BBP code
[libdai.git] / include / dai / mf.h
index 6daef4b..ebdb577 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 MF
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_mf_h
 #define __defined_libdai_mf_h
 
@@ -32,8 +38,9 @@
 namespace dai {
 
 
+/// Approximate inference algorithm "Mean Field"
 class MF : public DAIAlgFG {
-    protected:
+    private:
         std::vector<Factor>  _beliefs;
         /// Maximum difference encountered so far
         double _maxdiff;
@@ -41,12 +48,22 @@ class MF : public DAIAlgFG {
         size_t _iters;
 
     public:
+        /// Parameters of this inference algorithm
         struct Properties {
+            /// Verbosity
             size_t verbose;
+
+            /// Maximum number of iterations
             size_t maxiter;
+
+            /// Tolerance
             double tol;
+
+            /// Damping constant
             double damping;
         } props;
+
+        /// Name of this inference algorithm
         static const char *Name;
 
     public:
@@ -59,65 +76,34 @@ class MF : public DAIAlgFG {
             construct();
         }
 
-        /// Copy constructor
-        MF( const MF &x ) : DAIAlgFG(x), _beliefs(x._beliefs), _maxdiff(x._maxdiff), _iters(x._iters), props(x.props) {}
 
-        /// Clone *this (virtual copy constructor)
+        /// @name General InfAlg interface
+        //@{
         virtual MF* clone() const { return new MF(*this); }
-
-        /// Create (virtual default constructor)
         virtual MF* create() const { return new MF(); }
-
-        /// Assignment operator
-        MF& operator=( const MF &x ) {
-            if( this != &x ) {
-                DAIAlgFG::operator=( x );
-                _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;
-
-        /// Get general belief
         virtual Factor belief( const VarSet &ns ) const;
-
-        /// Get all beliefs
         virtual std::vector<Factor> beliefs() const;
-
-        /// 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; }
+        //@}
 
 
+        /// @name Additional interface specific for MF
+        //@{ 
+        Factor beliefV( size_t i ) const;
+        //@}
+        
+    private:
         void construct();
-
         void setProperties( const PropertySet &opts );
         PropertySet getProperties() const;
         std::string printProperties() const;
-
-        Factor beliefV( size_t i ) const;
 };