influenceDiagram.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 GUM_INF_DIAG_H
#define GUM_INF_DIAG_H
 
#include <string>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/DAGmodel.h>
#include <agrum/base/multidim/tensor.h>
 
namespace gum {

  template < typename GUM_SCALAR >
  class InfluenceDiagram: public DAGmodel {
    // friend class InfluenceDiagramFactory<GUM_SCALAR>;
 
    public:
    static InfluenceDiagram< GUM_SCALAR > fastPrototype(const std::string& dotlike,
                                                        Size               domainSize);
    static InfluenceDiagram< GUM_SCALAR > fastPrototype(const std::string& dotlike,
                                                        const std::string& domain = "[2]");
 
    // ===========================================================================
    // ===========================================================================

    InfluenceDiagram();

    ~InfluenceDiagram() override;

    InfluenceDiagram(const InfluenceDiagram< GUM_SCALAR >& source);

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

    bool operator==(const InfluenceDiagram< GUM_SCALAR >& other) const;
 
    bool operator!=(const InfluenceDiagram< GUM_SCALAR >& other) const {
      return !operator==(other);
    }

    std::string toDot() const;

    std::string toString() const;
 
    void clear();
 
    // ===========================================================================
    // ===========================================================================

    virtual const Tensor< GUM_SCALAR >& cpt(NodeId varId) const;
 
    virtual const Tensor< GUM_SCALAR >& cpt(std::string name) const final {
      return cpt(idFromName(name));
    };

    virtual const Tensor< GUM_SCALAR >& utility(NodeId varId) const;
 
    virtual const Tensor< GUM_SCALAR >& utility(std::string name) const final {
      return utility(idFromName(name));
    };

    const VariableNodeMap& variableNodeMap() const final;

    bool isUtilityNode(NodeId varId) const;
 
    bool isUtilityNode(const std::string& name) const { return isUtilityNode(idFromName(name)); };

    bool isDecisionNode(NodeId varId) const;
 
    bool isDecisionNode(const std::string& name) const { return isDecisionNode(idFromName(name)); };

    bool isChanceNode(NodeId varId) const;
 
    bool isChanceNode(const std::string& name) const { return isChanceNode(idFromName(name)); };

    Size utilityNodeSize() const;

    Size chanceNodeSize() const;

    Size decisionNodeSize() const;

    const DiscreteVariable& variable(NodeId id) const final;
 
    const DiscreteVariable& variable(const std::string& name) const {
      return variable(idFromName(name));
    };

    NodeId nodeId(const DiscreteVariable& var) const final;

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

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

    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);
 

    NodeId add(const std::string& fast_description, unsigned int default_nbrmod = 2);

    NodeId addChanceNode(const std::string& fast_description, unsigned int default_nbrmod = 2);

    NodeId addUtilityNode(const std::string& fast_description);

    NodeId addDecisionNode(const std::string& fast_description, unsigned int default_nbrmod = 2);
 

    void erase(NodeId id);
 
    void erase(const std::string& name) { erase(idFromName(name)); };

    void erase(const DiscreteVariable& var);

    void changeVariableName(NodeId id, const std::string& new_name);
 
    void changeVariableName(const std::string& name, const std::string& new_name) {
      changeVariableName(idFromName(name), new_name);
    }

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

    void addArc(NodeId tail, NodeId head);
 
    void addArc(const std::string& tail, const std::string& head) {
      addArc(idFromName(tail), idFromName(head));
    }

    void eraseArc(const Arc& arc);

    void eraseArc(NodeId tail, NodeId head);
 
    void eraseArc(const std::string& tail, const std::string& head) {
      eraseArc(idFromName(tail), idFromName(head));
    }

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

    bool decisionOrderExists() const;

    gum::DAG* getDecisionGraph() const;

    std::vector< NodeId > decisionOrder() const;

    bool existsPathBetween(NodeId src, NodeId dest) const;
 
    bool existsPathBetween(const std::string& src, const std::string& dest) const {
      return existsPathBetween(idFromName(src), idFromName(dest));
    }

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


    void beginTopologyTransformation();
    void endTopologyTransformation();
 
    protected:
    virtual void moralGraph_(UndiGraph& graph) const;

    void removeTables_();

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

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

    Sequence< NodeId > getChildrenDecision_(NodeId parentDecision) const;
 
    private:
    VariableNodeMap _variableMap_;

    NodeProperty< Tensor< GUM_SCALAR >* > _tensorMap_;
    NodeProperty< Tensor< GUM_SCALAR >* > _utilityMap_;

    mutable List< NodeSet > _temporalOrder_;
  };
 
} /* namespace gum */
 
#include <agrum/ID/influenceDiagram_tpl.h>
 
#endif /* GUM_INF_DIAG_H */