BayesNetInference.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_INFERENCE_H
#define GUM_BAYES_NET_INFERENCE_H


#include <agrum/BN/IBayesNet.h>
#include <agrum/agrum.h>


namespace gum {


  enum class FindBarrenNodesType {
    FIND_NO_BARREN_NODES,   // do not try to find barren nodes
    FIND_BARREN_NODES       // use a bottom-up algorithm to detect barren nodes
  };


  // JointTargetedInference, the class for computing joint posteriors, should
  // have access to the states of Inference and change them when needed: this
  // will be a friend of Inference
  template < typename GUM_SCALAR >
  class JointTargetedInference;

  // MarginalTargetedInference, the class for computing marginal posteriors,
  // should have access to the states of Inference and change them when needed:
  // this should be a friend of Inference
  template < typename GUM_SCALAR >
  class MarginalTargetedInference;

  // EvidenceInference, the class for computing the probability of evidence,
  // should have access to the states of Inference and change them when needed:
  // this will be a friend of Inference
  template < typename GUM_SCALAR >
  class EvidenceInference;


  template < typename GUM_SCALAR >
  class BayesNetInference {
    public:
    enum class StateOfInference {
      OutdatedBNStructure,
      OutdatedBNPotentials,
      ReadyForInference,
      Done
    };


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


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


    BayesNetInference();

    virtual ~BayesNetInference();



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


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


    virtual const IBayesNet< GUM_SCALAR >& BN() const final;

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

    virtual bool isInferenceReady() const noexcept final;
    virtual bool isInferenceOutdatedBNStructure() const noexcept final;
    virtual bool isInferenceOutdatedBNPotentials() const noexcept final;
    virtual bool isInferenceDone() const noexcept final;


    virtual bool isDone() 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 Potential< GUM_SCALAR >& pot) final;


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


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


    virtual void addListOfEvidence(
       const List< const Potential< 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 Potential< 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 Potential< 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 _onBayesNetChanged(const IBayesNet< GUM_SCALAR >* bn) = 0;


    virtual void _updateOutdatedBNStructure() = 0;


    virtual void _updateOutdatedBNPotentials() = 0;


    virtual void _makeInference() = 0;


    void _setOutdatedBNStructureState();

    void _setOutdatedBNPotentialsState();


    private:
    StateOfInference __state{StateOfInference::OutdatedBNStructure};

    const IBayesNet< GUM_SCALAR >* __bn{nullptr};

    NodeProperty< Size > __domain_sizes;

    NodeProperty< const Potential< GUM_SCALAR >* > __evidence;

    NodeProperty< Idx > __hard_evidence;

    NodeSet __soft_evidence_nodes;

    NodeSet __hard_evidence_nodes;

    virtual void __setState(const StateOfInference state) final;

    Potential< GUM_SCALAR > __createHardEvidence(NodeId id, Idx val) const;

    bool __isHardEvidence(const Potential< GUM_SCALAR >& pot, Idx& val) const;

    void __computeDomainSizes();

    void __setBayesNetDuringConstruction(const IBayesNet< GUM_SCALAR >* bn);


    friend MarginalTargetedInference< GUM_SCALAR >;
    friend JointTargetedInference< GUM_SCALAR >;
    friend EvidenceInference< GUM_SCALAR >;
  };


}   // namespace gum


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


#endif   // GUM_BAYES_NET_INFERENCE_H