jointTargetedInference.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_BAYES_NET_JOINT_TARGETED_INFERENCE_H
#define GUM_BAYES_NET_JOINT_TARGETED_INFERENCE_H
 
 
#include <agrum/agrum.h>
 
#include <agrum/BN/inference/tools/marginalTargetedInference.h>
 
#include <string_view>
 
namespace gum {
 

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


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

    ~JointTargetedInference() override;

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


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


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


    const Tensor< GUM_SCALAR >& posterior(std::string_view nodeName) final;
 
 
    // ############################################################################
    // ############################################################################


    void eraseAllTargets() override;

    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;

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

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

    GUM_SCALAR I(NodeId X, NodeId Y);
    GUM_SCALAR I(std::string_view Xname, std::string_view Yname);

    GUM_SCALAR VI(NodeId X, NodeId Y);

    GUM_SCALAR VI(std::string_view Xname, std::string_view Yname);

    GUM_SCALAR jointMutualInformation(const NodeSet& targets);

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

 
 
    protected:
    void onModelChanged_(const GraphicalModel* bn) override;


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


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

    virtual void onAllTargetsErased_() = 0;

    virtual void onAllJointTargetsErased_() = 0;
 


    virtual const Tensor< GUM_SCALAR >& jointPosterior_(const NodeSet& set) = 0;

    virtual const Tensor< GUM_SCALAR >& jointPosterior_(const NodeSet& wanted_target,
                                                        const NodeSet& declared_target) = 0;

    virtual Tensor< GUM_SCALAR >* unnormalizedJointPosterior_(const NodeSet& set) = 0;

    virtual Tensor< 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