Merged SVN head ...
[libdai.git] / include / dai / mf.h
index 29aa907..6daef4b 100644 (file)
@@ -1,6 +1,6 @@
 /*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
     Radboud University Nijmegen, The Netherlands
-    
+
     This file is part of libDAI.
 
     libDAI is free software; you can redistribute it and/or modify
@@ -26,6 +26,7 @@
 #include <string>
 #include <dai/daialg.h>
 #include <dai/factorgraph.h>
+#include <dai/properties.h>
 
 
 namespace dai {
@@ -34,41 +35,89 @@ namespace dai {
 class MF : public DAIAlgFG {
     protected:
         std::vector<Factor>  _beliefs;
-        
+        /// Maximum difference encountered so far
+        double _maxdiff;
+        /// Number of iterations needed
+        size_t _iters;
+
+    public:
+        struct Properties {
+            size_t verbose;
+            size_t maxiter;
+            double tol;
+            double damping;
+        } props;
+        static const char *Name;
+
     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() );
-            Regenerate();
+        /// 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();
         }
-        // assignment operator
-        MF & operator=(const MF & x) {
-            if(this!=&x) {
-                DAIAlgFG::operator=(x);
+
+        /// 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)
+        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;
         }
 
-        static const char *Name;
-        std::string identify() const;
-        void Regenerate();
-        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;
-        Complex logZ() const;
-
-        void init( const VarSet &ns );
-        void undoProbs( const VarSet &ns ) { FactorGraph::undoProbs(ns); init(ns); }
-        bool checkProperties();
+        /// 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; }
+
+
+        void construct();
+
+        void setProperties( const PropertySet &opts );
+        PropertySet getProperties() const;
+        std::string printProperties() const;
+
+        Factor beliefV( size_t i ) const;
 };