lc.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_lc_h
#define __defined_libdai_lc_h


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


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


namespace dai {


class LC : public DAIAlgFG {
    private:
        std::vector<Factor> _pancakes;
        std::vector<Factor> _cavitydists;
        std::vector<std::vector<Factor> > _phis;
        std::vector<Factor> _beliefs;
        Real _maxdiff;
        size_t _iters;

    public:
        struct Properties {

            DAI_ENUM(CavityType,FULL,PAIR,PAIR2,UNIFORM);


            DAI_ENUM(UpdateType,SEQFIX,SEQRND);

            size_t verbose;

            size_t maxiter;

            Real tol;

            bool reinit;

            Real damping;

            CavityType cavity;

            UpdateType updates;

            std::string cavainame;

            PropertySet cavaiopts;
        } props;

    public:
        LC() : DAIAlgFG(), _pancakes(), _cavitydists(), _phis(), _beliefs(), _maxdiff(), _iters(), props() {}


        LC( const FactorGraph &fg, const PropertySet &opts );



        virtual LC* clone() const { return new LC(*this); }
        virtual LC* construct( const FactorGraph &fg, const PropertySet &opts ) const { return new LC( fg, opts ); }
        virtual std::string name() const { return "LC"; }
        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 { return _beliefs[i]; }
        virtual std::vector<Factor> beliefs() const { return _beliefs; }
        virtual Real logZ() const { DAI_THROW(NOT_IMPLEMENTED); return 0.0; }
        virtual void init();
        virtual void init( const VarSet &/*ns*/ ) { init(); }
        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;


        Real CalcCavityDist( size_t i, const std::string &name, const PropertySet &opts );
        Real InitCavityDists( const std::string &name, const PropertySet &opts );
        long SetCavityDists( std::vector<Factor> &Q );
        Factor NewPancake (size_t i, size_t _I, bool & hasNaNs);
        void CalcBelief (size_t i);
        const Factor &pancake (size_t i) const { return _pancakes[i]; };
        const Factor &cavitydist (size_t i) const { return _cavitydists[i]; };
};


} // end of namespace dai


#endif


#endif