causalModel.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_CAUSAL_MODEL_H
#define GUM_CAUSAL_MODEL_H
 
#include <optional>
#include <string>
 
#include <agrum/BN/BayesNet.h>
 
namespace gum {
 
  // forward declaration:
  template < GUM_Numeric GUM_SCALAR >
  class ASTtree;


  using LatentDescriptorIds = std::pair< std::string, std::vector< NodeId > >;

  using LatentDescriptorVector = std::vector< LatentDescriptorIds >;

  template < GUM_Numeric GUM_SCALAR >
  class CausalModel {
    private:
    BayesNet< GUM_SCALAR > _observationalBN_;

    DAG _causalDAG_;

    Bijection< NodeId, std::string > _ids_names_;
 
    public:
    CausalModel() = delete;

    explicit CausalModel(const BayesNet< GUM_SCALAR >& observationalBN);

    explicit CausalModel(const BayesNet< GUM_SCALAR >& observationalBN,
                         const LatentDescriptorVector& latentVarsDescriptor,
                         bool                          assumeNonSpurious = false);

    CausalModel(const CausalModel& other);

    CausalModel(CausalModel&& other) noexcept;

    ~CausalModel();

    CausalModel& operator=(const CausalModel& other) = default;

    CausalModel& operator=(CausalModel&& other) noexcept = default;

    void addLatentVariable(std::string_view                  latentName,
                           const std::vector< std::string >& childrenOfLatent,
                           bool                              assumeNonSpurious = false);

    void addLatentVariable(std::string_view             latentName,
                           const std::vector< NodeId >& childrenOfLatent,
                           bool                         assumeNonSpurious = false);

    bool existsArc(NodeId x, NodeId y) const;

    bool existsArc(std::string_view x, std::string_view y) const;

    void assumeSpurious(NodeId x, NodeId y);
    void assumeSpurious(std::string_view x, std::string_view y);

    void assumeNonSpurious(NodeId x, NodeId y);
    void assumeNonSpurious(std::string_view x, std::string_view y);

    bool isAssumedSpurious(NodeId x, NodeId y) const;
    bool isAssumedSpurious(std::string_view x, std::string_view y) const;
 
    // ======================================================================
    // Door-criteria conveniences
    // ======================================================================

    std::optional< NodeSet > backDoor(NodeId cause, NodeId effect) const;
 
    std::optional< NodeSet > backDoor(std::string_view cause, std::string_view effect) const;

    std::optional< NodeSet > frontDoor(NodeId cause, NodeId effect) const;

    std::optional< NodeSet > frontDoor(std::string_view cause, std::string_view effect) const;

    CausalModel< GUM_SCALAR > inducedCausalSubModel(const CausalModel< GUM_SCALAR >& cm,
                                                    NodeSet                          subset) const;

    std::string toDot(const bool  SHOW_LATENT_NAMES = false,
                      const char* NODE_BG           = "#404040",
                      const char* NODE_FG           = "white",
                      const char* EDGE_COL          = "#4A4A4A") const;

    const BayesNet< GUM_SCALAR >& observationalBN() const;

    DAG causalDAG() const;

    Set< std::string > names() const;

    NodeId idFromName(std::string_view name) const;

    std::string nameFromId(NodeId id) const;

    Bijection< NodeId, std::string > id2name(bool includeLatentVariable = false) const;

    NodeSet latentVariablesIds() const;

    Set< std::string > latentVariablesNames() const;

    NodeSet parents(NodeId x) const;

    NodeSet parents(std::string_view name) const;

    NodeSet children(NodeId x) const;

    NodeSet children(std::string_view name) const;

    HashTable< NodeId, NodeSet > connectedComponents() const;

    const DiscreteVariable& variable(NodeId id) const;

    const DiscreteVariable& variable(std::string_view name) const;
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class CausalModel< double >;
#endif
 
}   // namespace gum
 
#include <agrum/CM/causalModel_tpl.h>
 
#endif   // GUM_CAUSAL_MODEL_H