BayesNet.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_H
#define GUM_BAYES_NET_H

#include <utility>

#include <agrum/agrum.h>

#include <agrum/core/hashTable.h>

#include <agrum/BN/IBayesNet.h>
#include <agrum/multidim/potential.h>

namespace gum {

  template < typename GUM_SCALAR >
  class BayesNetFactory;

  template < typename GUM_SCALAR >
  class BayesNet : public IBayesNet< GUM_SCALAR > {
    friend class BayesNetFactory< GUM_SCALAR >;

    public:
    static BayesNet< GUM_SCALAR > fastPrototype(const std::string& dotlike,
                                                Size               domainSize = 2);

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

    BayesNet();

    explicit BayesNet(std::string name);

    ~BayesNet() final;

    BayesNet(const BayesNet< GUM_SCALAR >& source);

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

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

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

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

    const Potential< GUM_SCALAR >& cpt(const std::string& name) const {
      return cpt(idFromName(name));
    };

    const VariableNodeMap& variableNodeMap() const final;

    NodeId add(const DiscreteVariable& var);

    NodeId add(const std::string& name, unsigned int nbrmod);

    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 erase(NodeId varId);

    void erase(const std::string& name) { erase(idFromName(name)); };

    void erase(const DiscreteVariable& var);

    const DiscreteVariable& variable(NodeId id) const final;

    const DiscreteVariable& variable(const std::string& name) const {
      return variable(idFromName(name));
    };

    void changeVariableName(NodeId id, const std::string& new_name);

    void changeVariableName(const std::string& name, const std::string& new_name) {
      changeVariableName(idFromName(name), new_name);
    }

    void changeVariableLabel(NodeId             id,
                             const std::string& old_label,
                             const std::string& new_label);

    void changeVariableLabel(const std::string& name,
                             const std::string& old_label,
                             const std::string& new_label) {
      changeVariableLabel(idFromName(name), old_label, new_label);
    }

    NodeId nodeId(const DiscreteVariable& var) const final;

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

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

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

    void addArc(NodeId tail, NodeId head);

    void addArc(const std::string& tail, const std::string& head) {
      addArc(idFromName(tail), idFromName(head));
    }

    void eraseArc(const Arc& arc);

    void eraseArc(NodeId tail, NodeId head);

    void eraseArc(const std::string& tail, const std::string& head) {
      eraseArc(idFromName(tail), idFromName(head));
    }

    void beginTopologyTransformation();
    void endTopologyTransformation();

    void reverseArc(NodeId tail, NodeId head);
    void reverseArc(const std::string& tail, const std::string& head) {
      reverseArc(idFromName(tail), idFromName(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);
    void addWeightedArc(NodeId tail, NodeId head, GUM_SCALAR causalWeight);

    void addWeightedArc(const std::string& tail,
                        const std::string& head,
                        GUM_SCALAR         causalWeight) {
      addWeightedArc(idFromName(tail), idFromName(head), causalWeight);
    };

    void generateCPTs() const;

    void generateCPT(NodeId node) const;
    void generateCPT(const std::string& name) const {
      generateCPT(idFromName(name));
    };

    void changePotential(NodeId id, Potential< GUM_SCALAR >* newPot);
    void changePotential(const std::string& name, Potential< GUM_SCALAR >* newPot);

    private:
    void __clearPotentials();

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

    VariableNodeMap __varMap;

    NodeProperty< Potential< GUM_SCALAR >* > __probaMap;
    // HashTable<NodeId, Potential<GUM_SCALAR>* > __probaMap;

    void _unsafeChangePotential(NodeId id, Potential< GUM_SCALAR >* newPot);

    public:
    using IBayesNet< GUM_SCALAR >::dag;
    using IBayesNet< GUM_SCALAR >::size;
    using IBayesNet< GUM_SCALAR >::nodes;
    using IBayesNet< GUM_SCALAR >::log10DomainSize;
  };

  template < typename 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 */