doCalculus.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_DO_CALCULUS_H
#define GUM_DO_CALCULUS_H
 
#include <memory>
#include <string>
#include <vector>
 
#include <agrum/CM/causalModel.h>
#include <agrum/CM/tools/doAST.h>
 
namespace gum {

  template < GUM_Numeric GUM_SCALAR >
  class DoCalculus {
    public:
    using FormulaPtr = std::unique_ptr< ASTtree< GUM_SCALAR > >;

    using NameList = std::vector< std::string >;
 
    /* ------------------------ Construction ------------------------ */
 
    explicit DoCalculus(const CausalModel< GUM_SCALAR >& cm) noexcept : _cm{cm} {}
 
    const CausalModel< GUM_SCALAR >& model() const noexcept;
 
    /* -------------------- Backdoor / Frontdoor -------------------- */
 
    FormulaPtr getBackDoorTree(NodeId cause, NodeId effect, const NodeSet& zset) const;
 
    FormulaPtr getBackDoorTree(std::string_view causeName,
                               std::string_view effectName,
                               const NameList&  zNames) const;
 
    FormulaPtr getFrontDoorTree(NodeId cause, NodeId effect, const NodeSet& zset) const;
 
    FormulaPtr getFrontDoorTree(std::string_view causeName,
                                std::string_view effectName,
                                const NameList&  zNames) const;
 
    /* --------------------- General identification ----------------- */

    FormulaPtr identifyingIntervention(const NodeSet& Y, const NodeSet& X) const;

    FormulaPtr identifyingIntervention(const NameList& Y, const NameList& X) const;

    FormulaPtr doCalculus(const NodeSet& on, const NodeSet& doing) const;
    FormulaPtr doCalculus(const NameList& on, const NameList& doing) const;

    FormulaPtr doCalculusWithObservation(const NodeSet& on,
                                         const NodeSet& doing,
                                         const NodeSet& knowing) const;
    FormulaPtr doCalculusWithObservation(const NameList& on,
                                         const NameList& doing,
                                         const NameList& knowing) const;
 
    private:
    const CausalModel< GUM_SCALAR >& _cm;
 
    /* ---------- Helpers for ID/IDC (DAG-only; never mutate CausalModel) ---------- */

    std::vector< NodeSet > _cDecomposition_(const CausalModel< GUM_SCALAR >& cm) const;

    std::vector< NodeSet > _cDecompositionOn_(const CausalModel< GUM_SCALAR >& sub) const;

    std::vector< NodeId > _topoObserved_(const CausalModel< GUM_SCALAR >& cm) const;

    static NodeSet _ancestorsIn_(const DAG& g, const NodeSet& T);

    static DAG _removeIncomingInto_(const DAG& dag, const NodeSet& X);

    static DAG _removeInIntoDoing_outOfKnowing_(const DAG&     dag,
                                                const NodeSet& doing,
                                                const NodeSet& knowing);

    FormulaPtr _ID_(const CausalModel< GUM_SCALAR >&         cm,
                    const NodeSet&                           Y,
                    const NodeSet&                           X,
                    std::unique_ptr< ASTtree< GUM_SCALAR > > P) const;

    static std::string _hedgeExceptionMsg(const CausalModel< GUM_SCALAR >& cm,
                                          const NodeSet&                   Y,
                                          const NodeSet&                   X,
                                          const NodeSet&                   V,
                                          const NodeSet&                   S);
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class DoCalculus< double >;
#endif
 
}   // namespace gum
 
#include <agrum/CM/tools/doCalculus_tpl.h>
 
#endif   // GUM_DO_CALCULUS_H