doAST.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_AST_H
#define GUM_DO_AST_H
 
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/IBayesNet.h>
 
#include <string_view>
 
namespace gum {
 
  template < GUM_Numeric GUM_SCALAR >
  class IBayesNet;
  template < GUM_Numeric GUM_SCALAR >
  class Tensor;
 
  // ================================================================
  // ASTtree
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTtree {
    public:
    explicit ASTtree(std::string_view type);
 
    virtual ~ASTtree();
 
    ASTtree(const ASTtree&)            = delete;
    ASTtree& operator=(const ASTtree&) = delete;
 
    ASTtree(ASTtree&&) noexcept { GUM_CONS_MOV(ASTtree) }
 
    ASTtree& operator=(ASTtree&&) noexcept = default;

    const std::string& type() const noexcept;

    virtual std::string toString(std::string_view prefix = "") const = 0;

    virtual std::string protectToLatex(HashTable< std::string, int >& nameOccur) const = 0;

    virtual std::string fastToLatex(HashTable< std::string, int >& nameOccur) const = 0;

    std::string toLatex(HashTable< std::string, int > nameOccur
                        = HashTable< std::string, int >()) const;

    virtual std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const = 0;

    virtual Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const = 0;
 
    protected:
    static constexpr const char* CONTINUE_PREFIX = "| ";
    std::string                  _type;

    static std::string _latexCorrect(std::string_view               srcName,
                                     HashTable< std::string, int >& nameOccur);
    static std::vector< std::string > _latexCorrect(const Set< std::string >&      srcNames,
                                                    HashTable< std::string, int >& nameOccur);
  };
 
  // ================================================================
  // ASTBinaryOp
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTBinaryOp: public ASTtree< GUM_SCALAR > {
    public:
    ASTBinaryOp(std::string_view                         typ,
                std::unique_ptr< ASTtree< GUM_SCALAR > > op1,
                std::unique_ptr< ASTtree< GUM_SCALAR > > op2);
 
    ASTBinaryOp(const ASTBinaryOp&)                = delete;
    ASTBinaryOp& operator=(const ASTBinaryOp&)     = delete;
    ASTBinaryOp(ASTBinaryOp&&) noexcept            = default;
    ASTBinaryOp& operator=(ASTBinaryOp&&) noexcept = default;

    const ASTtree< GUM_SCALAR >& op1() const;

    const ASTtree< GUM_SCALAR >& op2() const;

    std::string toString(std::string_view prefix = "") const override;
 
    protected:
    std::unique_ptr< ASTtree< GUM_SCALAR > > _op1, _op2;
  };
 
  // ================================================================
  // ASTplus (ASTBinaryOp)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTplus: public ASTBinaryOp< GUM_SCALAR > {
    public:
    ASTplus(std::unique_ptr< ASTtree< GUM_SCALAR > > op1,
            std::unique_ptr< ASTtree< GUM_SCALAR > > op2);
 
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
  };
 
  // ================================================================
  // ASTminus (ASTBinaryOp)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTminus: public ASTBinaryOp< GUM_SCALAR > {
    public:
    ASTminus(std::unique_ptr< ASTtree< GUM_SCALAR > > op1,
             std::unique_ptr< ASTtree< GUM_SCALAR > > op2);
 
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
  };
 
  // ================================================================
  // ASTmult (ASTBinaryOp)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTmult: public ASTBinaryOp< GUM_SCALAR > {
    public:
    ASTmult(std::unique_ptr< ASTtree< GUM_SCALAR > > op1,
            std::unique_ptr< ASTtree< GUM_SCALAR > > op2);
 
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
  };
 
  // ================================================================
  // ASTdiv (ASTBinaryOp)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTdiv: public ASTBinaryOp< GUM_SCALAR > {
    public:
    ASTdiv(std::unique_ptr< ASTtree< GUM_SCALAR > > op1,
           std::unique_ptr< ASTtree< GUM_SCALAR > > op2);
 
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
  };
 
  // ================================================================
  // ASTposteriorProba   :  P_bn(vars | knw_min)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTposteriorProba: public ASTtree< GUM_SCALAR > {
    public:
    explicit ASTposteriorProba(const DAGmodel&           bn,
                               const Set< std::string >& vars,
                               const Set< std::string >& knw);

    explicit ASTposteriorProba(const DAG&                              bn,
                               const Bijection< NodeId, std::string >& id2name,
                               const Set< std::string >&               vars,
                               const Set< std::string >&               knw);

    explicit ASTposteriorProba(const Set< std::string >& vars, const Set< std::string >& knw);

    const Set< std::string >& vars() const noexcept;

    const Set< std::string >& knw() const noexcept;

    std::string toString(std::string_view prefix = "") const override;
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;

    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
 
    private:
    Set< std::string > _vars;   
    Set< std::string > _knw;    
 
 
    static void _ensure_nonempty(const Set< std::string >& vars);
 
    static Set< std::string > _compute_knw_from_bn(const DAGmodel&           bn,
                                                   const Set< std::string >& vars,
                                                   const Set< std::string >& knw);
 
    static Set< std::string > _compute_knw_from_dag(const DAG&                              dag,
                                                    const Bijection< NodeId, std::string >& id2name,
                                                    const Set< std::string >&               vars,
                                                    const Set< std::string >&               knw);
  };
 
  // ================================================================
  // ASTjointProba :  P(vars) in observational BN
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTjointProba: public ASTtree< GUM_SCALAR > {
    public:
    explicit ASTjointProba(const Set< std::string >& varNames);

    const Set< std::string >& varNames() const noexcept;

    std::string toString(std::string_view prefix = "") const override;
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;

    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
 
    private:
    Set< std::string > _varNames;
  };
 
  // ================================================================
  // ASTsum  :  sum out over variable of sub-term
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  class ASTsum: public ASTtree< GUM_SCALAR > {
    public:
    ASTsum(std::string_view var, std::unique_ptr< ASTtree< GUM_SCALAR > > term);

    ASTsum(const std::vector< std::string >& vars, std::unique_ptr< ASTtree< GUM_SCALAR > > term);

    [[nodiscard]] const std::string& var() const;

    const ASTtree< GUM_SCALAR >& term() const;

    std::string toString(std::string_view prefix = "") const override;
    std::string protectToLatex(HashTable< std::string, int >& nameOccur) const override;
    std::string fastToLatex(HashTable< std::string, int >& nameOccur) const override;

    std::unique_ptr< ASTtree< GUM_SCALAR > > copy() const override;
    Tensor< GUM_SCALAR > eval(const IBayesNet< GUM_SCALAR >& contextual_bn) const override;
 
    private:
    std::string                              _var;    
    std::unique_ptr< ASTtree< GUM_SCALAR > > _term;   
  };
 
  // ================================================================
  // productOfTrees  (utility function)
  // ================================================================
  template < GUM_Numeric GUM_SCALAR >
  std::unique_ptr< ASTtree< GUM_SCALAR > >
      productOfTrees(std::vector< std::unique_ptr< ASTtree< GUM_SCALAR > > >&& lterms);
 
 
// ================================================================
// Extern template declarations
// ================================================================
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class ASTtree< double >;
  extern template class ASTplus< double >;
  extern template class ASTminus< double >;
  extern template class ASTmult< double >;
  extern template class ASTdiv< double >;
  extern template class ASTposteriorProba< double >;
  extern template class ASTjointProba< double >;
  extern template class ASTsum< double >;
  extern template std::unique_ptr< ASTtree< double > >
      productOfTrees< double >(std::vector< std::unique_ptr< ASTtree< double > > >&&);
#endif
 
}   // namespace gum
 
#include <agrum/CM/tools/doAST_tpl.h>
 
#endif   // GUM_DO_AST_H