Improved documentation of include/dai/enum.h and include/dai/factor.h
authorJoris Mooij <jorism@osun.tuebingen.mpg.de>
Thu, 9 Oct 2008 19:35:05 +0000 (21:35 +0200)
committerJoris Mooij <jorism@osun.tuebingen.mpg.de>
Thu, 9 Oct 2008 19:35:05 +0000 (21:35 +0200)
TODO
include/dai/enum.h
include/dai/factor.h
include/dai/prob.h
include/dai/util.h
include/dai/var.h
include/dai/varset.h

diff --git a/TODO b/TODO
index d389239..96601c0 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,10 @@
 TODO:
 
 - Improve documentation.
+  * COPYING 
+  * FILEFORMAT
+  * Merge README with mainpage, removing duplicate text
+  * Document examples, tests and utils
 
 - Adapt http://www.boost.org/development/requirements.html#Design_and_Programming
 
index 441551b..491cd35 100644 (file)
@@ -22,7 +22,6 @@
 
 /// \file
 /// \brief Defines the DAI_ENUM macro
-/// \todo Improve documentation
 
 
 #ifndef __defined_libdai_enum_h
 #include <dai/exceptions.h>
 
 
-/// Extends the C++ enum type by supporting input/output streaming and conversion to and from const char*
-/** Example of usage:
+/// Extends the C++ enum type by supporting input/output streaming and conversion to and from const char* and size_t
+/** For more details see the source code.
+ *
+ *  \par Example:
  *  \code
- *      DAI_ENUM(colors,RED,GREEN,BLUE)
+ *  DAI_ENUM(colors,RED,GREEN,BLUE)
  *  \endcode
- *  defines a class encapsulating an
+ *  defines a class \a colors encapsulating an
  *  \code
- *      enum colors {RED, GREEN, BLUE};
+ *  enum {RED, GREEN, BLUE};
  *  \endcode
- *  It offers additional functionality over the plain "enum" keyword.
+ *  which offers additional functionality over the plain \c enum keyword.
  */
 #define DAI_ENUM(x,val0,...) class x {\
     public:\
index d618a3f..9e0b42b 100644 (file)
 namespace dai {
 
 
-// predefine TFactor<T> class
-template<typename T> class      TFactor;
-
-
-/// Represents a factor with probability entries represented as Real
-typedef TFactor<Real>           Factor;
-
-
-/// Represents a probability factor.
-/** A \e factor is a function of the Cartesian product of the state
- *  spaces of some set of variables to the nonnegative real numbers.
- *  More formally, if \f$x_i \in X_i\f$ for all \f$i\f$, then a factor
- *  depending on the variables \f$\{x_i\}\f$ is a function defined
- *  on \f$\prod_i X_i\f$ with values in \f$[0,\infty)\f$.
+/// Represents a (probability) factor.
+/** Mathematically, a \e factor is a function from the Cartesian product 
+ *  of the state spaces 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$,
+ *  then a factor depending on the variables \f$\{x_i\}_{i\in I}\f$ is 
+ *  a function \f$f_I : \prod_{i\in I} X_i \to [0,\infty)\f$.
  *  
- *  A Factor has two components: a VarSet, defining the set of variables
- *  that the factor depends on, and a TProb<T>, containing the values of
- *  the factor for all possible joint states of the variables.
+ *  In libDAI, a factor is represented by a TFactor<\a T> object, which has two
+ *  components: 
+ *  \arg a VarSet, corresponding with the set of variables \f$\{x_i\}_{i\in I}\f$ 
+ *  that the factor depends on;
+ *  \arg a TProb<\a T>, a vector containing the values of the factor for each possible 
+ *  joint state of the variables.
  *
- *  \tparam T Should be castable from and to double.
+ *  The factor values are stored in the entries of the TProb<\a T> in a particular
+ *  ordering, which is defined by the one-to-one correspondence of a joint state 
+ *  in \f$\prod_{i\in I} X_i\f$ with a linear index in 
+ *  \f$\{0,1,\dots,\prod_{i\in I} S_i-1\}\f$ according to the mapping \f$\sigma\f$
+ *  induced by VarSet::calcState(const std::map<Var,size_t> &).
+ *
+ *  \tparam T Should be a scalar that is castable from and to double and should support elementary arithmetic operations.
  */
 template <typename T> class TFactor {
     private:
@@ -69,26 +71,26 @@ template <typename T> class TFactor {
         TProb<T>    _p;
 
     public:
-        /// Construct Factor with empty VarSet
+        /// Construct TFactor depending on no variables, with value p
         TFactor ( Real p = 1.0 ) : _vs(), _p(1,p) {}
 
-        /// Construct Factor from VarSet
+        /// Construct TFactor depending on variables in ns, with uniform distribution
         TFactor( const VarSet& ns ) : _vs(ns), _p(_vs.nrStates()) {}
         
-        /// Construct Factor from VarSet and initial value
+        /// Construct TFactor depending on variables in ns, with all values set to p
         TFactor( const VarSet& ns, Real p ) : _vs(ns), _p(_vs.nrStates(),p) {}
         
-        /// Construct Factor from VarSet and initial array
+        /// Construct TFactor depending on variables in ns, copying the values from the array p
         TFactor( const VarSet& ns, const Real *p ) : _vs(ns), _p(_vs.nrStates(),p) {}
 
-        /// Construct Factor from VarSet and TProb<T>
+        /// Construct TFactor depending on variables in ns, with values set to the TProb p
         TFactor( const VarSet& ns, const TProb<T>& p ) : _vs(ns), _p(p) {
 #ifdef DAI_DEBUG
             assert( _vs.nrStates() == _p.size() );
 #endif
         }
         
-        /// Construct Factor from Var
+        /// Construct TFactor depending on the variable n, with uniform distribution
         TFactor( const Var& n ) : _vs(n), _p(n.states()) {}
 
         /// Copy constructor
@@ -103,150 +105,175 @@ template <typename T> class TFactor {
             return *this;
         }
 
-        /// Returns const reference to probability entries
+        /// Returns const reference to value vector
         const TProb<T> & p() const { return _p; }
-        /// Returns reference to probability entries
+        /// Returns reference to value vector
         TProb<T> & p() { return _p; }
 
-        /// Returns const reference to variables
+        /// Returns const reference to variable set
         const VarSet & vars() const { return _vs; }
 
         /// Returns the number of possible joint states of the variables
         size_t states() const { return _p.size(); }
 
-        /// Returns a copy of the i'th probability value
+        /// Returns a copy of the i'th entry of the value vector
         T operator[] (size_t i) const { return _p[i]; }
 
-        /// Returns a reference to the i'th probability value
+        /// Returns a reference to the i'th entry of the value vector
         T& operator[] (size_t i) { return _p[i]; }
 
-        /// Sets all probability entries to p
+        /// Sets all values to p
         TFactor<T> & fill (T p) { _p.fill( p ); return(*this); }
 
-        /// Fills all probability entries with random values
+        /// Draws all values i.i.d. from a uniform distribution on [0,1)
         TFactor<T> & randomize () { _p.randomize(); return(*this); }
 
-        /// Returns product of *this with x
-        TFactor<T> operator* (T x) const {
-            Factor result = *this;
-            result.p() *= x;
+        /// Returns product of *this with scalar t
+        TFactor<T> operator* (T t) const {
+            TFactor<T> result = *this;
+            result.p() *= t;
             return result;
         }
 
-        /// Multiplies each probability entry with x
-        TFactor<T>& operator*= (T x) {
-            _p *= x;
+        /// Multiplies with scalar t
+        TFactor<T>& operator*= (T t) {
+            _p *= t;
             return *this;
         }
 
-        /// Returns quotient of *this with x
-        TFactor<T> operator/ (T x) const {
-            Factor result = *this;
-            result.p() /= x;
+        /// Returns quotient of *this with scalar t
+        TFactor<T> operator/ (T t) const {
+            TFactor<T> result = *this;
+            result.p() /= t;
             return result;
         }
 
-        /// Divides each probability entry by x
-        TFactor<T>& operator/= (T x) {
-            _p /= x;
+        /// Divides by scalar t
+        TFactor<T>& operator/= (T t) {
+            _p /= t;
+            return *this;
+        }
+
+        /// Adds scalar t to *this
+        TFactor<T>& operator+= (T t) { 
+            _p += t;
+            return *this;
+        }
+
+        /// Subtracts scalar t from *this
+        TFactor<T>& operator-= (T t) { 
+            _p -= t;
             return *this;
         }
 
-        /// Returns product of *this with another Factor
-        TFactor<T> operator* (const TFactor<T>& Q) const;
+        /// Returns sum of *this and scalar t
+        TFactor<T> operator+ (T t) const {
+            TFactor<T> result(*this); 
+            result._p += t; 
+            return result; 
+        }
+
+        /// Returns *this minus scalar t
+        TFactor<T> operator- (T t) const {
+            TFactor<T> result(*this); 
+            result._p -= t; 
+            return result; 
+        }
 
-        /// Returns quotient of *this with another Factor
-        TFactor<T> operator/ (const TFactor<T>& Q) const;
+        /// Returns product of *this with another TFactor f
+        /** The result is a TFactor depending on the union of the variables
+         *  on which *this and f depend.
+         */
+        TFactor<T> operator* (const TFactor<T>& f) const;
+
+        /// Returns quotient of *this by another TFactor f
+        /** The result is a TFactor depending on the union of the variables
+         *  on which *this and f depend.
+         */
+        TFactor<T> operator/ (const TFactor<T>& f) const;
 
-        /// Multiplies *this with another Factor
-        TFactor<T>& operator*= (const TFactor<T>& Q) { return( *this = (*this * Q) ); }
+        /// Multiplies *this with another TFactor f
+        /** The result is a TFactor depending on the union of the variables
+         *  on which *this and f depend.
+         */
+        TFactor<T>& operator*= (const TFactor<T>& f) { return( *this = (*this * f) ); }
 
-        /// Divides *this by another Factor
-        TFactor<T>& operator/= (const TFactor<T>& Q) { return( *this = (*this / Q) ); }
+        /// Divides *this by another TFactor f
+        /** The result is a TFactor depending on the union of the variables
+         *  on which *this and f depend.
+         */
+        TFactor<T>& operator/= (const TFactor<T>& f) { return( *this = (*this / f) ); }
 
-        /// Returns sum of *this and another Factor (their vars() should be identical)
-        TFactor<T> operator+ (const TFactor<T>& Q) const {
+        /// Returns sum of *this and another TFactor f
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T> operator+ (const TFactor<T>& f) const {
 #ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
+            assert( f._vs == _vs );
 #endif
             TFactor<T> sum(*this); 
-            sum._p += Q._p; 
+            sum._p += f._p; 
             return sum; 
         }
 
-        /// Returns difference of *this and another Factor (their vars() should be identical)
-        TFactor<T> operator- (const TFactor<T>& Q) const {
+        /// Returns *this minus another TFactor f
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T> operator- (const TFactor<T>& f) const {
 #ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
+            assert( f._vs == _vs );
 #endif
             TFactor<T> sum(*this); 
-            sum._p -= Q._p; 
+            sum._p -= f._p; 
             return sum; 
         }
 
-        /// Adds another Factor to *this (their vars() should be identical)
-        TFactor<T>& operator+= (const TFactor<T>& Q) { 
+        /// Adds another TFactor f to *this
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T>& operator+= (const TFactor<T>& f) { 
 #ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
+            assert( f._vs == _vs );
 #endif
-            _p += Q._p;
+            _p += f._p;
             return *this;
         }
 
-        /// Subtracts another Factor from *this (their vars() should be identical)
-        TFactor<T>& operator-= (const TFactor<T>& Q) { 
+        /// Subtracts another TFactor f from *this
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T>& operator-= (const TFactor<T>& f) { 
 #ifdef DAI_DEBUG
-            assert( Q._vs == _vs );
+            assert( f._vs == _vs );
 #endif
-            _p -= Q._p;
+            _p -= f._p;
             return *this;
         }
 
-        /// Adds scalar to *this
-        TFactor<T>& operator+= (T q) { 
-            _p += q;
-            return *this;
+        /// Returns *this raised to the power a
+        TFactor<T> operator^ (Real a) const { 
+            TFactor<T> x; 
+            x._vs = _vs; 
+            x._p = _p^a; 
+            return x; 
         }
 
-        /// Subtracts scalar from *this
-        TFactor<T>& operator-= (T q) { 
-            _p -= q;
-            return *this;
-        }
-
-        /// Returns sum of *this and a scalar
-        TFactor<T> operator+ (T q) const {
-            TFactor<T> result(*this); 
-            result._p += q; 
-            return result; 
-        }
-
-        /// Returns difference of *this with a scalar
-        TFactor<T> operator- (T q) const {
-            TFactor<T> result(*this); 
-            result._p -= q; 
-            return result; 
-        }
-
-        /// Returns *this raised to some power
-        TFactor<T> operator^ (Real a) const { TFactor<T> x; x._vs = _vs; x._p = _p^a; return x; }
-
-        /// Raises *this to some power
+        /// Raises *this to the power a
         TFactor<T>& operator^= (Real a) { _p ^= a; return *this; }
 
-        /// Sets all entries that are smaller than epsilon to zero
-        TFactor<T>& makeZero( Real epsilon ) {
+        /// Sets all values that are smaller than epsilon to 0
+        TFactor<T>& makeZero( T epsilon ) {
             _p.makeZero( epsilon );
             return *this;
         }
 
-        /// Sets all entries that are smaller than epsilon to epsilon
-        TFactor<T>& makePositive( Real epsilon ) {
+        /// Sets all values that are smaller than epsilon to epsilon
+        TFactor<T>& makePositive( T epsilon ) {
             _p.makePositive( epsilon );
             return *this;
         }
             
-        /// Returns inverse of *this.
+        /// Returns pointwise inverse of *this.
         /** If zero == true, uses 1 / 0 == 0; otherwise 1 / 0 == Inf.
          */
         TFactor<T> inverse(bool zero=true) const { 
@@ -256,26 +283,30 @@ template <typename T> class TFactor {
             return inv; 
         }
 
-        /// Returns *this divided by another Factor
-        TFactor<T> divided_by( const TFactor<T>& denom ) const { 
+        /// Returns *this divided pointwise by another TFactor f
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T> divided_by( const TFactor<T>& f ) const { 
 #ifdef DAI_DEBUG
-            assert( denom._vs == _vs );
+            assert( f._vs == _vs );
 #endif
             TFactor<T> quot(*this); 
-            quot._p /= denom._p; 
+            quot._p /= f._p; 
             return quot; 
         }
 
-        /// Divides *this by another Factor
-        TFactor<T>& divide( const TFactor<T>& denom ) {
+        /// Divides *this pointwise by another TFactor f
+        /** \pre this->vars() == f.vars()
+         */
+        TFactor<T>& divide( const TFactor<T>& f ) {
 #ifdef DAI_DEBUG
-            assert( denom._vs == _vs );
+            assert( f._vs == _vs );
 #endif
-            _p /= denom._p;
+            _p /= f._p;
             return *this;
         }
 
-        /// Returns exp of *this
+        /// Returns pointwise exp of *this
         TFactor<T> exp() const { 
             TFactor<T> e; 
             e._vs = _vs; 
@@ -283,7 +314,7 @@ template <typename T> class TFactor {
             return e; 
         }
 
-        /// Returns absolute value of *this
+        /// Returns pointwise absolute value of *this
         TFactor<T> abs() const { 
             TFactor<T> e; 
             e._vs = _vs; 
@@ -291,7 +322,7 @@ template <typename T> class TFactor {
             return e; 
         }
 
-        /// Returns logarithm of *this
+        /// Returns pointwise logarithm of *this
         /** If zero==true, uses log(0)==0; otherwise, log(0)=-Inf.
          */
         TFactor<T> log(bool zero=false) const {
@@ -301,82 +332,88 @@ template <typename T> class TFactor {
             return l; 
         }
 
-        /// Normalizes *this Factor
-        T normalize( typename Prob::NormType norm = Prob::NORMPROB ) { return _p.normalize( norm ); }
+        /// Normalizes *this TFactor according to the specified norm
+        T normalize( typename Prob::NormType norm=Prob::NORMPROB ) { return _p.normalize( norm ); }
 
-        /// Returns a normalized copy of *this
-        TFactor<T> normalized( typename Prob::NormType norm = Prob::NORMPROB ) const { 
+        /// Returns a normalized copy of *this, according to the specified norm
+        TFactor<T> normalized( typename Prob::NormType norm=Prob::NORMPROB ) const { 
             TFactor<T> result;
             result._vs = _vs;
             result._p = _p.normalized( norm );
             return result;
         }
 
-        /// Returns a slice of this factor, where the subset ns is in state ns_state
-        Factor slice( const VarSet & ns, size_t ns_state ) const {
+        /// Returns a slice of this TFactor, where the subset ns is in state nsState
+        /** \pre ns sould be a subset of vars()
+         *  \pre nsState < ns.states()
+         */
+        TFactor<T> slice( const VarSet& ns, size_t nsState ) const {
             assert( ns << _vs );
             VarSet nsrem = _vs / ns;
-            Factor result( nsrem, 0.0 );
+            TFactor<T> result( nsrem, T(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 )
+                if( (size_t)i_ns == nsState )
                     result._p[i_nsrem] = _p[i];
 
             return result;
         }
 
-        /// Returns unnormalized marginal; ns should be a subset of vars()
-        TFactor<T> partSum(const VarSet & ns) const;
-
-        /// Returns (normalized by default) marginal; ns should be a subset of vars()
-        TFactor<T> marginal(const VarSet & ns, bool normed = true) const { if(normed) return partSum(ns).normalized(); else return partSum(ns); }
+        /// Returns unnormalized marginal obtained by summing out all variables except those in ns
+        TFactor<T> partSum(const VarSet &ns) const;
 
-        /// Sums out all variables except those in ns
-        TFactor<T> notSum(const VarSet & ns) const { return partSum(vars() ^ ns); }
+        /// Returns (normalized by default) marginal on ns, obtained by summing out all variables except those in ns
+        /** If normed==true, the result is normalized.
+         */
+        TFactor<T> marginal(const VarSet & ns, bool normed=true) const { 
+            if( normed ) 
+                return partSum(ns).normalized(); 
+            else 
+                return partSum(ns); 
+        }
 
         /// Embeds this factor in a larger VarSet
+        /** \pre vars() should be a subset of ns
+         */
         TFactor<T> embed(const VarSet & ns) const { 
-            VarSet vs = vars();
-            assert( ns >> vs );
-            if( vs == ns )
+            assert( ns >> _vs );
+            if( _vs == ns )
                 return *this;
             else
-                return (*this) * Factor(ns / vs, 1.0);
+                return (*this) * TFactor<T>(ns / _vs, 1);
         }
 
-        /// Returns true if *this has NANs
+        /// Returns true if *this has NaN values
         bool hasNaNs() const { return _p.hasNaNs(); }
 
-        /// Returns true if *this has negative entries
+        /// Returns true if *this has negative values
         bool hasNegatives() const { return _p.hasNegatives(); }
 
-        /// Returns total sum of probability entries
+        /// Returns total sum of values
         T totalSum() const { return _p.totalSum(); }
 
-        /// Returns maximum absolute value of probability entries
+        /// Returns maximum absolute value
         T maxAbs() const { return _p.maxAbs(); }
 
-        /// Returns maximum value of probability entries
+        /// Returns maximum value
         T maxVal() const { return _p.maxVal(); }
 
-        /// Returns minimum value of probability entries
+        /// Returns minimum value
         T minVal() const { return _p.minVal(); }
 
         /// Returns entropy of *this
         Real entropy() const { return _p.entropy(); }
 
-        /// Returns strength of *this, between variables i and j, using (52) of [\ref MoK07b]
+        /// Returns strength of *this, between variables i and j, as defined in eq. (52) of [\ref MoK07b]
         T strength( const Var &i, const Var &j ) const;
 };
 
 
 template<typename T> TFactor<T> TFactor<T>::partSum(const VarSet & ns) const {
-#ifdef DAI_DEBUG
-    assert( ns << _vs );
-#endif
+    ns &= _vs;
 
     TFactor<T> res( ns, 0.0 );
 
@@ -402,7 +439,7 @@ template<typename T> TFactor<T> TFactor<T>::operator* (const TFactor<T>& Q) cons
 
 
 template<typename T> TFactor<T> TFactor<T>::operator/ (const TFactor<T>& Q) const {
-    TFactor<T> quot( _vs + Q._vs, 0.0 );
+    TFactor<T> quot( _vs | Q._vs, 0.0 );
 
     IndexFor i1(_vs, quot._vs);
     IndexFor i2(Q._vs, quot._vs);
@@ -445,7 +482,9 @@ template<typename T> T TFactor<T>::strength( const Var &i, const Var &j ) const
 }
 
 
-/// Writes a Factor to an output stream
+/// Writes a TFactor to an output stream
+/** \relates TFactor
+ */
 template<typename T> std::ostream& operator<< (std::ostream& os, const TFactor<T>& P) {
     os << "(" << P.vars() << " <";
     for( size_t i = 0; i < P.states(); i++ )
@@ -455,43 +494,59 @@ template<typename T> std::ostream& operator<< (std::ostream& os, const TFactor<T
 }
 
 
-/// Returns distance between two Factors (with identical vars())
-template<typename T> Real dist( const TFactor<T> & x, const TFactor<T> & y, Prob::DistType dt ) {
-    if( x.vars().empty() || y.vars().empty() )
+/// Returns distance between two TFactors f and g, according to the distance measure dt
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> Real dist( const TFactor<T> &f, const TFactor<T> &g, Prob::DistType dt ) {
+    if( f.vars().empty() || g.vars().empty() )
         return -1;
     else {
 #ifdef DAI_DEBUG
-        assert( x.vars() == y.vars() );
+        assert( f.vars() == g.vars() );
 #endif
-        return dist( x.p(), y.p(), dt );
+        return dist( f.p(), g.p(), dt );
     }
 }
 
 
-/// Returns the pointwise maximum of two Factors
-template<typename T> TFactor<T> max( const TFactor<T> & P, const TFactor<T> & Q ) {
-    assert( P._vs == Q._vs );
-    return TFactor<T>( P._vs, min( P.p(), Q.p() ) );
+/// Returns the pointwise maximum of two TFactors
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> TFactor<T> max( const TFactor<T> &f, const TFactor<T> &g ) {
+    assert( f._vs == g._vs );
+    return TFactor<T>( f._vs, min( f.p(), g.p() ) );
 }
 
 
-/// Returns the pointwise minimum of two Factors
-template<typename T> TFactor<T> min( const TFactor<T> & P, const TFactor<T> & Q ) {
-    assert( P._vs == Q._vs );
-    return TFactor<T>( P._vs, max( P.p(), Q.p() ) );
+/// Returns the pointwise minimum of two TFactors
+/** \relates TFactor
+ *  \pre f.vars() == g.vars()
+ */
+template<typename T> TFactor<T> min( const TFactor<T> &f, const TFactor<T> &g ) {
+    assert( f._vs == g._vs );
+    return TFactor<T>( f._vs, max( f.p(), g.p() ) );
 }
 
 
-/// Calculates the mutual information between the two variables in P
-template<typename T> Real MutualInfo(const TFactor<T> & P) {
-    assert( P.vars().size() == 2 );
-    VarSet::const_iterator it = P.vars().begin();
+/// Calculates the mutual information between the two variables that f depends on, under the distribution given by f
+/** \relates TFactor
+ *  \pre f.vars().size() == 2
+ */ 
+template<typename T> Real MutualInfo(const TFactor<T> &f) {
+    assert( f.vars().size() == 2 );
+    VarSet::const_iterator it = f.vars().begin();
     Var i = *it; it++; Var j = *it;
-    TFactor<T> projection = P.marginal(i) * P.marginal(j);
-    return real( dist( P.normalized(), projection, Prob::DISTKL ) );
+    TFactor<T> projection = f.marginal(i) * f.marginal(j);
+    return real( dist( f.normalized(), projection, Prob::DISTKL ) );
 }
 
 
+/// Represents a factor with values of type Real.
+typedef TFactor<Real> Factor;
+
+
 } // end of namespace dai
 
 
index 82af64f..d165bfc 100644 (file)
 namespace dai {
 
 
-/// Real number (alias for double, which could be changed to long double if necessary)
-typedef double             Real;
-
-// Predefine class
-template<typename T> class TProb;
-
-/// Represents a probability measure, with entries of type Real.
-typedef TProb<Real>        Prob;
-
-
 /// Represents a vector with entries of type \a T.
 /** A TProb<T> is a std::vector<T> with an interface designed for dealing with probability mass functions.
  *  It is mainly used for representing measures on a finite outcome space, e.g., the probability 
@@ -115,7 +105,7 @@ template <typename T> class TProb {
             return *this;
         }
 
-        /// Sets all entries to i.i.d. random numbers from a uniform[0,1) distribution
+        /// Draws all entries i.i.d. from a uniform distribution on [0,1)
         TProb<T> & randomize() { 
             std::generate(_p.begin(), _p.end(), rnd_uniform);
             return *this;
@@ -534,6 +524,10 @@ template<typename T> TProb<T> max( const TProb<T> &a, const TProb<T> &b ) {
 }
 
 
+/// Represents a vector with entries of type Real.
+typedef TProb<Real> Prob;
+
+
 } // end of namespace dai
 
 
index 49f5b79..3053b91 100644 (file)
 #define foreach BOOST_FOREACH
 
 
+/// Real number (alias for double, which could be changed to long double if necessary)
+typedef double Real;
+
+
 #ifdef WINDOWS
     /// Returns true if argument is NAN (Not A Number)
     bool isnan( double x );
index 042a246..f50521e 100644 (file)
@@ -46,7 +46,8 @@ namespace dai {
  *  In this manual, we use the following notational conventions. The discrete
  *  random variable with label \f$l\f$ is denoted as \f$x_l\f$, and the number 
  *  of possible values of this variable as \f$S_l\f$; this is represented in
- *  code by the object Var(\f$l\f$,\f$S_l\f$).
+ *  code by the object Var(\f$l\f$,\f$S_l\f$). The set of possible values of
+ *  variable \f$x_l\f$ is denoted \f$X_l := \{0,1,\dots,S_l-1\}\f$.
  */
 class Var {
     private:
index 9a25775..c8c3629 100644 (file)
@@ -44,7 +44,8 @@ namespace dai {
 
 
 /// Represents a set of variables.
-/** \note A VarSet is implemented using a SmallSet<Var> instead
+/** The variables in the set are sorted according to their labels.
+ *  \note A VarSet is implemented using a SmallSet<Var> instead
  *  of the more natural std::set<Var> because of efficiency reasons.
  */
 class VarSet : public SmallSet<Var> {
@@ -66,12 +67,13 @@ class VarSet : public SmallSet<Var> {
         /// Construct from SmallSet<Var>
         VarSet( const SmallSet<Var> &x ) : SmallSet<Var>(x) {}
 
-        /// Calculates the product of the number of states of all variables in this VarSet.
-        /** This is equal to the number of joint configurations of the variables.
-         *  If *this corresponds with the set \f$\{x_{l(0)},x_{l(1)},\dots,x_{l(n-1)}\}\f$,
-         *  where variable \f$x_l\f$ has label \f$l\f$, and denoting by \f$S_l\f$ the number of possible values
-         *  ("states") of variable \f$x_l\f$, the number of joint configurations
-         *  of the variables in this set is given by \f[N := \prod_{i=0}^{n-1} S_{l(i)}.\f]
+        /// Calculates the number of states of this VarSet.
+        /** The number of states of the Cartesian product of the variables in this VarSet
+         *  is simply the product of the number of states of each variable in this VarSet.
+         *  If *this corresponds with the set \f$\{x_l\}_{l\in L}\f$,
+         *  where variable \f$x_l\f$ has label \f$l\f$, and denoting by \f$S_l\f$ the 
+         *  number of possible values ("states") of variable \f$x_l\f$, the number of 
+         *  joint configurations of the variables in \f$\{x_l\}_{l\in L}\f$ is given by \f$\prod_{l\in L} S_l\f$.
          */
         size_t nrStates() {
             size_t states = 1;
@@ -95,9 +97,9 @@ class VarSet : public SmallSet<Var> {
         template <typename VarIterator>
         VarSet( VarIterator begin, VarIterator end, size_t sizeHint=0 ) : SmallSet<Var>(begin,end,sizeHint) {}
 
-        /// Calculates the linear index in the cartesian product of the variables in *this, which corresponds to a particular joint assignment of the variables specified by \a states.
+        /// Calculates the linear index in the Cartesian product of the variables in *this, which corresponds to a particular joint assignment of the variables specified by \a states.
         /** \param states Specifies the states of some variables.
-         *  \return The linear index in the cartesian product of the variables in *this
+         *  \return The linear index in the Cartesian product of the variables in *this
          *  corresponding with the joint assignment specified by \a states, where it is
          *  assumed that \a states[\a m]==0 for all \a m in *this which are not in \a states.
          *  
@@ -114,7 +116,11 @@ class VarSet : public SmallSet<Var> {
          *      &= & s(x_{l(0)}) + s(x_{l(1)}) S_{l(0)} + s(x_{l(2)}) S_{l(0)} S_{l(1)} + \dots + s(x_{l(n-1)}) S_{l(0)} \cdots S_{l(n-2)}.
          *  \f}
          *
-         *  \note This function is the inverse of calcStates( size_t ).
+         *  \note If *this corresponds with \f$\{x_l\}_{l\in L}\f$, and \a states specifies a state
+         *  for each variable \f$x_l\f$ for \f$l\in L\f$, calcState(const std::map<Var,size_t> &) induces a mapping 
+         *  \f$\sigma : \prod_{l\in L} X_l \to \{0,1,\dots,\prod_{l\in L} S_l-1\}\f$ that
+         *  maps a joint state to a linear index; this is the inverse of the mapping 
+         *  \f$\sigma^{-1}\f$ induced by calcStates(size_t).
          */
         size_t calcState( const std::map<Var, size_t> &states ) {
             size_t prod = 1;
@@ -141,7 +147,11 @@ class VarSet : public SmallSet<Var> {
          *    s(x_{l(i)}) = \left[\frac{S \mbox { mod } \prod_{j=0}^{i} S_{l(j)}}{\prod_{j=0}^{i-1} S_{l(j)}}\right] \qquad \mbox{for all $i=0,\dots,n-1$}.
          *  \f}
          *  where \f$S\f$ denotes the value of \a linearState.
-         *  \note This function is the inverse of calcState( const std::map<Var,size_t> &).
+         *
+         *  \note If *this corresponds with \f$\{x_l\}_{l\in L}\f$, calcStates(size_t) induces a mapping 
+         *  \f$\sigma^{-1} : \{0,1,\dots,\prod_{l\in L} S_l-1\} \to \prod_{l\in L} X_l \to \f$ that
+         *  maps a linear index to a joint state; this is the inverse of the mapping \f$\sigma\f$ 
+         *  induced by calcState(const std::map<Var,size_t> &).
          */
         std::map<Var, size_t> calcStates( size_t linearState ) {
             std::map<Var, size_t> states;