graphicalModelInference.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 AGRUM_GRAPHICALMODELINFERENCE_H
#define AGRUM_GRAPHICALMODELINFERENCE_H
 
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/graphicalModel.h>
#include <agrum/base/multidim/tensor.h>
 
namespace gum {

 
  template < typename GUM_SCALAR >
  class GraphicalModelInference {
    public:
    enum class StateOfInference { OutdatedStructure, OutdatedTensors, ReadyForInference, Done };
 
 
    // ############################################################################
    // ############################################################################


    explicit GraphicalModelInference(const GraphicalModel* model);


    GraphicalModelInference();

    virtual ~GraphicalModelInference();

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


    virtual const GraphicalModel& model() const final;

    virtual const NodeProperty< Size >& domainSizes() const final;

    virtual bool isInferenceReady() const noexcept final;
    virtual bool isInferenceOutdatedStructure() const noexcept final;
    virtual bool isInferenceOutdatedTensors() const noexcept final;

    virtual bool isInferenceDone() const noexcept final;
 

    virtual void prepareInference() final;


    virtual void makeInference() final;

    virtual void clear();

    virtual StateOfInference state() const noexcept final;
 
 
    // ############################################################################
    // ############################################################################


    virtual void addEvidence(NodeId id, const Idx val) final;


    virtual void addEvidence(const std::string& nodeName, const Idx val) final;


    virtual void addEvidence(NodeId id, const std::string& label) final;


    virtual void addEvidence(const std::string& nodeName, const std::string& label) final;


    virtual void addEvidence(NodeId id, const std::vector< GUM_SCALAR >& vals) final;


    virtual void addEvidence(const std::string&               nodeName,
                             const std::vector< GUM_SCALAR >& vals) final;


    virtual void addEvidence(const Tensor< GUM_SCALAR >& pot) final;


    virtual void addEvidence(Tensor< GUM_SCALAR >&& pot) final;


    virtual void addSetOfEvidence(const Set< const Tensor< GUM_SCALAR >* >& potset) final;


    virtual void addListOfEvidence(const List< const Tensor< GUM_SCALAR >* >& potlist) final;


    virtual void chgEvidence(NodeId id, const Idx val) final;


    virtual void chgEvidence(const std::string& nodeName, const Idx val) final;


    virtual void chgEvidence(NodeId id, const std::string& label) final;


    virtual void chgEvidence(const std::string& nodeName, const std::string& label) final;


    virtual void chgEvidence(NodeId id, const std::vector< GUM_SCALAR >& vals) final;


    virtual void chgEvidence(const std::string&               nodeName,
                             const std::vector< GUM_SCALAR >& vals) final;


    virtual void chgEvidence(const Tensor< GUM_SCALAR >& pot) final;

    virtual void eraseAllEvidence() final;

    virtual void eraseEvidence(NodeId id) final;

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

    virtual bool hasEvidence() const final;

    virtual bool hasEvidence(NodeId id) const final;

    virtual bool hasHardEvidence(NodeId id) const final;

    virtual bool hasSoftEvidence(NodeId id) const final;
 
    virtual bool hasEvidence(const std::string& nodeName) const final;

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

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

    virtual Size nbrEvidence() const final;

    virtual Size nbrHardEvidence() const final;

    virtual Size nbrSoftEvidence() const final;

    const NodeProperty< const Tensor< GUM_SCALAR >* >& evidence() const;

    const NodeSet& softEvidenceNodes() const;

    const NodeSet& hardEvidenceNodes() const;

    const NodeProperty< Idx >& hardEvidence() const;

 
 
    protected:
    virtual void onStateChanged_() = 0;

    virtual void onEvidenceAdded_(const NodeId id, bool isHardEvidence) = 0;

    virtual void onEvidenceErased_(const NodeId id, bool isHardEvidence) = 0;

    virtual void onAllEvidenceErased_(bool contains_hard_evidence) = 0;

    virtual void onEvidenceChanged_(const NodeId id, bool hasChangedSoftHard) = 0;

    virtual void onModelChanged_(const GraphicalModel* model) = 0;


    virtual void updateOutdatedStructure_() = 0;


    virtual void updateOutdatedTensors_() = 0;


    virtual void makeInference_() = 0;


    void setOutdatedStructureState_();

    void setOutdatedTensorsState_();
 
 
    private:
    StateOfInference _state_{StateOfInference::OutdatedStructure};

    const GraphicalModel* _model_{nullptr};

    NodeProperty< Size > _domain_sizes_;

    NodeProperty< const Tensor< GUM_SCALAR >* > _evidence_;

    NodeProperty< Idx > _hard_evidence_;

    NodeSet _soft_evidence_nodes_;

    NodeSet _hard_evidence_nodes_;
 

    Tensor< GUM_SCALAR > _createHardEvidence_(NodeId id, Idx val) const;

    bool _isHardEvidence_(const Tensor< GUM_SCALAR >& pot, Idx& val) const;

    void _computeDomainSizes_();
 
    protected:
    virtual void setState_(const StateOfInference state) final;
 
    void setModel_(const GraphicalModel* model);

    void setModelDuringConstruction_(const GraphicalModel* model);
 
    bool hasNoModel_() const { return _model_ == nullptr; };
  };
}   // namespace gum
 
#include <agrum/base/graphicalModels/inference/graphicalModelInference_tpl.h>
 
 
#endif   // AGRUM_GRAPHICALMODELINFERENCE_H