influenceDiagram.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {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_INF_DIAG_H
#define GUM_INF_DIAG_H

#include <string>
#include <utility>

#include <agrum/agrum.h>

#include <agrum/core/hashTable.h>

#include <agrum/graphicalModels/DAGmodel.h>

#include <agrum/multidim/potential.h>

namespace gum {

  template < typename GUM_SCALAR >
  class InfluenceDiagram : public DAGmodel {
    // friend class InfluenceDiagramFactory<GUM_SCALAR>;

    public:
    // ===========================================================================
    // ===========================================================================

    InfluenceDiagram();

    virtual ~InfluenceDiagram();

    InfluenceDiagram(const InfluenceDiagram< GUM_SCALAR >& source);

    InfluenceDiagram< GUM_SCALAR >&
       operator=(const InfluenceDiagram< GUM_SCALAR >& source);


    std::string toDot() const;

    std::string toString() const;

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

    virtual const Potential< GUM_SCALAR >& cpt(NodeId varId) const;

    virtual const Potential< GUM_SCALAR >& utility(NodeId varId) const;

    virtual const VariableNodeMap& variableNodeMap() const;

    bool isUtilityNode(NodeId varId) const;

    bool isDecisionNode(NodeId varId) const;

    bool isChanceNode(NodeId varId) const;

    Size utilityNodeSize() const;

    Size chanceNodeSize() const;

    Size decisionNodeSize() const;

    virtual const DiscreteVariable& variable(NodeId id) const;

    virtual NodeId nodeId(const DiscreteVariable& var) const;

    virtual NodeId idFromName(const std::string& name) const;

    virtual const DiscreteVariable&
       variableFromName(const std::string& name) const;

    NodeId add(const DiscreteVariable& variable, NodeId id = 0);

    NodeId addChanceNode(const DiscreteVariable& variable, NodeId id = 0);

    NodeId addUtilityNode(const DiscreteVariable& variable, NodeId id = 0);

    NodeId addDecisionNode(const DiscreteVariable& variable, NodeId id = 0);

    NodeId addChanceNode(const DiscreteVariable&               variable,
                         MultiDimImplementation< GUM_SCALAR >* aContent,
                         NodeId                                id = 0);

    NodeId addUtilityNode(const DiscreteVariable&               variable,
                          MultiDimImplementation< GUM_SCALAR >* aContent,
                          NodeId                                id = 0);

    void erase(NodeId id);

    void erase(const DiscreteVariable& var);

    void changeVariableName(NodeId id, const std::string& new_name);

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

    void addArc(NodeId tail, NodeId head);

    void eraseArc(const Arc& arc);

    void eraseArc(NodeId tail, NodeId head);


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

    bool decisionOrderExists() const;

    gum::DAG* getDecisionGraph() const;

    std::vector< NodeId >* getDecisionOrder() const;

    bool existsPathBetween(NodeId src, NodeId dest) const;

    const List< NodeSet >& getPartialTemporalOrder(bool clear = true) const;


    protected:
    virtual void _moralGraph(UndiGraph& graph) const;

    void _removeTables();

    void _copyTables(const InfluenceDiagram< GUM_SCALAR >& IDsource);

    NodeId _addNode(const DiscreteVariable& variableType, NodeId DesiredId);

    Sequence< NodeId > _getChildrenDecision(NodeId parentDecision) const;

    private:
    VariableNodeMap __variableMap;

    NodeProperty< Potential< GUM_SCALAR >* > __potentialMap;
    NodeProperty< Potential< GUM_SCALAR >* > __utilityMap;

    mutable List< NodeSet > __temporalOrder;
  };

} /* namespace gum */

#include <agrum/ID/influenceDiagram_tpl.h>

#endif /* GUM_INF_DIAG_H */