causalFormula.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_FORMULA_H
#define GUM_CAUSAL_FORMULA_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 CausalFormula {
    public:
    CausalFormula(const CausalModel< GUM_SCALAR >&         cm,
                  std::unique_ptr< ASTtree< GUM_SCALAR > > root,
                  const Set< std::string >&                on,
                  const Set< std::string >&                doing,
                  const Set< std::string >&                knowing     = Set< std::string >{},
                  std::string_view                         explanation = "");

    CausalFormula(const CausalModel< GUM_SCALAR >&         cm,
                  std::unique_ptr< ASTtree< GUM_SCALAR > > root,
                  const NodeSet&                           on,
                  const NodeSet&                           doing,
                  const NodeSet&                           knowing     = NodeSet{},
                  std::string_view                         explanation = "");

    CausalFormula(const CausalFormula& other);

    CausalFormula(CausalFormula&&) = default;

    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;

    std::unique_ptr< CausalFormula< GUM_SCALAR > > copy() const;

    bool isIdentified() const noexcept;

    const ASTtree< GUM_SCALAR >& root() const;
 
    // --- Accessors ---
    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;
 
 
    private:
    static NodeSet _toNodeSetFromNames_(const CausalModel< GUM_SCALAR >& cm,
                                        const Set< std::string >&        names);

    void _ensureVariablesExist() const;

    void _ensureNoVariablesOverlap() const;
 
    const CausalModel< GUM_SCALAR >&         _cm;
    std::unique_ptr< ASTtree< GUM_SCALAR > > _root;
    const NodeSet                            _on;
    const NodeSet                            _doing;
    const NodeSet                            _knowing;
    const std::string                        _explanation;
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class CausalFormula< double >;
#endif
 
}   // namespace gum
 
#include <agrum/CM/tools/causalFormula_tpl.h>
 
#endif   // GUM_CAUSAL_FORMULA_H