index 644ddd4..0f16815 100644 (file)
@@ -10,8 +10,7 @@

/// \file

/// \file
-/// \brief Defines class MF
-/// \todo Improve documentation
+/// \brief Defines class MF which implements the Mean Field algorithm

#ifndef __defined_libdai_mf_h

#ifndef __defined_libdai_mf_h
@@ -19,6 +18,7 @@

#include <string>

#include <string>
+#include <dai/enum.h>
#include <dai/daialg.h>
#include <dai/factorgraph.h>
#include <dai/properties.h>
#include <dai/daialg.h>
#include <dai/factorgraph.h>
#include <dai/properties.h>
@@ -28,70 +28,96 @@ namespace dai {

/// Approximate inference algorithm "Mean Field"

/// 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:
class MF : public DAIAlgFG {
private:
+        /// Current approximations of single variable marginals
std::vector<Factor>  _beliefs;
/// Maximum difference encountered so far
std::vector<Factor>  _beliefs;
/// Maximum difference encountered so far
-        double _maxdiff;
+        Real _maxdiff;
/// Number of iterations needed
size_t _iters;

public:
/// Number of iterations needed
size_t _iters;

public:
-        /// Parameters of this inference algorithm
+        /// Parameters for MF
struct Properties {
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;

size_t verbose;

/// Maximum number of iterations
size_t maxiter;

-            /// Tolerance
-            double tol;
+            /// Tolerance for convergence test
+            Real tol;
+
+            /// Damping constant (0.0 means no damping, 1.0 is maximum damping)
+            Real damping;
+
+            /// How to initialize the messages/beliefs
+            InitType init;

-            /// Damping constant
-            double damping;
+            /// How to update the messages/beliefs
} props;

/// Name of this inference algorithm
static const char *Name;

public:
} 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() {}

/// 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();
}
MF( const FactorGraph &fg, const PropertySet &opts ) : DAIAlgFG(fg), _beliefs(), _maxdiff(0.0), _iters(0U), props() {
setProperties( opts );
construct();
}
+    //@}

-
-        /// @name General InfAlg interface
-        //@{
+    /// \name General InfAlg interface
+    //@{
virtual MF* clone() const { return new MF(*this); }
virtual std::string identify() const;
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;
virtual void init();
virtual void init( const VarSet &ns );
virtual std::vector<Factor> beliefs() const;
virtual Real logZ() const;
virtual void init();
virtual void init( const VarSet &ns );
-        virtual double run();
-        virtual double maxDiff() const { return _maxdiff; }
+        virtual Real run();
+        virtual Real maxDiff() const { return _maxdiff; }
virtual size_t Iterations() const { return _iters; }
virtual size_t Iterations() const { return _iters; }
-        //@}
-
-
-        /// @name Additional interface specific for MF
-        //@{
-        Factor beliefV( size_t i ) const;
-        //@}
+        virtual void setProperties( const PropertySet &opts );
+        virtual PropertySet getProperties() const;
+        virtual std::string printProperties() const;
+    //@}

private:

private:
+        /// Helper function for constructors
void construct();
void construct();
-        void setProperties( const PropertySet &opts );
-        PropertySet getProperties() const;
-        std::string printProperties() const;
+
+        /// Calculates an updated belief of variable \a i
+        Factor calcNewBelief( size_t i );
};

};