BayesNet.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_BAYES_NET_H
#define GUM_BAYES_NET_H
 
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/IBayesNet.h>
 
namespace gum {
  template < GUM_Numeric GUM_SCALAR >
  class BayesNetFactory;
 
  template < GUM_Numeric GUM_SCALAR >
  class AggregatorDecomposition;
 
  template < GUM_Numeric GUM_SCALAR >
  class GumBNReader;

  template < GUM_Numeric GUM_SCALAR >
  class BayesNet: public IBayesNet< GUM_SCALAR > {
    friend class BayesNetFactory< GUM_SCALAR >;
    friend class GumBNReader< GUM_SCALAR >;
    friend class AggregatorDecomposition< GUM_SCALAR >;
 
    public:
    static BayesNet< GUM_SCALAR > fastPrototype(std::string_view dotlike, Size domainSize);
    static BayesNet< GUM_SCALAR > fastPrototype(std::string_view dotlike,
                                                std::string_view domainSize = "[2]");
 
    // ===========================================================================
    // ===========================================================================

    BayesNet();

    explicit BayesNet(std::string_view name);

    ~BayesNet() override;

    BayesNet(const BayesNet< GUM_SCALAR >& source);

    BayesNet(BayesNet< GUM_SCALAR >&& source);

    // ===========================================================================
    // ===========================================================================

    BayesNet< GUM_SCALAR >& operator=(const BayesNet< GUM_SCALAR >& source);

    BayesNet< GUM_SCALAR >& operator=(BayesNet< GUM_SCALAR >&& source);

    // ===========================================================================
    // ===========================================================================

    const Tensor< GUM_SCALAR >& cpt(NodeId varId) const final;

    const Tensor< GUM_SCALAR >& cpt(std::string_view name) const;

    NodeId add(const DiscreteVariable& var);

    NodeId add(std::string_view fast_description, unsigned int default_nbrmod = 2);

    NodeId add(const DiscreteVariable& var, MultiDimImplementation< GUM_SCALAR >* aContent);

    NodeId add(const DiscreteVariable& var, NodeId id);

    NodeId
        add(const DiscreteVariable& var, MultiDimImplementation< GUM_SCALAR >* aContent, NodeId id);

    void clear();

    void erase(NodeId varId);

    void erase(std::string_view name);

    void erase(const DiscreteVariable& var);

    const DiscreteVariable& variable(std::string_view name) const;

    void changeVariableName(NodeId id, std::string_view new_name);

    void changeVariableName(std::string_view name, std::string_view new_name);

    void changeVariableLabel(NodeId id, std::string_view old_label, std::string_view new_label);

    void changeVariableLabel(std::string_view name,
                             std::string_view old_label,
                             std::string_view new_label);

 
    // ===========================================================================
    // ===========================================================================

    void addArc(NodeId tail, NodeId head);

    void addArc(std::string_view tail, std::string_view head);

    void eraseArc(const Arc& arc);

    void eraseArc(NodeId tail, NodeId head);

    void eraseArc(std::string_view tail, std::string_view head);

    void beginTopologyTransformation();
    void endTopologyTransformation();

    void reverseArc(NodeId tail, NodeId head);
 
    void reverseArc(std::string_view tail, std::string_view head);
 
    void reverseArc(const Arc& arc);

 
    // ===========================================================================
    // ===========================================================================

 
    NodeId addNoisyOR(const DiscreteVariable& var, GUM_SCALAR external_weight);
    NodeId addNoisyORNet(const DiscreteVariable& var, GUM_SCALAR external_weight);
    NodeId addNoisyORCompound(const DiscreteVariable& var, GUM_SCALAR external_weight);

    NodeId addNoisyOR(const DiscreteVariable& var, GUM_SCALAR external_weight, NodeId id);
    NodeId addNoisyORNet(const DiscreteVariable& var, GUM_SCALAR external_weight, NodeId id);
    NodeId addNoisyORCompound(const DiscreteVariable& var, GUM_SCALAR external_weight, NodeId id);

    NodeId addNoisyAND(const DiscreteVariable& var, GUM_SCALAR external_weight, NodeId id);

    NodeId addNoisyAND(const DiscreteVariable& var, GUM_SCALAR external_weight);

    NodeId addLogit(const DiscreteVariable& var, GUM_SCALAR external_weight, NodeId id);

    NodeId addLogit(const DiscreteVariable& var, GUM_SCALAR external_weight);

    NodeId addOR(const DiscreteVariable& var);

    NodeId addAND(const DiscreteVariable& var);

    NodeId addAMPLITUDE(const DiscreteVariable& var);
    NodeId addCOUNT(const DiscreteVariable& var, Idx value = 1);
    NodeId addEXISTS(const DiscreteVariable& var, Idx value = 1);
    NodeId addFORALL(const DiscreteVariable& var, Idx value = 1);
    NodeId addMAX(const DiscreteVariable& var);
    NodeId addMEDIAN(const DiscreteVariable& var);
    NodeId addMIN(const DiscreteVariable& var);
    NodeId addSUM(const DiscreteVariable& var);

    void addWeightedArc(NodeId tail, NodeId head, GUM_SCALAR causalWeight);

    void addWeightedArc(std::string_view tail, std::string_view head, GUM_SCALAR causalWeight);


    void generateCPTs() const;

    void generateCPT(NodeId node) const;
 
    void generateCPT(std::string_view name) const;

    void changeTensor(NodeId id, Tensor< GUM_SCALAR >* newPot);
    void changeTensor(std::string_view name, Tensor< GUM_SCALAR >* newPot);

    BayesNet< GUM_SCALAR > contextualize(const gum::Instantiation& observations,
                                         const gum::Instantiation& interventions) const;
 
    private:
    void _clearTensors_();

    void _copyTensors_(const BayesNet< GUM_SCALAR >& source);

    NodeProperty< Tensor< GUM_SCALAR >* > _probaMap_;

    void _unsafeChangeTensor_(NodeId id, Tensor< GUM_SCALAR >* newPot);

    NodeId
        _addAggregator_(std::string_view aggregatorType, const DiscreteVariable& var, Idx value = 1);

    NodeId
        _addICIModel_(std::string_view iciType, const DiscreteVariable& var, GUM_SCALAR externalWeight);
 
    public:
    using IBayesNet< GUM_SCALAR >::dag;
    using IBayesNet< GUM_SCALAR >::size;
    using IBayesNet< GUM_SCALAR >::nodes;
    using IBayesNet< GUM_SCALAR >::log10DomainSize;
    using DiscreteGraphicalModel::idFromName;
    using DiscreteGraphicalModel::variableNodeMap;
    using DiscreteGraphicalModel::variable;
    using DiscreteGraphicalModel::nodeId;
    using DiscreteGraphicalModel::variableFromName;
  };

  template < GUM_Numeric GUM_SCALAR >
  std::ostream& operator<<(std::ostream& output, const BayesNet< GUM_SCALAR >& bn);
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class BayesNet< double >;
#endif
} /* namespace gum */
 
#include <agrum/BN/BayesNet_tpl.h>
 
#endif /* GUM_BAYES_NET_H */