New git HEAD version
[libdai.git] / src / gibbs.cpp
index 65e8603..85b2379 100644 (file)
@@ -1,14 +1,15 @@
 /*  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) 2006-2011, The libDAI authors. All rights reserved.
  *
- *  Copyright (C) 2008  Frederik Eaton  [frederik at ofb dot net]
- *  Copyright (C) 2008-2010  Joris Mooij  [joris dot mooij at libdai dot org]
+ *  Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
  */
 
 
+#include <dai/dai_config.h>
+#ifdef DAI_WITH_GIBBS
+
+
 #include <iostream>
 #include <sstream>
 #include <map>
@@ -25,18 +26,22 @@ namespace dai {
 using namespace std;
 
 
-const char *Gibbs::Name = "GIBBS";
-
-
 void Gibbs::setProperties( const PropertySet &opts ) {
-    DAI_ASSERT( opts.hasKey("iters") );
-    props.iters = opts.getStringAs<size_t>("iters");
+    DAI_ASSERT( opts.hasKey("maxiter") );
+    props.maxiter = opts.getStringAs<size_t>("maxiter");
 
+    if( opts.hasKey("restart") )
+        props.restart = opts.getStringAs<size_t>("restart");
+    else
+        props.restart = props.maxiter;
     if( opts.hasKey("burnin") )
         props.burnin = opts.getStringAs<size_t>("burnin");
     else
         props.burnin = 0;
-
+    if( opts.hasKey("maxtime") )
+        props.maxtime = opts.getStringAs<Real>("maxtime");
+    else
+        props.maxtime = INFINITY;
     if( opts.hasKey("verbose") )
         props.verbose = opts.getStringAs<size_t>("verbose");
     else
@@ -46,9 +51,11 @@ void Gibbs::setProperties( const PropertySet &opts ) {
 
 PropertySet Gibbs::getProperties() const {
     PropertySet opts;
-    opts.Set( "iters", props.iters );
-    opts.Set( "burnin", props.burnin );
-    opts.Set( "verbose", props.verbose );
+    opts.set( "maxiter", props.maxiter );
+    opts.set( "maxtime", props.maxtime );
+    opts.set( "restart", props.restart );
+    opts.set( "burnin", props.burnin );
+    opts.set( "verbose", props.verbose );
     return opts;
 }
 
@@ -56,7 +63,9 @@ PropertySet Gibbs::getProperties() const {
 string Gibbs::printProperties() const {
     stringstream s( stringstream::out );
     s << "[";
-    s << "iters=" << props.iters << ",";
+    s << "maxiter=" << props.maxiter << ",";
+    s << "maxtime=" << props.maxtime << ",";
+    s << "restart=" << props.restart << ",";
     s << "burnin=" << props.burnin << ",";
     s << "verbose=" << props.verbose << "]";
     return s.str();
@@ -64,6 +73,8 @@ string Gibbs::printProperties() const {
 
 
 void Gibbs::construct() {
+    _sample_count = 0;
+
     _var_counts.clear();
     _var_counts.reserve( nrVars() );
     for( size_t i = 0; i < nrVars(); i++ )
@@ -72,27 +83,35 @@ void Gibbs::construct() {
     _factor_counts.clear();
     _factor_counts.reserve( nrFactors() );
     for( size_t I = 0; I < nrFactors(); I++ )
-        _factor_counts.push_back( _count_t( factor(I).states(), 0 ) );
+        _factor_counts.push_back( _count_t( factor(I).nrStates(), 0 ) );
 
-    _sample_count = 0;
+    _iters = 0;
 
     _state.clear();
     _state.resize( nrVars(), 0 );
+
+    _max_state.clear();
+    _max_state.resize( nrVars(), 0 );
+
+    _max_score = logScore( _max_state );
 }
 
 
 void Gibbs::updateCounts() {
     _sample_count++;
-    if( _sample_count > props.burnin ) {
-        for( size_t i = 0; i < nrVars(); i++ )
-            _var_counts[i][_state[i]]++;
-        for( size_t I = 0; I < nrFactors(); I++ )
-            _factor_counts[I][getFactorEntry(I)]++;
+    for( size_t i = 0; i < nrVars(); i++ )
+        _var_counts[i][_state[i]]++;
+    for( size_t I = 0; I < nrFactors(); I++ )
+        _factor_counts[I][getFactorEntry(I)]++;
+    Real score = logScore( _state );
+    if( score > _max_score ) {
+        _max_state = _state;
+        _max_score = score;
     }
 }
 
 
-inline size_t Gibbs::getFactorEntry( size_t I ) {
+size_t Gibbs::getFactorEntry( size_t I ) {
     size_t f_entry = 0;
     for( int _j = nbF(I).size() - 1; _j >= 0; _j-- ) {
         // note that iterating over nbF(I) yields the same ordering
@@ -105,7 +124,7 @@ inline size_t Gibbs::getFactorEntry( size_t I ) {
 }
 
 
-inline size_t Gibbs::getFactorEntryDiff( size_t I, size_t i ) {
+size_t Gibbs::getFactorEntryDiff( size_t I, size_t i ) {
     size_t skip = 1;
     for( size_t _j = 0; _j < nbF(I).size(); _j++ ) {
         // note that iterating over nbF(I) yields the same ordering
@@ -126,12 +145,12 @@ Prob Gibbs::getVarDist( size_t i ) {
     Prob i_given_MB( i_states, 1.0 );
 
     // use Markov blanket of var(i) to calculate distribution
-    foreach( const Neighbor &I, nbV(i) ) {
+    bforeach( const Neighbor &I, nbV(i) ) {
         const Factor &f_I = factor(I);
         size_t I_skip = getFactorEntryDiff( I, i );
         size_t I_entry = getFactorEntry(I) - (_state[i] * I_skip);
         for( size_t st_i = 0; st_i < i_states; st_i++ ) {
-            i_given_MB[st_i] *= f_I[I_entry];
+            i_given_MB.set( st_i, i_given_MB[st_i] * f_I[I_entry] );
             I_entry += I_skip;
         }
     }
@@ -146,7 +165,7 @@ Prob Gibbs::getVarDist( size_t i ) {
 }
 
 
-inline void Gibbs::resampleVar( size_t i ) {
+void Gibbs::resampleVar( size_t i ) {
     _state[i] = getVarDist(i).draw();
 }
 
@@ -158,11 +177,12 @@ void Gibbs::randomizeState() {
 
 
 void Gibbs::init() {
+    _sample_count = 0;
     for( size_t i = 0; i < nrVars(); i++ )
         fill( _var_counts[i].begin(), _var_counts[i].end(), 0 );
     for( size_t I = 0; I < nrFactors(); I++ )
         fill( _factor_counts[I].begin(), _factor_counts[I].end(), 0 );
-    _sample_count = 0;
+    _iters = 0;
 }
 
 
@@ -174,35 +194,45 @@ Real Gibbs::run() {
 
     double tic = toc();
 
-    randomizeState();
-
-    for( size_t iter = 0; iter < props.iters; iter++ ) {
-        for( size_t j = 0; j < nrVars(); j++ )
-            resampleVar( j );
-        updateCounts();
+    for( ; _iters < props.maxiter && (toc() - tic) < props.maxtime; _iters++ ) {
+        if( (_iters % props.restart) == 0 )
+            randomizeState();
+        for( size_t i = 0; i < nrVars(); i++ )
+            resampleVar( i );
+        if( (_iters % props.restart) > props.burnin )
+            updateCounts();
     }
 
     if( props.verbose >= 3 ) {
         for( size_t i = 0; i < nrVars(); i++ ) {
-            cerr << "belief for variable " << var(i) << ": " << beliefV(i) << endl;
-            cerr << "counts for variable " << var(i) << ": " << Prob( _var_counts[i] ) << endl;
+            cerr << "Belief for variable " << var(i) << ": " << beliefV(i) << endl;
+            cerr << "Counts for variable " << var(i) << ": " << Prob( _var_counts[i] ) << endl;
         }
     }
 
     if( props.verbose >= 3 )
-        cerr << Name << "::run:  ran " << props.iters << " passes (" << toc() - tic << " clocks)." << endl;
+        cerr << name() << "::run:  ran " << _iters << " passes (" << toc() - tic << " seconds)." << endl;
 
-    return 0.0;
+    if( _iters == 0 )
+        return INFINITY;
+    else
+        return std::pow( _iters, -0.5 );
 }
 
 
 Factor Gibbs::beliefV( size_t i ) const {
-    return Factor( var(i), _var_counts[i] ).normalized();
+    if( _sample_count == 0 )
+        return Factor( var(i) );
+    else
+        return Factor( var(i), _var_counts[i] ).normalized();
 }
 
 
 Factor Gibbs::beliefF( size_t I ) const {
-    return Factor( factor(I).vars(), _factor_counts[I] ).normalized();
+    if( _sample_count == 0 )
+        return Factor( factor(I).vars() );
+    else
+        return Factor( factor(I).vars(), _factor_counts[I] ).normalized();
 }
 
 
@@ -233,11 +263,11 @@ Factor Gibbs::belief( const VarSet &ns ) const {
 }
 
 
-std::vector<size_t> getGibbsState( const FactorGraph &fg, size_t iters ) {
+std::vector<size_t> getGibbsState( const FactorGraph &fg, size_t maxiter ) {
     PropertySet gibbsProps;
-    gibbsProps.Set("iters", iters);
-    gibbsProps.Set("burnin", size_t(0));
-    gibbsProps.Set("verbose", size_t(0));
+    gibbsProps.set( "maxiter", maxiter );
+    gibbsProps.set( "burnin", size_t(0) );
+    gibbsProps.set( "verbose", size_t(0) );
     Gibbs gibbs( fg, gibbsProps );
     gibbs.run();
     return gibbs.state();
@@ -245,3 +275,6 @@ std::vector<size_t> getGibbsState( const FactorGraph &fg, size_t iters ) {
 
 
 } // end of namespace dai
+
+
+#endif