jointTargetedInference.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_JOINT_TARGETED_INFERENCE_H
#define GUM_BAYES_NET_JOINT_TARGETED_INFERENCE_H


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


namespace gum {


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


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

    virtual ~JointTargetedInference();



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


    virtual const Potential< GUM_SCALAR >&
       jointPosterior(const NodeSet& nodes) final;


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


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


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


    virtual void eraseAllTargets();

    virtual void eraseAllJointTargets() final;

    virtual void eraseAllMarginalTargets() final;


    virtual void addJointTarget(const NodeSet& joint_target) final;


    virtual void eraseJointTarget(const NodeSet& joint_target) final;

    virtual bool isJointTarget(const NodeSet& vars) const final;

    virtual const Set< NodeSet >& jointTargets() const noexcept final;

    virtual Size nbrJointTargets() const noexcept final;

    Potential< GUM_SCALAR > evidenceJointImpact(const NodeSet& targets,
                                                const NodeSet& evs);

    Potential< GUM_SCALAR >
       evidenceJointImpact(const std::vector< std::string >& targets,
                           const std::vector< std::string >& evs);

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

    GUM_SCALAR I(NodeId X, NodeId Y);

    GUM_SCALAR VI(NodeId X, NodeId Y);

    GUM_SCALAR jointMutualInformation(const NodeSet& targets);

    GUM_SCALAR jointMutualInformation(const std::vector< std::string >& targets);



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


    virtual void _onJointTargetAdded(const NodeSet& set) = 0;


    virtual void _onJointTargetErased(const NodeSet& set) = 0;

    virtual void _onAllTargetsErased() = 0;

    virtual void _onAllJointTargetsErased() = 0;



    virtual const Potential< GUM_SCALAR >& _jointPosterior(const NodeSet& set) = 0;

    virtual const Potential< GUM_SCALAR >&
       _jointPosterior(const NodeSet& wanted_target,
                       const NodeSet& declared_target) = 0;

    virtual Potential< GUM_SCALAR >*
       _unnormalizedJointPosterior(const NodeSet& set) = 0;

    virtual Potential< GUM_SCALAR >* _unnormalizedJointPosterior(NodeId id) = 0;


    private:
    Set< NodeSet > __joint_targets;
  };


}   // namespace gum


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


#endif   // GUM_BAYES_NET_JOINT_TARGETED_INFERENCE_H