samplingInference.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_SAMPLING_INFERENCE_H
#define GUM_SAMPLING_INFERENCE_H

#include <agrum/BN/BayesNetFragment.h>
#include <agrum/BN/IBayesNet.h>
#include <agrum/BN/inference/tools/estimator.h>
#include <agrum/BN/inference/tools/gibbsOperator.h>
#include <agrum/BN/inference/tools/marginalTargetedInference.h>
#include <agrum/core/approximations/approximationScheme.h>
#include <agrum/multidim/instantiation.h>

namespace gum {
  template < typename GUM_SCALAR >
  class SamplingInference : public ApproximateInference< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################


    explicit SamplingInference(const IBayesNet< GUM_SCALAR >* bn);

    ~SamplingInference() override;


    const Potential< GUM_SCALAR >& currentPosterior(NodeId id);


    const Potential< GUM_SCALAR >& currentPosterior(const std::string& name);


    // ############################################################################
    // ############################################################################
    const IBayesNet< GUM_SCALAR >& samplingBN();


    const Potential< GUM_SCALAR >& _posterior(NodeId id) override;




    virtual void contextualize();

    // ############################################################################
    // ############################################################################



    virtual void _setEstimatorFromBN();


    virtual void _setEstimatorFromLBP(LoopyBeliefPropagation< GUM_SCALAR >* lbp,
                                      GUM_SCALAR virtualLBPSize);

    protected:
    Estimator< GUM_SCALAR > __estimator;

    bool isSetEstimator = false;

    bool isContextualized = false;

    virtual Instantiation _burnIn() = 0;


    virtual Instantiation _draw(GUM_SCALAR* w, Instantiation prev) = 0;

    void _makeInference() override;
    void _loopApproxInference();


    virtual void _addVarSample(NodeId nod, Instantiation* I);



    virtual void _onContextualize(BayesNetFragment< GUM_SCALAR >* bn);

    void _onEvidenceAdded(const NodeId id, bool isHardEvidence) override;

    void _onEvidenceErased(const NodeId id, bool isHardEvidence) override;

    void _onAllEvidenceErased(bool contains_hard_evidence) override;

    void _onEvidenceChanged(const NodeId id, bool hasChangedSoftHard) override;

    void _onBayesNetChanged(const IBayesNet< GUM_SCALAR >* bn) override;

    void _updateOutdatedBNStructure() override;

    void _updateOutdatedBNPotentials() override;

    void _onMarginalTargetAdded(const NodeId id) override;

    void _onMarginalTargetErased(const NodeId id) override;

    void _onAllMarginalTargetsAdded() override;

    void _onAllMarginalTargetsErased() override;

    void _onStateChanged() override;

    private:
    BayesNetFragment< GUM_SCALAR >* __samplingBN;
  };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class SamplingInference< double >;
#endif

}   // namespace gum

#include <agrum/BN/inference/tools/samplingInference_tpl.h>
#endif