Cleanup of BBP code
[libdai.git] / include / dai / mf.h
index 56e0272..ebdb577 100644 (file)
@@ -1,6 +1,7 @@
-/*  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.
 
     libDAI is free software; you can redistribute it and/or modify
 */
 
 
+/// \file
+/// \brief Defines class MF
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_mf_h
 #define __defined_libdai_mf_h
 
 #include <string>
 #include <dai/daialg.h>
 #include <dai/factorgraph.h>
+#include <dai/properties.h>
 
 
 namespace dai {
 
 
+/// Approximate inference algorithm "Mean Field"
 class MF : public DAIAlgFG {
-    protected:
+    private:
         std::vector<Factor>  _beliefs;
-        
+        /// Maximum difference encountered so far
+        double _maxdiff;
+        /// Number of iterations needed
+        size_t _iters;
+
     public:
-        // default constructor
-        MF() : DAIAlgFG(), _beliefs() {};
-        // copy constructor
-        MF(const MF & x) : DAIAlgFG(x), _beliefs(x._beliefs) {};
-        MF* clone() const { return new MF(*this); }
-        // construct MF object from FactorGraph
-        MF(const FactorGraph & fg, const Properties &opts) : DAIAlgFG(fg, opts) {
-            assert( checkProperties() );
-            create();
-        }
-        // assignment operator
-        MF & operator=(const MF & x) {
-            if(this!=&x) {
-                DAIAlgFG::operator=(x);
-                _beliefs = x._beliefs;
-            }
-            return *this;
-        }
+        /// 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;
-        std::string identify() const;
-        void create();
-        void init();
-        double run();
-        Factor beliefV (size_t i) const;
-        Factor belief (const Var &n) const;
-        Factor belief (const VarSet &ns) const;
-        std::vector<Factor> beliefs() const;
-        Real logZ() const;
-
-        void init( const VarSet &ns );
-        void undoProbs( const VarSet &ns ) { FactorGraph::undoProbs(ns); init(ns); }
-        bool checkProperties();
+
+    public:
+        /// Default constructor
+        MF() : DAIAlgFG(), _beliefs(), _maxdiff(0.0), _iters(0U), props() {}
+
+        /// Construct from FactorGraph fg and PropertySet opts
+        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 MF* create() const { return new MF(); }
+        virtual std::string identify() const;
+        virtual Factor belief( const Var &n ) const;
+        virtual Factor belief( const VarSet &ns ) const;
+        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 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;
 };