BayesNetFragment.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_FRAGMENT_H
#define GUM_BAYES_NET_FRAGMENT_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphs/parts/listeners/diGraphListener.h>
#include <agrum/BN/BayesNet.h>
 
namespace gum {
  template < typename GUM_SCALAR >
  class BayesNetFragment: public IBayesNet< GUM_SCALAR >, public gum::DiGraphListener {
    const IBayesNet< GUM_SCALAR >& _bn_;

    NodeProperty< const Tensor< GUM_SCALAR >* > _localCPTs_;
 
    public:
    BayesNetFragment()                                               = delete;
    BayesNetFragment(const BayesNetFragment< GUM_SCALAR >& fragment) = delete;
    BayesNetFragment(BayesNetFragment< GUM_SCALAR >&& fragment)      = delete;
 
    explicit BayesNetFragment(const IBayesNet< GUM_SCALAR >& bn);
 
    virtual ~BayesNetFragment();



    virtual void whenNodeAdded(const void* src, NodeId id) final;


    virtual void whenNodeDeleted(const void* src, NodeId id) final;


    virtual void whenArcAdded(const void* src, NodeId from, NodeId to) final;


    virtual void whenArcDeleted(const void* src, NodeId from, NodeId to) final;


    const Tensor< GUM_SCALAR >& cpt(NodeId varId) const final;
 
    const Tensor< GUM_SCALAR >& cpt(const std::string& name) const {
      return cpt(idFromName(name));
    };

    const VariableNodeMap& variableNodeMap() const final;

    virtual const DiscreteVariable& variable(NodeId id) const final;
 
    virtual const DiscreteVariable& variable(const std::string& name) const final {
      return variable(idFromName(name));
    };

    virtual NodeId nodeId(const DiscreteVariable& var) const final;

    virtual NodeId idFromName(const std::string& name) const final;

    virtual const DiscreteVariable& variableFromName(const std::string& name) const final;

    virtual std::string toDot() const final;



    bool isInstalledNode(NodeId id) const;
 
    bool isInstalledNode(const std::string& name) const {
      return isInstalledNode(idFromName(name));
    };

    void installNode(NodeId id);
 
    void installNode(const std::string& name) { installNode(_bn_.idFromName(name)); }

    void installAscendants(NodeId id);
 
    void installAscendants(const std::string& name) { installAscendants(_bn_.idFromName(name)); }

    void uninstallNode(NodeId id);
 
    void uninstallNode(const std::string& name) { uninstallNode(idFromName(name)); }

    void installMarginal(NodeId id, const Tensor< GUM_SCALAR >& pot);
 
    void installMarginal(const std::string& name, const Tensor< GUM_SCALAR >& pot) {
      installMarginal(_bn_.idFromName(name), pot);
    }

    void installCPT(NodeId id, const Tensor< GUM_SCALAR >& pot);
 
    void installCPT(const std::string& name, const Tensor< GUM_SCALAR >& pot) {
      installCPT(_bn_.idFromName(name), pot);
    };

    void uninstallCPT(NodeId id);
 
    void uninstallCPT(const std::string& name) { uninstallCPT(idFromName(name)); }

    bool checkConsistency(NodeId id) const;
 
    bool checkConsistency(const std::string& name) const {
      return checkConsistency(idFromName(name));
    }

    bool checkConsistency() const;

 

    gum::BayesNet< GUM_SCALAR > toBN() const;
 
    using IBayesNet< GUM_SCALAR >::nodes;
    using IBayesNet< GUM_SCALAR >::dag;
 
    protected:
    // remove an arc
    void uninstallArc_(NodeId from, NodeId to);
 
    // add an arc
    void installArc_(NodeId from, NodeId to);
 
    // install a CPT BY COPY, create or delete arcs. Checks are made in public
    // methods In particular, it is assumed that all the variables in the pot are
    // in the fragment
    void installCPT_(NodeId id, const Tensor< GUM_SCALAR >& pot);

    void uninstallCPT_(NodeId id);
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class BayesNetFragment< double >;
#endif
 
}   // namespace gum
 
#include <agrum/BN/BayesNetFragment_tpl.h>
 
#endif   // GUM_BAYES_NET_FRAGMENT_H