causalImpact.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_IMPACT_H
#define GUM_CAUSAL_IMPACT_H
 
#include <memory>
#include <string>
#include <vector>
 
#include <agrum/CM/tools/causalFormula.h>
#include <agrum/CM/tools/doCalculus.h>
#include <agrum/CM/tools/separation.h>
 
namespace gum {
 
  template < GUM_Numeric GUM_SCALAR >
  class CausalImpact;
  template < GUM_Numeric GUM_SCALAR >
  class Tensor;

  template < GUM_Numeric GUM_SCALAR >
  std::tuple< CausalImpact< GUM_SCALAR >, Tensor< GUM_SCALAR >, std::string >
      causalImpact(const CausalModel< GUM_SCALAR >&             cm,
                   const Set< std::string >&                    on,
                   const Set< std::string >&                    doing,
                   const Set< std::string >&                    knowing = Set< std::string >(),
                   const HashTable< std::string, std::string >& values
                   = HashTable< std::string, std::string >());

  template < GUM_Numeric GUM_SCALAR >
  class CausalImpact {
    public:
    // --- Forwarded accessors for wrapping ---
    Tensor< GUM_SCALAR > eval() const;

    std::string toString() const;

    std::string toLatex(std::string_view doOperatorPrefix = "do(",
                        std::string_view doOperatorSuffix = ")") const;

    std::string latexQuery(std::string_view doOperatorPrefix = "do(",
                           std::string_view doOperatorSuffix = ")") const;

    [[nodiscard]] bool isIdentified() const noexcept;

    const ASTtree< GUM_SCALAR >& root() const;
 
    // --- Accessors ---
    const CausalFormula< GUM_SCALAR >& getResult() const;
 
    const CausalModel< GUM_SCALAR >& cm() const;
 
    const NodeSet& on() const;
 
    const NodeSet& doing() const;
 
    const NodeSet& knowing() const;
 
    const std::string& explanation() const;

    std::vector< std::string > onNames() const;
 
    std::vector< std::string > doingNames() const;
 
    std::vector< std::string > knowingNames() const;

    CausalImpact(const CausalModel< GUM_SCALAR >& cm,
                 const Set< std::string >&        on,
                 const Set< std::string >&        doing,
                 const Set< std::string >&        knowing          = Set< std::string >(),
                 bool                             directDoCalculus = false);

    CausalImpact(const CausalModel< GUM_SCALAR >& cm,
                 const NodeSet&                   on,
                 const NodeSet&                   doing,
                 const NodeSet&                   knowing          = NodeSet(),
                 bool                             directDoCalculus = false);

    CausalImpact(const CausalImpact&) = default;
    CausalImpact(CausalImpact&&)      = default;
 
    private:
    bool _directDoCalculus_ = false;

    CausalFormula< GUM_SCALAR > _resultFormula_;
 
 
    // helpers
    static Set< std::string > _idsToNames_(const CausalModel< GUM_SCALAR >& cm, const NodeSet& ids);
    static NodeSet            _namesToIds_(const CausalModel< GUM_SCALAR >& cm,
                                           const Set< std::string >&        names);
    static bool               _disjoint_(const Set< std::string >& a,
                                         const Set< std::string >& b,
                                         const Set< std::string >& c);
 
    // core builders that return the fully-formed formula (for initializer list)
    static CausalFormula< GUM_SCALAR > _buildFromNames_(const CausalModel< GUM_SCALAR >& cm,
                                                        const Set< std::string >&        on,
                                                        const Set< std::string >&        doing,
                                                        const Set< std::string >&        knowing,
                                                        bool directDoCalculus);
 
    static CausalFormula< GUM_SCALAR > _buildFromIds_(const CausalModel< GUM_SCALAR >& cm,
                                                      const NodeSet&                   on,
                                                      const NodeSet&                   doing,
                                                      const NodeSet&                   knowing,
                                                      bool directDoCalculus);
  };

  template < GUM_Numeric GUM_SCALAR >
  inline Instantiation
      makeInstantiationFromValues(const Tensor< GUM_SCALAR >&                  tensor,
                                  const HashTable< std::string, std::string >& values);
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class CausalImpact< double >;
#endif
 
}   // namespace gum
 
#include <agrum/CM/causalImpact_tpl.h>
 
#endif   // GUM_CAUSAL_IMPACT_H