marginalTargetedInference.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_BAYES_NET_MARGINAL_TARGETED_INFERENCE_H
#define GUM_BAYES_NET_MARGINAL_TARGETED_INFERENCE_H

#include <string>

#include <agrum/BN/inference/tools/BayesNetInference.h>
#include <agrum/agrum.h>


namespace gum {


  template < typename GUM_SCALAR >
  class MarginalTargetedInference
      : public virtual BayesNetInference< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################


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

    virtual ~MarginalTargetedInference();



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


    virtual const Potential< GUM_SCALAR >& posterior(NodeId node);


    virtual const Potential< GUM_SCALAR >& posterior(const std::string& nodeName);



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

    virtual void eraseAllTargets();

    virtual void addAllTargets() final;


    virtual void addTarget(NodeId target) final;


    virtual void addTarget(const std::string& nodeName) final;


    virtual void eraseTarget(NodeId target) final;


    virtual void eraseTarget(const std::string& nodeName) final;

    virtual bool isTarget(NodeId node) const final;

    virtual bool isTarget(const std::string& nodeName) const final;

    virtual const Size nbrTargets() const noexcept final;

    virtual const NodeSet& targets() const noexcept final;


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

    virtual GUM_SCALAR H(NodeId X) final;

    virtual GUM_SCALAR H(const std::string& nodeName) final;



    Potential< GUM_SCALAR > evidenceImpact(NodeId target, const NodeSet& evs);

    Potential< GUM_SCALAR > evidenceImpact(const std::string& target,
                                           const std::vector< std::string >& evs);

    protected:

    virtual void _onMarginalTargetAdded(const NodeId id) = 0;


    virtual void _onMarginalTargetErased(const NodeId id) = 0;

    virtual void _onAllMarginalTargetsAdded() = 0;

    virtual void _onAllMarginalTargetsErased() = 0;

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


    virtual const Potential< GUM_SCALAR >& _posterior(NodeId id) = 0;

    protected:
    void _setTargetedMode();
    bool _isTargetedMode() const;

    private:
    bool __targeted_mode;

    NodeSet __targets;


    /*/// remove all the marginal posteriors computed
    void __invalidatePosteriors() noexcept;*/

    void __setAllMarginalTargets();
  };


}   // namespace gum


#include <agrum/BN/inference/tools/marginalTargetedInference_tpl.h>


#endif   // GUM_BAYES_NET_MARGINAL_TARGETED_INFERENCE_H