counterfactual.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_COUNTERFACTUAL_H
#define GUM_COUNTERFACTUAL_H
 
#include <memory>
#include <ostream>
#include <string>
 
#include <agrum/CM/causalImpact.h>
 
namespace gum {
  template < GUM_Numeric GUM_ELEMENT >
  class Counterfactual {
    public:
    using VarName = std::string;
    using ValName = std::string;
 
    // ---------- Names-based constructor ----------
    Counterfactual(const CausalModel< GUM_ELEMENT >&    cm,
                   const Set< std::string >&            on,
                   const Set< std::string >&            whatif,
                   const HashTable< VarName, ValName >& profile = HashTable< VarName, ValName >(),
                   const HashTable< VarName, ValName >& values  = HashTable< VarName, ValName >());
 
    // ---------- IDs-based constructor (NodeSet overload) ----------
    Counterfactual(const CausalModel< GUM_ELEMENT >& cm,
                   const NodeSet&                    onIds,
                   const NodeSet&                    whatifIds,
                   const HashTable< NodeId, Idx >&   profileIds = HashTable< NodeId, Idx >(),
                   const HashTable< NodeId, Idx >&   valuesIds  = HashTable< NodeId, Idx >());
 
    // ---------- Twin builders (overloaded like CausalImpact) ----------
    static CausalModel< GUM_ELEMENT >
        counterFactualModel(const CausalModel< GUM_ELEMENT >&    cm,
                            const HashTable< VarName, ValName >& profile,
                            const Set< std::string >&            whatif);
 
    static CausalModel< GUM_ELEMENT >
        counterFactualModel(const CausalModel< GUM_ELEMENT >& cm,
                            const HashTable< NodeId, Idx >&   profileIds,
                            const NodeSet&                    whatifIds);

    void run();
 
    // ---------- Accessors ----------
    const CausalModel< GUM_ELEMENT >& originalModel() const;
 
    const CausalModel< GUM_ELEMENT >& twinModel() const;

    const CausalImpact< GUM_ELEMENT >& impact() const;

    const Tensor< GUM_ELEMENT >& value() const;
 
    const Set< std::string >& on() const;
 
    const Set< std::string >& whatif() const;
 
    const HashTable< VarName, ValName >& profile() const;
 
    const HashTable< VarName, ValName >& values() const;
 
    std::string toString() const;
 
    private:
    static Tensor< GUM_ELEMENT > _adaptToOriginalVariables_(const Tensor< GUM_ELEMENT >&      adj,
                                                            const CausalModel< GUM_ELEMENT >& cm);
 
    const CausalFormula< GUM_ELEMENT >& _ciResult() const;
 
    static Set< std::string > _idsToNames_(const CausalModel< GUM_ELEMENT >& cm,
                                           const NodeSet&                    ids);
    static HashTable< VarName, ValName >
        _idAssignToNameAssign_(const CausalModel< GUM_ELEMENT >& cm,
                               const HashTable< NodeId, Idx >&   idAssign);
 
    private:
    const CausalModel< GUM_ELEMENT >& _cm;
    Set< std::string >                _on;
    Set< std::string >                _whatif;
    HashTable< VarName, ValName >     _profile;
    HashTable< VarName, ValName >     _values;
 
    CausalModel< GUM_ELEMENT > _twin;
    Tensor< GUM_ELEMENT >      _adaptedValue;
 
    std::unique_ptr< CausalImpact< GUM_ELEMENT > > _ci;
  };
 
  // ============================================================================
  // Standalone helpers (Python-parity)
  // ============================================================================

  template < GUM_Numeric GUM_ELEMENT >
  Tensor< GUM_ELEMENT > counterfactual(const CausalModel< GUM_ELEMENT >&            cm,
                                       const Set< std::string >&                    on,
                                       const Set< std::string >&                    whatif,
                                       const HashTable< std::string, std::string >& profile
                                       = HashTable< std::string, std::string >(),
                                       const HashTable< std::string, std::string >& values
                                       = HashTable< std::string, std::string >());

  template < GUM_Numeric GUM_ELEMENT >
  CausalModel< GUM_ELEMENT >
      counterfactualModel(const CausalModel< GUM_ELEMENT >&            cm,
                          const HashTable< std::string, std::string >& profile,
                          const Set< std::string >&                    whatif);
 
}   // namespace gum
 
#include <agrum/CM/counterfactual_tpl.h>
 
#endif   // GUM_COUNTERFACTUAL_H