Fixed three minor issues
[libdai.git] / include / dai / mf.h
index 2f9708a..0f16815 100644 (file)
@@ -10,8 +10,7 @@
 
 
 /// \file
-/// \brief Defines class MF
-/// \todo Improve documentation
+/// \brief Defines class MF which implements the Mean Field algorithm
 
 
 #ifndef __defined_libdai_mf_h
@@ -19,6 +18,7 @@
 
 
 #include <string>
+#include <dai/enum.h>
 #include <dai/daialg.h>
 #include <dai/factorgraph.h>
 #include <dai/properties.h>
@@ -28,8 +28,18 @@ namespace dai {
 
 
 /// Approximate inference algorithm "Mean Field"
+/** The Mean Field algorithm iteratively calculates approximations of
+ *  single variable marginals (beliefs). The update equation for 
+ *  a single belief \f$b_i\f$ is given by:
+ *    \f[ b_i^{\mathrm{new}}(x_i) \propto \prod_{I\in N_i} \exp \left( \sum_{x_{N_I \setminus \{i\}}} \log f_I(x_I) \prod_{j \in N_I \setminus \{i\}} b_j(x_j) \right) \f]
+ *  for naive mean field and by
+ *    \f[ b_i^{\mathrm{new}}(x_i) \propto \prod_{I\in N_i} \left( \sum_{x_{N_I \setminus \{i\}}} f_I(x_I) \prod_{j \in N_I \setminus \{i\}} b_j(x_j) \right) \f]
+ *  for hard-spin mean field.
+ *  These update equations are performed for all variables until convergence.
+ */
 class MF : public DAIAlgFG {
     private:
+        /// Current approximations of single variable marginals
         std::vector<Factor>  _beliefs;
         /// Maximum difference encountered so far
         Real _maxdiff;
@@ -37,41 +47,58 @@ class MF : public DAIAlgFG {
         size_t _iters;
 
     public:
-        /// Parameters of this inference algorithm
+        /// Parameters for MF
         struct Properties {
-            /// Verbosity
+            /// Enumeration of possible message initializations
+            DAI_ENUM(InitType,UNIFORM,RANDOM);
+
+            /// Enumeration of possible update types
+            DAI_ENUM(UpdateType,NAIVE,HARDSPIN);
+
+            /// Verbosity (amount of output sent to stderr)
             size_t verbose;
 
             /// Maximum number of iterations
             size_t maxiter;
 
-            /// Tolerance
+            /// Tolerance for convergence test
             Real tol;
 
-            /// Damping constant
+            /// Damping constant (0.0 means no damping, 1.0 is maximum damping)
             Real damping;
+            
+            /// How to initialize the messages/beliefs
+            InitType init;
+
+            /// How to update the messages/beliefs
+            UpdateType updates;
         } props;
 
         /// Name of this inference algorithm
         static const char *Name;
 
     public:
+    /// \name Constructors/destructors
+    //@{
         /// Default constructor
         MF() : DAIAlgFG(), _beliefs(), _maxdiff(0.0), _iters(0U), props() {}
 
-        /// Construct from FactorGraph fg and PropertySet opts
+        /// Construct from FactorGraph \a fg and PropertySet \a opts
+        /** \param fg Factor graph.
+         *  \param opts Parameters @see Properties
+         */
         MF( const FactorGraph &fg, const PropertySet &opts ) : DAIAlgFG(fg), _beliefs(), _maxdiff(0.0), _iters(0U), props() {
             setProperties( opts );
             construct();
         }
-
+    //@}
 
     /// \name General InfAlg interface
     //@{
         virtual MF* clone() const { return new MF(*this); }
         virtual std::string identify() const;
-        virtual Factor belief( const Var &n ) const;
-        virtual Factor belief( const VarSet &ns ) const;
+        virtual Factor belief( const Var &v ) const { return beliefV( findVar( v ) ); }
+        virtual Factor belief( const VarSet &vs ) const;
         virtual Factor beliefV( size_t i ) const;
         virtual std::vector<Factor> beliefs() const;
         virtual Real logZ() const;
@@ -80,29 +107,17 @@ class MF : public DAIAlgFG {
         virtual Real run();
         virtual Real maxDiff() const { return _maxdiff; }
         virtual size_t Iterations() const { return _iters; }
-    //@}
-
-
-    /// \name Additional interface specific for MF
-    //@{
-        Factor calcNewBelief( size_t i );
-    //@}
-
-    /// \name Managing parameters (which are stored in MF::props)
-    //@{
-        /// Set parameters of this inference algorithm.
-        /** The parameters are set according to \a opts. 
-         *  The values can be stored either as std::string or as the type of the corresponding MF::props member.
-         */
-        void setProperties( const PropertySet &opts );
-        /// Returns parameters of this inference algorithm converted into a PropertySet.
-        PropertySet getProperties() const;
-        /// Returns parameters of this inference algorithm formatted as a string in the format "[key1=val1,key2=val2,...,keyn=valn]".
-        std::string printProperties() const;
+        virtual void setProperties( const PropertySet &opts );
+        virtual PropertySet getProperties() const;
+        virtual std::string printProperties() const;
     //@}
 
     private:
+        /// Helper function for constructors
         void construct();
+
+        /// Calculates an updated belief of variable \a i
+        Factor calcNewBelief( size_t i );
 };