samplingInference.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_SAMPLING_INFERENCE_H
#define GUM_SAMPLING_INFERENCE_H
 
#include <agrum/BN/BayesNetFragment.h>
#include <agrum/BN/inference/tools/estimator.h>
#include <agrum/BN/inference/tools/gibbsOperator.h>
 
namespace gum {
 
  template < typename GUM_SCALAR >
  class SamplingInference: public ApproximateInference< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################


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

    ~SamplingInference() override;


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


    const Tensor< GUM_SCALAR >& currentPosterior(const std::string& name);
 
 
    // ############################################################################
    // ############################################################################
    const IBayesNet< GUM_SCALAR >& samplingBN();


    const Tensor< 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 onModelChanged_(const GraphicalModel* bn) override;
 
    void updateOutdatedStructure_() override;
 
    void updateOutdatedTensors_() 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