Fixed a bug (introduced in commit 64db6bc3...) and another one in Factors2mx
[libdai.git] / include / dai / factor.h
index 6f2e5b0..05f3e82 100644 (file)
@@ -1,23 +1,17 @@
-/*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
-    Copyright (C) 2002  Martijn Leisink  [martijn@mbfys.kun.nl]
-    Radboud University Nijmegen, The Netherlands
-    
-    This file is part of libDAI.
+/*  This file is part of libDAI - http://www.libdai.org/
+ *
+ *  libDAI is licensed under the terms of the GNU General Public License version
+ *  2, or (at your option) any later version. libDAI is distributed without any
+ *  warranty. See the file COPYING for more details.
+ *
+ *  Copyright (C) 2002       Martijn Leisink  [martijn@mbfys.kun.nl]
+ *  Copyright (C) 2006-2009  Joris Mooij      [joris dot mooij at libdai dot org]
+ *  Copyright (C) 2002-2007  Radboud University Nijmegen, The Netherlands
+ */
 
-    libDAI is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
 
-    libDAI is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with libDAI; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-*/
+/// \file
+/// \brief Defines TFactor<> and Factor classes which represent factors in probability distributions.
 
 
 #ifndef __defined_libdai_factor_h
 
 
 #include <iostream>
+#include <functional>
 #include <cmath>
 #include <dai/prob.h>
 #include <dai/varset.h>
 #include <dai/index.h>
+#include <dai/util.h>
 
 
 namespace dai {
 
 
-template<typename T> class      TFactor;
-typedef TFactor<Real>           Factor;
-
-
-// predefine friends
-template<typename T> Real           dist( const TFactor<T> & x, const TFactor<T> & y, Prob::DistType dt );
-template<typename T> Real           KL_dist( const TFactor<T> & p, const TFactor<T> & q );
-template<typename T> std::ostream&  operator<< (std::ostream& os, const TFactor<T>& P);
-
-        
-// T should be castable from and to double
-template <typename T> class TFactor {
-    protected:
-        VarSet      _vs;
-        TProb<T>    _p;
+/// Represents a (probability) factor.
+/** Mathematically, a \e factor is a function mapping joint states of some
+ *  variables to the nonnegative real numbers.
+ *  More formally, denoting a discrete variable with label \f$l\f$ by
+ *  \f$x_l\f$ and its state space by \f$X_l = \{0,1,\dots,S_l-1\}\f$,
+ *  a factor depending on the variables \f$\{x_l\}_{l\in L}\f$ is
+ *  a function \f$f_L : \prod_{l\in L} X_l \to [0,\infty)\f$.
+ *
+ *  In libDAI, a factor is represented by a TFactor<T> object, which has two
+ *  components:
+ *  \arg a VarSet, corresponding with the set of variables \f$\{x_l\}_{l\in L}\f$
+ *  that the factor depends on;
+ *  \arg a TProb, a vector containing the value of the factor for each possible
+ *  joint state of the variables.
+ *
+ *  The factor values are stored in the entries of the TProb in a particular
+ *  ordering, which is defined by the one-to-one correspondence of a joint state
+ *  in \f$\prod_{l\in L} X_l\f$ with a linear index in
+ *  \f$\{0,1,\dots,\prod_{l\in L} S_l-1\}\f$ according to the mapping \f$\sigma\f$
+ *  induced by dai::calcLinearState().
+ *
+ *  \tparam T Should be a scalar that is castable from and to double and should support elementary arithmetic operations.
+ *  \todo Define a better fileformat for .fg files (maybe using XML)?
+ *  \todo Add support for sparse factors.
+ */
+template <typename T>
+class TFactor {
+    private:
+        /// Stores the variables on which the factor depends
+        VarSet _vs;
+        /// Stores the factor values
+        TProb<T> _p;
 
     public:
-        // Default constructor
-        TFactor () : _vs(), _p(1,1.0) {}
-        
-        // Construct Factor from VarSet
-        TFactor( const VarSet& ns ) : _vs(ns), _p(_vs.states()) {}
-        
-        // Construct Factor from VarSet and initial value
-        TFactor( const VarSet& ns, Real p ) : _vs(ns), _p(_vs.states(),p) {}
-        
-        // Construct Factor from VarSet and initial array
-        TFactor( const VarSet& ns, const Real* p ) : _vs(ns), _p(_vs.states(),p) {}
+    /// \name Constructors and destructors
+    //@{
+        /// Constructs factor depending on no variables with value \a p
+        TFactor ( T p = 1 ) : _vs(), _p(1,p) {}
 
-        // Construct Factor from VarSet and TProb<T>
-        TFactor( const VarSet& ns, const TProb<T> p ) : _vs(ns), _p(p) {
-#ifdef DAI_DEBUG
-            assert( _vs.states() == _p.size() );
-#endif
-        }
-        
-        // Construct Factor from Var
-        TFactor( const Var& n ) : _vs(n), _p(n.states()) {}
+        /// Constructs factor depending on the variable \a v with uniform distribution
+        TFactor( const Var &v ) : _vs(v), _p(v.states()) {}
 
-        // Copy constructor
-        TFactor( const TFactor<T> &x ) : _vs(x._vs), _p(x._p) {}
-        
-        // Assignment operator
-        TFactor<T> & operator= (const TFactor<T> &x) {
-            if( this != &x ) {
-                _vs = x._vs;
-                _p  = x._p;
-            }
-            return *this;
+        /// Constructs factor depending on variables in \a vars with uniform distribution
+        TFactor( const VarSet& vars ) : _vs(vars), _p((size_t)_vs.nrStates()) {
+            DAI_ASSERT( _vs.nrStates() <= std::numeric_limits<std::size_t>::max() );
         }
 
-        const TProb<T> & p() const { return _p; }
-        TProb<T> & p() { return _p; }
-        const VarSet & vars() const { return _vs; }
-        size_t states() const { 
-#ifdef DAI_DEBUG
-            assert( _vs.states() == _p.size() );
-#endif
-            return _p.size();
+        /// Constructs factor depending on variables in \a vars with all values set to \a p
+        TFactor( const VarSet& vars, T p ) : _vs(vars), _p((size_t)_vs.nrStates(),p) {
+            DAI_ASSERT( _vs.nrStates() <= std::numeric_limits<std::size_t>::max() );
         }
 
-        T operator[] (size_t i) const { return _p[i]; }
-        T& operator[] (size_t i) { return _p[i]; }
-        TFactor<T> & fill (T p)
-            { _p.fill( p ); return(*this); }
-        TFactor<T> & randomize ()
-            { _p.randomize(); return(*this); }
-        TFactor<T> operator* (T x) const {
-            Factor result = *this;
-            result.p() *= x;
-            return result;
+        /// Constructs factor depending on variables in \a vars, copying the values from a std::vector<>
+        /** \tparam S Type of values of \a x
+         *  \param vars contains the variables that the new factor should depend on.
+         *  \param x Vector with values to be copied.
+         */
+        template<typename S>
+        TFactor( const VarSet& vars, const std::vector<S> &x ) : _vs(vars), _p() {
+            DAI_ASSERT( x.size() == vars.nrStates() );
+            _p = TProb<T>( x.begin(), x.end(), x.size() );
         }
-        TFactor<T>& operator*= (T x) {
-            _p *= x;
-            return *this;
-        }
-        TFactor<T> operator/ (T x) const {
-            Factor result = *this;
-            result.p() /= x;
-            return result;
-        }
-        TFactor<T>& operator/= (T x) {
-            _p /= x;
-            return *this;
+
+        /// Constructs factor depending on variables in \a vars, copying the values from an array
+        /** \param vars contains the variables that the new factor should depend on.
+         *  \param p Points to array of values to be added.
+         */
+        TFactor( const VarSet& vars, const T* p ) : _vs(vars), _p(p, p + (size_t)_vs.nrStates(), (size_t)_vs.nrStates()) {
+            DAI_ASSERT( _vs.nrStates() <= std::numeric_limits<std::size_t>::max() );
         }
-        TFactor<T> operator* (const TFactor<T>& Q) const;
-        TFactor<T>& operator*= (const TFactor<T>& Q) { return( *this = (*this * Q) ); }
-        TFactor<T> operator+ (const TFactor<T>& Q) const {
-#ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
-#endif
-            TFactor<T> sum(*this); 
-            sum._p += Q._p; 
-            return sum; 
+
+        /// Constructs factor depending on variables in \a vars, copying the values from \a p
+        TFactor( const VarSet& vars, const TProb<T> &p ) : _vs(vars), _p(p) {
+            DAI_ASSERT( _vs.nrStates() == _p.size() );
         }
-        TFactor<T> operator- (const TFactor<T>& Q) const {
-#ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
-#endif
-            TFactor<T> sum(*this); 
-            sum._p -= Q._p; 
-            return sum; 
+
+        /// Constructs factor depending on variables in \a vars, permuting the values given in \a p accordingly
+        TFactor( const std::vector<Var> &vars, const std::vector<T> &p ) : _vs(vars.begin(), vars.end(), vars.size()), _p(p.size()) {
+            size_t nrStates = 1;
+            for( size_t i = 0; i < vars.size(); i++ )
+                nrStates *= vars[i].states();
+            DAI_ASSERT( nrStates == p.size() );
+            Permute permindex(vars);
+            for( size_t li = 0; li < p.size(); ++li )
+                _p.set( permindex.convertLinearIndex(li), p[li] );
         }
-        TFactor<T>& operator+= (const TFactor<T>& Q) { 
-#ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
-#endif
-            _p += Q._p;
-            return *this;
+    //@}
+
+    /// \name Get/set individual entries
+    //@{
+        /// Sets \a i 'th entry to \a val
+        void set( size_t i, T val ) { _p.set( i, val ); }
+
+        /// Gets \a i 'th entry
+        T get( size_t i ) const { return _p[i]; }
+    //@}
+
+    /// \name Queries
+    //@{
+        /// Returns constant reference to value vector
+        const TProb<T>& p() const { return _p; }
+
+        /// Returns reference to value vector
+        TProb<T>& p() { return _p; }
+
+        /// Returns a copy of the \a i 'th entry of the value vector
+        T operator[] (size_t i) const { return _p[i]; }
+
+        /// Returns constant reference to variable set (i.e., the variables on which the factor depends)
+        const VarSet& vars() const { return _vs; }
+
+        /// Returns reference to variable set (i.e., the variables on which the factor depends)
+        VarSet& vars() { return _vs; }
+
+        /// Returns the number of possible joint states of the variables on which the factor depends, \f$\prod_{l\in L} S_l\f$
+        /** \note This is equal to the length of the value vector.
+         */
+        size_t nrStates() const { return _p.size(); }
+
+        /// Returns the Shannon entropy of \c *this, \f$-\sum_i p_i \log p_i\f$
+        T entropy() const { return _p.entropy(); }
+
+        /// Returns maximum of all values
+        T max() const { return _p.max(); }
+
+        /// Returns minimum of all values
+        T min() const { return _p.min(); }
+
+        /// Returns sum of all values
+        T sum() const { return _p.sum(); }
+        
+        /// Returns sum of absolute values
+        T sumAbs() const { return _p.sumAbs(); }
+
+        /// Returns maximum absolute value of all values
+        T maxAbs() const { return _p.maxAbs(); }
+
+        /// Returns \c true if one or more values are NaN
+        bool hasNaNs() const { return _p.hasNaNs(); }
+
+        /// Returns \c true if one or more values are negative
+        bool hasNegatives() const { return _p.hasNegatives(); }
+
+        /// Returns strength of this factor (between variables \a i and \a j), as defined in eq. (52) of [\ref MoK07b]
+        T strength( const Var &i, const Var &j ) const;
+
+        /// Comparison
+        bool operator==( const TFactor<T>& y ) const {
+            return (_vs == y._vs) && (_p == y._p);
         }
-        TFactor<T>& operator-= (const TFactor<T>& Q) { 
-#ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
-#endif
-            _p -= Q._p;
-            return *this;
+    //@}
+
+    /// \name Unary transformations
+    //@{
+        /// Returns negative of \c *this
+        TFactor<T> operator- () const { 
+            // Note: the alternative (shorter) way of implementing this,
+            //   return TFactor<T>( _vs, _p.abs() );
+            // is slower because it invokes the copy constructor of TProb<T>
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = -_p;
+            return x;
         }
 
-        TFactor<T> operator^ (Real a) const { TFactor<T> x; x._vs = _vs; x._p = _p^a; return x; }
-        TFactor<T>& operator^= (Real a) { _p ^= a; return *this; }
-
-        TFactor<T>& makeZero( Real epsilon ) {
-            _p.makeZero( epsilon );
-            return *this;
+        /// Returns pointwise absolute value
+        TFactor<T> abs() const {
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = _p.abs();
+            return x;
         }
-            
-        TFactor<T> inverse() const { 
-            TFactor<T> inv; 
-            inv._vs = _vs; 
-            inv._p = _p.inverse(true);  // FIXME
-            return inv; 
+
+        /// Returns pointwise exponent
+        TFactor<T> exp() const {
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = _p.exp();
+            return x;
         }
 
-        TFactor<T> divided_by( const TFactor<T>& denom ) const { 
-#ifdef DAI_DEBUG
-            assert( denom._vs == _vs );
-#endif
-            TFactor<T> quot(*this); 
-            quot._p /= denom._p; 
-            return quot; 
+        /// Returns pointwise logarithm
+        /** If \a zero == \c true, uses <tt>log(0)==0</tt>; otherwise, <tt>log(0)==-Inf</tt>.
+         */
+        TFactor<T> log(bool zero=false) const {
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = _p.log(zero);
+            return x;
         }
 
-        TFactor<T>& divide( const TFactor<T>& denom ) {
-#ifdef DAI_DEBUG
-            assert( denom._vs == _vs );
-#endif
-            _p /= denom._p;
-            return *this;
+        /// Returns pointwise inverse
+        /** If \a zero == \c true, uses <tt>1/0==0</tt>; otherwise, <tt>1/0==Inf</tt>.
+         */
+        TFactor<T> inverse(bool zero=true) const {
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = _p.inverse(zero);
+            return x;
         }
 
-        TFactor<T> exp() const { 
-            TFactor<T> e; 
-            e._vs = _vs; 
-            e._p = _p.exp(); 
-            return e; 
+        /// Returns normalized copy of \c *this, using the specified norm
+        /** \throw NOT_NORMALIZABLE if the norm is zero
+         */
+        TFactor<T> normalized( ProbNormType norm=NORMPROB ) const {
+            TFactor<T> x;
+            x._vs = _vs;
+            x._p = _p.normalized( norm );
+            return x;
+        }
+    //@}
+
+    /// \name Unary operations
+    //@{
+        /// Draws all values i.i.d. from a uniform distribution on [0,1)
+        TFactor<T>& randomize() { _p.randomize(); return *this; }
+
+        /// Sets all values to \f$1/n\f$ where \a n is the number of states
+        TFactor<T>& setUniform() { _p.setUniform(); return *this; }
+
+        /// Applies absolute value pointwise
+        TFactor<T>& takeAbs() { _p.takeAbs(); return *this; }
+
+        /// Applies exponent pointwise
+        TFactor<T>& takeExp() { _p.takeExp(); return *this; }
+
+        /// Applies logarithm pointwise
+        /** If \a zero == \c true, uses <tt>log(0)==0</tt>; otherwise, <tt>log(0)==-Inf</tt>.
+         */
+        TFactor<T>& takeLog( bool zero = false ) { _p.takeLog(zero); return *this; }
+
+        /// Normalizes factor using the specified norm
+        /** \throw NOT_NORMALIZABLE if the norm is zero
+         */
+        T normalize( ProbNormType norm=NORMPROB ) { return _p.normalize( norm ); }
+    //@}
+
+    /// \name Operations with scalars
+    //@{
+        /// Sets all values to \a x
+        TFactor<T>& fill (T x) { _p.fill( x ); return *this; }
+
+        /// Adds scalar \a x to each value
+        TFactor<T>& operator+= (T x) { _p += x; return *this; }
+
+        /// Subtracts scalar \a x from each value
+        TFactor<T>& operator-= (T x) { _p -= x; return *this; }
+
+        /// Multiplies each value with scalar \a x
+        TFactor<T>& operator*= (T x) { _p *= x; return *this; }
+
+        /// Divides each entry by scalar \a x
+        TFactor<T>& operator/= (T x) { _p /= x; return *this; }
+
+        /// Raises values to the power \a x
+        TFactor<T>& operator^= (T x) { _p ^= x; return *this; }
+    //@}
+
+    /// \name Transformations with scalars
+    //@{
+        /// Returns sum of \c *this and scalar \a x
+        TFactor<T> operator+ (T x) const {
+            // Note: the alternative (shorter) way of implementing this,
+            //   TFactor<T> result(*this);
+            //   result._p += x;
+            // is slower because it invokes the copy constructor of TFactor<T>
+            TFactor<T> result;
+            result._vs = _vs;
+            result._p = p() + x;
+            return result;
         }
 
-        TFactor<T> log() const {
-            TFactor<T> l; 
-            l._vs = _vs; 
-            l._p = _p.log(); 
-            return l; 
+        /// Returns difference of \c *this and scalar \a x
+        TFactor<T> operator- (T x) const {
+            TFactor<T> result;
+            result._vs = _vs;
+            result._p = p() - x;
+            return result;
         }
 
-        TFactor<T> log0() const {
-            TFactor<T> l0; 
-            l0._vs = _vs; 
-            l0._p = _p.log0(); 
-            return l0; 
+        /// Returns product of \c *this with scalar \a x
+        TFactor<T> operator* (T x) const {
+            TFactor<T> result;
+            result._vs = _vs;
+            result._p = p() * x;
+            return result;
         }
 
-        T normalize( typename Prob::NormType norm ) { return _p.normalize( norm ); }
-        TFactor<T> normalized( typename Prob::NormType norm ) const { 
+        /// Returns quotient of \c *this with scalar \a x
+        TFactor<T> operator/ (T x) const {
             TFactor<T> result;
             result._vs = _vs;
-            result._p = _p.normalized( norm );
+            result._p = p() / x;
             return result;
         }
 
-        // returns slice of this factor where the subset ns is in state ns_state
-        Factor slice( const VarSet & ns, size_t ns_state ) const {
-            assert( ns << _vs );
-            VarSet nsrem = _vs / ns;
-            Factor result( nsrem, 0.0 );
-            
-            // OPTIMIZE ME
-            IndexFor i_ns (ns, _vs);
-            IndexFor i_nsrem (nsrem, _vs);
-            for( size_t i = 0; i < states(); i++, ++i_ns, ++i_nsrem )
-                if( (size_t)i_ns == ns_state )
-                    result._p[i_nsrem] = _p[i];
+        /// Returns \c *this raised to the power \a x
+        TFactor<T> operator^ (T x) const {
+            TFactor<T> result;
+            result._vs = _vs;
+            result._p = p() ^ x;
+            return result;
+        }
+    //@}
+
+    /// \name Operations with other factors
+    //@{
+        /// Applies binary operation \a op on two factors, \c *this and \a g
+        /** \tparam binOp Type of function object that accepts two arguments of type \a T and outputs a type \a T
+         *  \param g Right operand
+         *  \param op Operation of type \a binOp
+         */
+        template<typename binOp> TFactor<T>& binaryOp( const TFactor<T> &g, binOp op ) {
+            if( _vs == g._vs ) // optimize special case
+                _p.pwBinaryOp( g._p, op );
+            else {
+                TFactor<T> f(*this); // make a copy
+                _vs |= g._vs;
+                DAI_ASSERT( _vs.nrStates() < std::numeric_limits<std::size_t>::max() );
+                size_t N = (size_t)_vs.nrStates();
+
+                IndexFor i_f( f._vs, _vs );
+                IndexFor i_g( g._vs, _vs );
+
+                _p.p().clear();
+                _p.p().reserve( N );
+                for( size_t i = 0; i < N; i++, ++i_f, ++i_g )
+                    _p.p().push_back( op( f._p[i_f], g._p[i_g] ) );
+            }
+            return *this;
+        }
 
+        /// Adds \a g to \c *this
+        /** The sum of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[f+g : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) + g(x_M).\f]
+         */
+        TFactor<T>& operator+= (const TFactor<T>& g) { return binaryOp( g, std::plus<T>() ); }
+
+        /// Subtracts \a g from \c *this
+        /** The difference of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[f-g : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) - g(x_M).\f]
+         */
+        TFactor<T>& operator-= (const TFactor<T>& g) { return binaryOp( g, std::minus<T>() ); }
+
+        /// Multiplies \c *this with \a g
+        /** The product of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[fg : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) g(x_M).\f]
+         */
+        TFactor<T>& operator*= (const TFactor<T>& g) { return binaryOp( g, std::multiplies<T>() ); }
+
+        /// Divides \c *this by \a g (where division by zero yields zero)
+        /** The quotient of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[\frac{f}{g} : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto \frac{f(x_L)}{g(x_M)}.\f]
+         */
+        TFactor<T>& operator/= (const TFactor<T>& g) { return binaryOp( g, fo_divides0<T>() ); }
+    //@}
+
+    /// \name Transformations with other factors
+    //@{
+        /// Returns result of applying binary operation \a op on two factors, \c *this and \a g
+        /** \tparam binOp Type of function object that accepts two arguments of type \a T and outputs a type \a T
+         *  \param g Right operand
+         *  \param op Operation of type \a binOp
+         */
+        template<typename binOp> TFactor<T> binaryTr( const TFactor<T> &g, binOp op ) const {
+            // Note that to prevent a copy to be made, it is crucial 
+            // that the result is declared outside the if-else construct.
+            TFactor<T> result;
+            if( _vs == g._vs ) { // optimize special case
+                result._vs = _vs;
+                result._p = _p.pwBinaryTr( g._p, op );
+            } else {
+                result._vs = _vs | g._vs;
+                DAI_ASSERT( result._vs.nrStates() < std::numeric_limits<std::size_t>::max() );
+                size_t N = (size_t)result._vs.nrStates();
+
+                IndexFor i_f( _vs, result.vars() );
+                IndexFor i_g( g._vs, result.vars() );
+
+                result._p.p().clear();
+                result._p.p().reserve( N );
+                for( size_t i = 0; i < N; i++, ++i_f, ++i_g )
+                    result._p.p().push_back( op( _p[i_f], g[i_g] ) );
+            }
             return result;
         }
 
-        // returns unnormalized marginal
-        TFactor<T> part_sum(const VarSet & ns) const;
-        // returns normalized marginal
-        TFactor<T> marginal(const VarSet & ns) const { return part_sum(ns).normalized( Prob::NORMPROB ); }
+        /// Returns sum of \c *this and \a g
+        /** The sum of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[f+g : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) + g(x_M).\f]
+         */
+        TFactor<T> operator+ (const TFactor<T>& g) const {
+            return binaryTr(g,std::plus<T>());
+        }
 
-        bool hasNaNs() const { return _p.hasNaNs(); }
-        bool hasNegatives() const { return _p.hasNegatives(); }
-        T totalSum() const { return _p.totalSum(); }
-        T maxAbs() const { return _p.maxAbs(); }
-        T maxVal() const { return _p.maxVal(); }
-        Real entropy() const { return _p.entropy(); }
-        T strength( const Var &i, const Var &j ) const;
+        /// Returns \c *this minus \a g
+        /** The difference of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[f-g : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) - g(x_M).\f]
+         */
+        TFactor<T> operator- (const TFactor<T>& g) const {
+            return binaryTr(g,std::minus<T>());
+        }
 
-        friend Real dist( const TFactor<T> & x, const TFactor<T> & y, Prob::DistType dt ) {
-            if( x._vs.empty() || y._vs.empty() )
-                return -1;
-            else {
-#ifdef DAI_DEBUG
-                assert( x._vs == y._vs );
-#endif
-                return dist( x._p, y._p, dt );
-            }
+        /// Returns product of \c *this with \a g
+        /** The product of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[fg : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto f(x_L) g(x_M).\f]
+         */
+        TFactor<T> operator* (const TFactor<T>& g) const {
+            return binaryTr(g,std::multiplies<T>());
         }
-        friend Real KL_dist <> (const TFactor<T> & p, const TFactor<T> & q);
-        template<class U> friend std::ostream& operator<< (std::ostream& os, const TFactor<U>& P);
-};
 
+        /// Returns quotient of \c *this by \a f (where division by zero yields zero)
+        /** The quotient of two factors is defined as follows: if
+         *  \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$g : \prod_{m\in M} X_m \to [0,\infty)\f$, then
+         *  \f[\frac{f}{g} : \prod_{l\in L\cup M} X_l \to [0,\infty) : x \mapsto \frac{f(x_L)}{g(x_M)}.\f]
+         */
+        TFactor<T> operator/ (const TFactor<T>& g) const {
+            return binaryTr(g,fo_divides0<T>());
+        }
+    //@}
+
+    /// \name Miscellaneous operations
+    //@{
+        /// Returns a slice of \c *this, where the subset \a vars is in state \a varsState
+        /** \pre \a vars sould be a subset of vars()
+         *  \pre \a varsState < vars.nrStates()
+         *
+         *  The result is a factor that depends on the variables of *this except those in \a vars,
+         *  obtained by setting the variables in \a vars to the joint state specified by the linear index
+         *  \a varsState. Formally, if \c *this corresponds with the factor \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$,
+         *  \f$M \subset L\f$ corresponds with \a vars and \a varsState corresponds with a mapping \f$s\f$ that
+         *  maps a variable \f$x_m\f$ with \f$m\in M\f$ to its state \f$s(x_m) \in X_m\f$, then the slice
+         *  returned corresponds with the factor \f$g : \prod_{l \in L \setminus M} X_l \to [0,\infty)\f$
+         *  defined by \f$g(\{x_l\}_{l\in L \setminus M}) = f(\{x_l\}_{l\in L \setminus M}, \{s(x_m)\}_{m\in M})\f$.
+         */
+        TFactor<T> slice( const VarSet& vars, size_t varsState ) const; 
+
+        /// Embeds this factor in a larger VarSet
+        /** \pre vars() should be a subset of \a vars 
+         *
+         *  If *this corresponds with \f$f : \prod_{l\in L} X_l \to [0,\infty)\f$ and \f$L \subset M\f$, then
+         *  the embedded factor corresponds with \f$g : \prod_{m\in M} X_m \to [0,\infty) : x \mapsto f(x_L)\f$.
+         */
+        TFactor<T> embed(const VarSet & vars) const {
+            DAI_ASSERT( vars >> _vs );
+            if( _vs == vars )
+                return *this;
+            else
+                return (*this) * TFactor<T>(vars / _vs, (T)1);
+        }
 
-template<typename T> TFactor<T> TFactor<T>::part_sum(const VarSet & ns) const {
-#ifdef DAI_DEBUG
-    assert( ns << _vs );
-#endif
+        /// Returns marginal on \a vars, obtained by summing out all variables except those in \a vars, and normalizing the result if \a normed == \c true
+        TFactor<T> marginal(const VarSet &vars, bool normed=true) const;
 
-    TFactor<T> res( ns, 0.0 );
+        /// Returns max-marginal on \a vars, obtained by maximizing all variables except those in \a vars, and normalizing the result if \a normed == \c true
+        TFactor<T> maxMarginal(const VarSet &vars, bool normed=true) const;
+    //@}
+};
 
-    IndexFor i_res( ns, _vs );
-    for( size_t i = 0; i < _p.size(); i++, ++i_res )
-        res._p[i_res] += _p[i];
 
-    return res;
-}
+template<typename T> TFactor<T> TFactor<T>::slice( const VarSet& vars, size_t varsState ) const {
+    DAI_ASSERT( vars << _vs );
+    VarSet varsrem = _vs / vars;
+    TFactor<T> result( varsrem, T(0) );
 
+    // OPTIMIZE ME
+    IndexFor i_vars (vars, _vs);
+    IndexFor i_varsrem (varsrem, _vs);
+    for( size_t i = 0; i < nrStates(); i++, ++i_vars, ++i_varsrem )
+        if( (size_t)i_vars == varsState )
+            result.set( i_varsrem, _p[i] );
 
-template<typename T> std::ostream& operator<< (std::ostream& os, const TFactor<T>& P) {
-    os << "(" << P.vars() << " <";
-    for( size_t i = 0; i < P._p.size(); i++ )
-        os << P._p[i] << " ";
-    os << ">)";
-    return os;
+    return result;
 }
 
 
-template<typename T> TFactor<T> TFactor<T>::operator* (const TFactor<T>& Q) const {
-    TFactor<T> prod( _vs | Q._vs, 0.0 );
+template<typename T> TFactor<T> TFactor<T>::marginal(const VarSet &vars, bool normed) const {
+    VarSet res_vars = vars & _vs;
 
-    IndexFor i1(_vs, prod._vs);
-    IndexFor i2(Q._vs, prod._vs);
+    TFactor<T> res( res_vars, 0.0 );
 
-    for( size_t i = 0; i < prod._p.size(); i++, ++i1, ++i2 )
-        prod._p[i] += _p[i1] * Q._p[i2];
+    IndexFor i_res( res_vars, _vs );
+    for( size_t i = 0; i < _p.size(); i++, ++i_res )
+        res.set( i_res, res[i_res] + _p[i] );
 
-    return prod;
+    if( normed )
+        res.normalize( NORMPROB );
+
+    return res;
 }
 
 
-template<typename T> Real KL_dist(const TFactor<T> & P, const TFactor<T> & Q) {
-    if( P._vs.empty() || Q._vs.empty() )
-        return -1;
-    else {
-#ifdef DAI_DEBUG
-        assert( P._vs == Q._vs );
-#endif
-        return KL_dist( P._p, Q._p );
-    }
+template<typename T> TFactor<T> TFactor<T>::maxMarginal(const VarSet &vars, bool normed) const {
+    VarSet res_vars = vars & _vs;
+
+    TFactor<T> res( res_vars, 0.0 );
+
+    IndexFor i_res( res_vars, _vs );
+    for( size_t i = 0; i < _p.size(); i++, ++i_res )
+        if( _p[i] > res._p[i_res] )
+            res.set( i_res, _p[i] );
+
+    if( normed )
+        res.normalize( NORMPROB );
+
+    return res;
 }
 
 
-// calculate N(psi, i, j)
 template<typename T> T TFactor<T>::strength( const Var &i, const Var &j ) const {
-#ifdef DAI_DEBUG
-    assert( _vs.contains( i ) );
-    assert( _vs.contains( j ) );
-    assert( i != j );
-#endif
-    VarSet ij = i | j;
+    DAI_DEBASSERT( _vs.contains( i ) );
+    DAI_DEBASSERT( _vs.contains( j ) );
+    DAI_DEBASSERT( i != j );
+    VarSet ij(i, j);
 
     T max = 0.0;
     for( size_t alpha1 = 0; alpha1 < i.states(); alpha1++ )
         for( size_t alpha2 = 0; alpha2 < i.states(); alpha2++ )
             if( alpha2 != alpha1 )
-                for( size_t beta1 = 0; beta1 < j.states(); beta1++ ) 
+                for( size_t beta1 = 0; beta1 < j.states(); beta1++ )
                     for( size_t beta2 = 0; beta2 < j.states(); beta2++ )
                         if( beta2 != beta1 ) {
                             size_t as = 1, bs = 1;
@@ -327,31 +564,126 @@ template<typename T> T TFactor<T>::strength( const Var &i, const Var &j ) const
                                 bs = i.states();
                             else
                                 as = j.states();
-                            T f1 = slice( ij, alpha1 * as + beta1 * bs ).p().divide( slice( ij, alpha2 * as + beta1 * bs ).p() ).maxVal();
-                            T f2 = slice( ij, alpha2 * as + beta2 * bs ).p().divide( slice( ij, alpha1 * as + beta2 * bs ).p() ).maxVal();
+                            T f1 = slice( ij, alpha1 * as + beta1 * bs ).p().divide( slice( ij, alpha2 * as + beta1 * bs ).p() ).max();
+                            T f2 = slice( ij, alpha2 * as + beta2 * bs ).p().divide( slice( ij, alpha1 * as + beta2 * bs ).p() ).max();
                             T f = f1 * f2;
                             if( f > max )
                                 max = f;
                         }
-    
+
     return std::tanh( 0.25 * std::log( max ) );
 }
 
 
-template<typename T> TFactor<T> RemoveFirstOrderInteractions( const TFactor<T> & psi ) {
-    TFactor<T> result = psi;
+/// Writes a factor to an output stream
+/** \relates TFactor
+ */
+template<typename T> std::ostream& operator<< (std::ostream& os, const TFactor<T>& f) {
+    os << "(" << f.vars() << ", (";
+    for( size_t i = 0; i < f.nrStates(); i++ )
+        os << (i == 0 ? "" : ", ") << f[i];
+    os << "))";
+    return os;
+}
+
 
-    VarSet vars = psi.vars();
-    for( size_t iter = 0; iter < 100; iter++ ) {
-        for( VarSet::const_iterator n = vars.begin(); n != vars.end(); n++ )
-            result = result * result.part_sum(*n).inverse();
-        result.normalize( Prob::NORMPROB );
+/// Returns distance between two factors \a f and \a g, according to the distance measure \a dt
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> T dist( const TFactor<T> &f, const TFactor<T> &g, ProbDistType dt ) {
+    if( f.vars().empty() || g.vars().empty() )
+        return -1;
+    else {
+        DAI_DEBASSERT( f.vars() == g.vars() );
+        return dist( f.p(), g.p(), dt );
     }
+}
 
-    return result;
+
+/// Returns the pointwise maximum of two factors
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> TFactor<T> max( const TFactor<T> &f, const TFactor<T> &g ) {
+    DAI_ASSERT( f.vars() == g.vars() );
+    return TFactor<T>( f.vars(), max( f.p(), g.p() ) );
+}
+
+
+/// Returns the pointwise minimum of two factors
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> TFactor<T> min( const TFactor<T> &f, const TFactor<T> &g ) {
+    DAI_ASSERT( f.vars() == g.vars() );
+    return TFactor<T>( f.vars(), min( f.p(), g.p() ) );
 }
 
 
+/// Calculates the mutual information between the two variables that \a f depends on, under the distribution given by \a f
+/** \relates TFactor
+ *  \pre f.vars().size() == 2
+ */
+template<typename T> T MutualInfo(const TFactor<T> &f) {
+    DAI_ASSERT( f.vars().size() == 2 );
+    VarSet::const_iterator it = f.vars().begin();
+    Var i = *it; it++; Var j = *it;
+    TFactor<T> projection = f.marginal(i) * f.marginal(j);
+    return dist( f.normalized(), projection, DISTKL );
+}
+
+
+/// Represents a factor with values of type dai::Real.
+typedef TFactor<Real> Factor;
+
+
+/// Returns a binary unnormalized single-variable factor \f$ \exp(hx) \f$ where \f$ x = \pm 1 \f$
+/** \param x Variable (should be binary)
+ *  \param h Field strength
+ */
+Factor createFactorIsing( const Var &x, Real h );
+
+
+/// Returns a binary unnormalized pairwise factor \f$ \exp(J x_1 x_2) \f$ where \f$ x_1, x_2 = \pm 1 \f$
+/** \param x1 First variable (should be binary)
+ *  \param x2 Second variable (should be binary)
+ *  \param J Coupling strength
+ */
+Factor createFactorIsing( const Var &x1, const Var &x2, Real J );
+
+
+/// Returns a random factor on the variables \a vs with strength \a beta
+/** Each entry are set by drawing a normally distributed random with mean
+ *  0 and standard-deviation \a beta, and taking its exponent.
+ *  \param vs Variables
+ *  \param beta Factor strength (inverse temperature)
+ */
+Factor createFactorExpGauss( const VarSet &vs, Real beta );
+
+
+/// Returns a pairwise Potts factor \f$ \exp( J \delta_{x_1, x_2} ) \f$
+/** \param x1 First variable
+ *  \param x2 Second variable (should have the same number of states as \a x1)
+ *  \param J  Factor strength
+ */
+Factor createFactorPotts( const Var &x1, const Var &x2, Real J );
+
+
+/// Returns a Kronecker delta point mass
+/** \param v Variable
+ *  \param state The state of \a v that should get value 1
+ */
+Factor createFactorDelta( const Var &v, size_t state );
+
+
+/// Returns a Kronecker delta point mass
+/** \param vs Set of variables
+ *  \param state The state of \a vs that should get value 1
+ */
+Factor createFactorDelta( const VarSet& vs, size_t state );
+
+
 } // end of namespace dai