influenceDiagramInference.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_INFLUENCE_DIAGRAM_INFERENCE_H
#define GUM_INFLUENCE_DIAGRAM_INFERENCE_H

#include <iostream>
#include <string>
#include <utility>
#include <vector>

#include <agrum/agrum.h>

#include <agrum/core/list.h>

#include <agrum/graphs/algorithms/triangulations/partialOrderedTriangulation.h>

#include <agrum/multidim/implementations/multiDimBucket.h>
#include <agrum/multidim/implementations/multiDimSparse.h>

#include <agrum/ID/inference/IInfluenceDiagramInference.h>

namespace gum {

  template < typename GUM_SCALAR >
  class CliqueProperties;

  template < typename GUM_SCALAR >
  class InfluenceDiagramInference
      : public IInfluenceDiagramInference< GUM_SCALAR > {
    public:
    // ====================================================================
    // ====================================================================

    explicit InfluenceDiagramInference(
       const InfluenceDiagram< GUM_SCALAR >& infDiag);

    virtual ~InfluenceDiagramInference();

    // ====================================================================
    // ====================================================================

    virtual void makeInference();

    GUM_SCALAR getMEU();

    Idx getBestDecisionChoice(NodeId decisionId);

    std::string displayResult();

    // ====================================================================
    // ====================================================================

    virtual void
       insertEvidence(const List< const Potential< GUM_SCALAR >* >& evidenceList);

    virtual void eraseEvidence(const Potential< GUM_SCALAR >* evidence);

    virtual void eraseAllEvidence();

    // ====================================================================
    // ====================================================================

    Triangulation& getTriangulation();

    void displayStrongJunctionTree(std::ostream& stream = std::cout);

    private:
    // ====================================================================
    // ====================================================================

    Triangulation* __triangulation;

    Set< Potential< GUM_SCALAR >* > __potentialDummies;

    Set< Potential< GUM_SCALAR >* > __utilityDummies;

    Potential< GUM_SCALAR >* __inferencePotential;

    Potential< GUM_SCALAR >* __inferenceUtility;

    // ====================================================================
    // ====================================================================

    NodeProperty< NodeId > __nodeToCliqueMap;

    NodeProperty< CliqueProperties< GUM_SCALAR >* > __cliquePropertiesMap;

    HashTable< Size, NodeId > __cliqueEliminationMap;

    HashTable< NodeId, Idx > __utakenDecisionMap;

    bool __inferenceMade;

    // ====================================================================
    // ====================================================================

    const NodeSet& __getSeparator(NodeId clique_1, NodeId clique_2);

    NodeId __getClique(const std::vector< NodeId >& eliminationOrder, NodeId id);

    // ====================================================================
    // ====================================================================

    void __makeCliquePropertiesMap();

    void __makeStrongJunctionTree();

    void __cleanUp();

    void __collectChild(NodeId parent, NodeId child);

    void __absorbClique(NodeId absorbedCliqueId, NodeId absorbingCliqueId);

    void __reduceClique(CliqueProperties< GUM_SCALAR >* absorbedClique,
                        NodeSet&                        separator,
                        Potential< GUM_SCALAR >*&       potentialMarginal,
                        Potential< GUM_SCALAR >*&       utilityMarginal);

    Potential< GUM_SCALAR >* __makeDummyPotential(NodeId cliqueId);

    Potential< GUM_SCALAR >* __makeDummyUtility(NodeId cliqueId);

    bool __IsEliminatedAfter(NodeId observedNode, NodeId currentNode);

  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  template < typename GUM_SCALAR >
  class CliqueProperties {
    public:
    CliqueProperties();

    ~CliqueProperties();

    void addVariable(const DiscreteVariable& v);

    void makeEliminationOrder(const std::vector< NodeId >&          elim,
                              const InfluenceDiagram< GUM_SCALAR >& infDiag);

    void addPotential(const Potential< GUM_SCALAR >& cpt, bool removable = false);

    void addUtility(const Potential< GUM_SCALAR >& ut, bool removable = false);

    void cleanFromInference();

    void addEvidence(const Potential< GUM_SCALAR >& evidence);

    void removeEvidence(const DiscreteVariable& v);

    void removeAllEvidence();

    const HashTable< const DiscreteVariable*, const Potential< GUM_SCALAR >* >&
       evidences() const;

    const HashTable< const Potential< GUM_SCALAR >*, Instantiation* >&
       potentialBucket();

    const HashTable< const Potential< GUM_SCALAR >*, Instantiation* >&
       utilityBucket();

    const Sequence< NodeId >& cliqueEliminationOrder();

    const Sequence< const DiscreteVariable* >& cliqueVariables();

    Instantiation& cliqueInstantiation();

    private:
    HashTable< const DiscreteVariable*, const Potential< GUM_SCALAR >* >
       __evidences;

    HashTable< const Potential< GUM_SCALAR >*, Instantiation* > __potentialBucket;

    HashTable< const Potential< GUM_SCALAR >*, Instantiation* > __utilityBucket;

    Sequence< NodeId > __eliminationOrder;

    Instantiation __allVarsInst;

    List< const DiscreteVariable* > __removableVarList;

    List< const Potential< GUM_SCALAR >* > __removablePotentialList;

    List< const Potential< GUM_SCALAR >* > __removableUtilityList;
  };

#endif   // DOXYGEN_SHOULD_SKIP_THIS

} /* namespace gum */

#include <agrum/ID/inference/influenceDiagramInference_tpl.h>

#endif /* GUM_INFLUENCE_DIAGRAM_INFERENCE_H */