BayesNetFragment.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_BAYES_NET_FRAGMENT_H
#define GUM_BAYES_NET_FRAGMENT_H

#include <agrum/agrum.h>

#include <agrum/BN/IBayesNet.h>
#include <agrum/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 {
    private:
    const IBayesNet< GUM_SCALAR >& __bn;

    NodeProperty< const Potential< 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) noexcept override;


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


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


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


    virtual const Potential< GUM_SCALAR >& cpt(NodeId varId) const override;

    virtual const VariableNodeMap& variableNodeMap() const override;

    virtual const DiscreteVariable& variable(NodeId id) const override;

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

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

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

    virtual std::string toDot() const override;



    bool isInstalledNode(NodeId id) const noexcept;

    void installNode(NodeId id);

    void installAscendants(NodeId id);

    void uninstallNode(NodeId id) noexcept;

    void installMarginal(NodeId id, const Potential< GUM_SCALAR >* pot);

    void installCPT(NodeId id, const Potential< GUM_SCALAR >* pot);

    void uninstallCPT(NodeId id) noexcept;

    bool checkConsistency(NodeId id) const;

    bool checkConsistency() const noexcept;


    using IBayesNet< GUM_SCALAR >::nodes;
    using IBayesNet< GUM_SCALAR >::dag;

    protected:
    // remove an arc
    void _uninstallArc(NodeId from, NodeId to) noexcept;

    // add an arc
    void _installArc(NodeId from, NodeId to) noexcept;

    // install a CPT, 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 Potential< GUM_SCALAR >* pot) noexcept;

    void _uninstallCPT(NodeId id) noexcept;
  };


#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