cbp.h

Go to the documentation of this file.

/*  This file is part of libDAI - http://www.libdai.org/
 *
 *  Copyright (c) 2006-2011, The libDAI authors. All rights reserved.
 *
 *  Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 */




#ifndef __defined_libdai_cbp_h
#define __defined_libdai_cbp_h


#include <dai/dai_config.h>
#ifdef DAI_WITH_CBP


#include <fstream>
#include <boost/shared_ptr.hpp>

#include <dai/daialg.h>
#include <dai/bbp.h>


namespace dai {



class CBP : public DAIAlgFG {
    private:
        std::vector<Factor> _beliefsV;
        std::vector<Factor> _beliefsF;
        Real _logZ;

        size_t _iters;
        Real _maxdiff;

        Real _sum_level;
        size_t _num_leaves;

        boost::shared_ptr<std::ofstream> _clamp_ofstream;


    public:
        CBP() : DAIAlgFG(), _beliefsV(), _beliefsF(), _logZ(0.0), _iters(0), _maxdiff(0.0), _sum_level(0.0), _num_leaves(0), _clamp_ofstream() {}


        CBP( const FactorGraph &fg, const PropertySet &opts ) : DAIAlgFG(fg) {
            props.set( opts );
            construct();
        }


        virtual CBP* clone() const { return new CBP(*this); }
        virtual CBP* construct( const FactorGraph &fg, const PropertySet &opts ) const { return new CBP( fg, opts ); }
        virtual std::string name() const { return "CBP"; }
        virtual Factor belief( const Var &v ) const { return beliefV( findVar( v ) ); }
        virtual Factor belief( const VarSet & ) const { DAI_THROW(NOT_IMPLEMENTED); }
        virtual Factor beliefV( size_t i ) const { return _beliefsV[i]; }
        virtual Factor beliefF( size_t I ) const { return _beliefsF[I]; }
        virtual std::vector<Factor> beliefs() const { return concat(_beliefsV, _beliefsF); }
        virtual Real logZ() const { return _logZ; }
        virtual void init() {};
        virtual void init( const VarSet & ) {};
        virtual Real run();
        virtual Real maxDiff() const { return _maxdiff; }
        virtual size_t Iterations() const { return _iters; }
        virtual void setMaxIter( size_t maxiter ) { props.maxiter = maxiter; }
        virtual void setProperties( const PropertySet &opts ) { props.set( opts ); }
        virtual PropertySet getProperties() const { return props.get(); }
        virtual std::string printProperties() const { return props.toString(); }

        //----------------------------------------------------------------

        /* PROPERTIES(props,CBP) {
            typedef BP::Properties::UpdateType UpdateType;
            DAI_ENUM(RecurseType,REC_FIXED,REC_LOGZ,REC_BDIFF);
            DAI_ENUM(ChooseMethodType,CHOOSE_RANDOM,CHOOSE_MAXENT,CHOOSE_BBP,CHOOSE_BP_L1,CHOOSE_BP_CFN);
            DAI_ENUM(ClampType,CLAMP_VAR,CLAMP_FACTOR);

            size_t verbose = 0;

            Real tol;
            UpdateType updates;
            size_t maxiter;

            Real rec_tol;
            size_t max_levels = 10;
            Real min_max_adj;
            ChooseMethodType choose;
            RecurseType recursion;
            ClampType clamp;
            PropertySet bbp_props;
            BBPCostFunction bbp_cfn;
            size_t rand_seed = 0;

            std::string clamp_outfile = "";
        }
        */
/* {{{ GENERATED CODE: DO NOT EDIT. Created by
    ./scripts/regenerate-properties include/dai/cbp.h src/cbp.cpp
*/
        struct Properties {
            typedef BP::Properties::UpdateType UpdateType;
            DAI_ENUM(RecurseType,REC_FIXED,REC_LOGZ,REC_BDIFF);
            DAI_ENUM(ChooseMethodType,CHOOSE_RANDOM,CHOOSE_MAXENT,CHOOSE_BBP,CHOOSE_BP_L1,CHOOSE_BP_CFN);
            DAI_ENUM(ClampType,CLAMP_VAR,CLAMP_FACTOR);
            size_t verbose;
            Real tol;
            UpdateType updates;
            size_t maxiter;
            Real rec_tol;
            size_t max_levels;
            Real min_max_adj;
            ChooseMethodType choose;
            RecurseType recursion;
            ClampType clamp;
            PropertySet bbp_props;
            BBPCostFunction bbp_cfn;
            size_t rand_seed;
            std::string clamp_outfile;


            void set(const PropertySet &opts);
            PropertySet get() const;
            std::string toString() const;
        } props;
/* }}} END OF GENERATED CODE */

    private:
        void printDebugInfo();


        void runRecurse( InfAlg *bp, Real orig_logZ, std::vector<size_t> clamped_vars_list, size_t &num_leaves,
                         size_t &choose_count, Real &sum_level, Real &lz_out, std::vector<Factor> &beliefs_out );


        virtual bool chooseNextClampVar( InfAlg* bp, std::vector<size_t> &clamped_vars_list, size_t &i, std::vector<size_t> &xis, Real *maxVarOut );


        InfAlg* getInfAlg();


        void setBeliefs( const std::vector<Factor> &bs, Real logZ );

        void construct();
};



std::pair<size_t, size_t> BBPFindClampVar( const InfAlg &in_bp, bool clampingVar, const PropertySet &bbp_props, const BBPCostFunction &cfn, Real *maxVarOut );


} // end of namespace dai


#endif


#endif