Merged SVN head ...
[libdai.git] / include / dai / daialg.h
index bfb2b84..1147b22 100644 (file)
@@ -28,7 +28,6 @@
 #include <vector>
 #include <dai/factorgraph.h>
 #include <dai/regiongraph.h>
 #include <vector>
 #include <dai/factorgraph.h>
 #include <dai/regiongraph.h>
-#include <dai/properties.h>
 
 
 namespace dai {
 
 
 namespace dai {
@@ -38,87 +37,16 @@ namespace dai {
 /// A InfAlg object represents a discrete factorized probability distribution over multiple variables 
 /// together with an inference algorithm.
 class InfAlg {
 /// A InfAlg object represents a discrete factorized probability distribution over multiple variables 
 /// together with an inference algorithm.
 class InfAlg {
-    private:
-        /// Properties of the algorithm (replaces _tol, _maxiter, _verbose)
-        Properties              _properties;
-
-        /// Maximum difference encountered so far
-        double                  _maxdiff;
-
-
     public:
     public:
-        /// Default constructor
-        InfAlg() : _properties(), _maxdiff(0.0) {}
-        
-        /// Constructor with options
-        InfAlg( const Properties &opts ) : _properties(opts), _maxdiff(0.0) {}
-        
-        /// Copy constructor
-        InfAlg( const InfAlg & x ) : _properties(x._properties), _maxdiff(x._maxdiff) {}
-
-        /// Clone (virtual copy constructor)
+        /// Clone *this (virtual copy constructor)
         virtual InfAlg* clone() const = 0;
 
         virtual InfAlg* clone() const = 0;
 
-        /// Assignment operator
-        InfAlg & operator=( const InfAlg & x ) {
-            if( this != &x ) {
-                _properties = x._properties;
-                _maxdiff    = x._maxdiff;
-            }
-            return *this;
-        }
+        /// Create (virtual default constructor)
+        virtual InfAlg* create() const = 0;
         
         
-        /// Virtual desctructor
-        // (this is needed because this class contains virtual functions)
+        /// Virtual desctructor (needed because this class contains virtual functions)
         virtual ~InfAlg() {}
         
         virtual ~InfAlg() {}
         
-        /// Returns true if a property with the given key is present
-        bool HasProperty(const PropertyKey &key) const { return _properties.hasKey(key); }
-
-        /// Gets a property
-        const PropertyValue & GetProperty(const PropertyKey &key) const { return _properties.Get(key); }
-        /// Gets a property, casted as ValueType
-        template<typename ValueType>
-        ValueType GetPropertyAs(const PropertyKey &key) const { return _properties.GetAs<ValueType>(key); }
-
-        /// Sets a property 
-        void SetProperty(const PropertyKey &key, const PropertyValue &val) { _properties[key] = val; }
-
-        /// Converts a property from string to ValueType, if necessary
-        template<typename ValueType>
-        void ConvertPropertyTo(const PropertyKey &key) { _properties.ConvertTo<ValueType>(key); }
-
-        /// Gets all properties
-        const Properties & GetProperties() const { return _properties; }
-
-        /// Sets properties
-        void SetProperties(const Properties &p) { _properties = p; }
-
-        /// Sets tolerance
-        void Tol( double tol ) { SetProperty("tol", tol); }
-        /// Gets tolerance
-        double Tol() const { return GetPropertyAs<double>("tol"); }
-
-        /// Sets maximum number of iterations
-        void MaxIter( size_t maxiter ) { SetProperty("maxiter", maxiter); }
-        /// Gets maximum number of iterations
-        size_t MaxIter() const { return GetPropertyAs<size_t>("maxiter"); }
-
-        /// Sets verbosity
-        void Verbose( size_t verbose ) { SetProperty("verbose", verbose); }
-        /// Gets verbosity
-        size_t Verbose() const { return GetPropertyAs<size_t>("verbose"); }
-
-        /// Sets maximum difference encountered so far
-        void MaxDiff( double maxdiff ) { _maxdiff = maxdiff; }
-        /// Gets maximum difference encountered so far
-        double MaxDiff() const { return _maxdiff; }
-        /// Updates maximum difference encountered so far
-        void updateMaxDiff( double maxdiff ) { if( maxdiff > _maxdiff ) _maxdiff = maxdiff; }
-        /// Sets maximum difference encountered so far to zero
-        void clearMaxDiff() { _maxdiff = 0.0; }
-
         /// Identifies itself for logging purposes
         virtual std::string identify() const = 0;
 
         /// Identifies itself for logging purposes
         virtual std::string identify() const = 0;
 
@@ -137,24 +65,27 @@ class InfAlg {
         /// Clear messages and beliefs
         virtual void init() = 0;
 
         /// Clear messages and beliefs
         virtual void init() = 0;
 
+        /// Clear messages and beliefs corresponding to the nodes in ns
+        virtual void init( const VarSet &ns ) = 0;
+
         /// The actual approximate inference algorithm
         virtual double run() = 0;
 
         /// Save factor I
         /// The actual approximate inference algorithm
         virtual double run() = 0;
 
         /// Save factor I
-        virtual void saveProb( size_t I ) = 0;
+        virtual void backupFactor( size_t I ) = 0;
         /// Save Factors involving ns
         /// Save Factors involving ns
-        virtual void saveProbs( const VarSet &ns ) = 0;
+        virtual void backupFactors( const VarSet &ns ) = 0;
 
         /// Restore factor I
 
         /// Restore factor I
-        virtual void undoProb( size_t I ) = 0;
+        virtual void restoreFactor( size_t I ) = 0;
         /// Restore Factors involving ns
         /// Restore Factors involving ns
-        virtual void undoProbs( const VarSet &ns ) = 0;
+        virtual void restoreFactors( const VarSet &ns ) = 0;
 
         /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$)
 
         /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$)
-        virtual void clamp( const Var & n, size_t i ) = 0;
+        virtual void clamp( const Var & n, size_t i, bool backup = false ) = 0;
 
         /// Set all factors interacting with var(i) to 1
 
         /// Set all factors interacting with var(i) to 1
-        virtual void makeCavity( size_t i ) = 0;
+        virtual void makeCavity( size_t i, bool backup = false ) = 0;
 
         /// Get reference to underlying FactorGraph
         virtual FactorGraph &fg() = 0;
 
         /// Get reference to underlying FactorGraph
         virtual FactorGraph &fg() = 0;
@@ -162,9 +93,11 @@ class InfAlg {
         /// Get const reference to underlying FactorGraph
         virtual const FactorGraph &fg() const = 0;
 
         /// Get const reference to underlying FactorGraph
         virtual const FactorGraph &fg() const = 0;
 
-        /// Checks whether all necessary properties have been set
-        /// and casts string-valued properties to other values if necessary
-        virtual bool checkProperties() = 0;
+        /// Return maximum difference between single node beliefs in the last pass
+        virtual double maxDiff() const = 0;
+
+        /// Return number of passes over the factorgraph
+        virtual size_t Iterations() const = 0;
 };
 
 
 };
 
 
@@ -174,30 +107,36 @@ class DAIAlg : public InfAlg, public T {
         /// Default constructor
         DAIAlg() : InfAlg(), T() {}
         
         /// Default constructor
         DAIAlg() : InfAlg(), T() {}
         
-        /// Construct DAIAlg with empty T but using the specified properties
-        DAIAlg( const Properties &opts ) : InfAlg( opts ), T() {}
+        /// Construct from T
+        DAIAlg( const T &t ) : InfAlg(), T(t) {}
 
 
-        /// Construct DAIAlg using the specified properties
-        DAIAlg( const T & t, const Properties &opts ) : InfAlg( opts ), T(t) {}
-        
         /// Copy constructor
         DAIAlg( const DAIAlg & x ) : InfAlg(x), T(x) {}
 
         /// Copy constructor
         DAIAlg( const DAIAlg & x ) : InfAlg(x), T(x) {}
 
-        /// Save factor I (using T::saveProb)
-        void saveProb( size_t I ) { T::saveProb( I ); }
-        /// Save Factors involving ns (using T::saveProbs)
-        void saveProbs( const VarSet &ns ) { T::saveProbs( ns ); }
+        /// Assignment operator
+        DAIAlg & operator=( const DAIAlg &x ) {
+            if( this != &x ) {
+                InfAlg::operator=(x);
+                T::operator=(x);
+            }
+            return *this;
+        }
+
+        /// Save factor I (using T::backupFactor)
+        void backupFactor( size_t I ) { T::backupFactor( I ); }
+        /// Save Factors involving ns (using T::backupFactors)
+        void backupFactors( const VarSet &ns ) { T::backupFactors( ns ); }
 
 
-        /// Restore factor I (using T::undoProb)
-        void undoProb( size_t I ) { T::undoProb( I ); }
-        /// Restore Factors involving ns (using T::undoProbs)
-        void undoProbs( const VarSet &ns ) { T::undoProbs( ns ); }
+        /// Restore factor I (using T::restoreFactor)
+        void restoreFactor( size_t I ) { T::restoreFactor( I ); }
+        /// Restore Factors involving ns (using T::restoreFactors)
+        void restoreFactors( const VarSet &ns ) { T::restoreFactors( ns ); }
 
         /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$) (using T::clamp)
 
         /// Clamp variable n to value i (i.e. multiply with a Kronecker delta \f$\delta_{x_n, i}\f$) (using T::clamp)
-        void clamp( const Var & n, size_t i ) { T::clamp( n, i ); }
+        void clamp( const Var & n, size_t i, bool backup = false ) { T::clamp( n, i, backup ); }
 
         /// Set all factors interacting with var(i) to 1 (using T::makeCavity)
 
         /// Set all factors interacting with var(i) to 1 (using T::makeCavity)
-        void makeCavity( size_t i ) { T::makeCavity( i ); }
+        void makeCavity( size_t i, bool backup = false ) { T::makeCavity( i, backup ); }
 
         /// Get reference to underlying FactorGraph
         FactorGraph &fg() { return (FactorGraph &)(*this); }
 
         /// Get reference to underlying FactorGraph
         FactorGraph &fg() { return (FactorGraph &)(*this); }