mf.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_mf_h
#define __defined_libdai_mf_h


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


#include <string>
#include <dai/enum.h>
#include <dai/daialg.h>
#include <dai/factorgraph.h>
#include <dai/properties.h>


namespace dai {



class MF : public DAIAlgFG {
    private:
        std::vector<Factor>  _beliefs;
        Real _maxdiff;
        size_t _iters;

    public:
        struct Properties {
            DAI_ENUM(InitType,UNIFORM,RANDOM);

            DAI_ENUM(UpdateType,NAIVE,HARDSPIN);

            size_t verbose;

            size_t maxiter;

            Real tol;

            Real damping;
            
            InitType init;

            UpdateType updates;
        } props;

    public:

        MF() : DAIAlgFG(), _beliefs(), _maxdiff(0.0), _iters(0U), props() {}


        MF( const FactorGraph &fg, const PropertySet &opts ) : DAIAlgFG(fg), _beliefs(), _maxdiff(0.0), _iters(0U), props() {
            setProperties( opts );
            construct();
        }


        virtual MF* clone() const { return new MF(*this); }
        virtual MF* construct( const FactorGraph &fg, const PropertySet &opts ) const { return new MF( fg, opts ); }
        virtual std::string name() const { return "MF"; }
        virtual Factor belief( const Var &v ) const { return beliefV( findVar( v ) ); }
        virtual Factor belief( const VarSet &vs ) const;
        virtual Factor beliefV( size_t i ) const;
        virtual std::vector<Factor> beliefs() const;
        virtual Real logZ() const;
        virtual void init();
        virtual void init( const VarSet &ns );
        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 );
        virtual PropertySet getProperties() const;
        virtual std::string printProperties() const;

    private:
        void construct();

        Factor calcNewBelief( size_t i );
};


} // end of namespace dai


#endif


#endif