IBayesNet.h

Go to the documentation of this file.

#ifndef GUM_SIMPLE_BAYES_NET_H
#define GUM_SIMPLE_BAYES_NET_H

#include <utility>

#include <agrum/agrum.h>

#include <agrum/tools/core/hashTable.h>

#include <agrum/tools/graphicalModels/DAGmodel.h>
#include <agrum/tools/multidim/potential.h>

namespace gum {

  template < typename GUM_SCALAR >
  class BayesNetFactory;

  template < typename GUM_SCALAR >
  class IBayesNet: public DAGmodel {
    public:
    // ===========================================================================
    // ===========================================================================

    IBayesNet();
    explicit IBayesNet(std::string name);

    virtual ~IBayesNet();

    IBayesNet(const IBayesNet< GUM_SCALAR >& source);

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

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

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

    virtual const VariableNodeMap& variableNodeMap() const = 0;

    virtual const DiscreteVariable& variable(NodeId id) const = 0;

    virtual NodeId nodeId(const DiscreteVariable& var) const = 0;

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

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

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

    GUM_SCALAR jointProbability(const Instantiation& i) const;

    GUM_SCALAR log2JointProbability(const Instantiation& i) const;


    bool operator==(const IBayesNet< GUM_SCALAR >& from) const;

    bool operator!=(const IBayesNet< GUM_SCALAR >& from) const;

    Size dim() const;

    Size maxVarDomainSize() const;

    GUM_SCALAR minParam() const;

    GUM_SCALAR maxParam() const;

    GUM_SCALAR minNonZeroParam() const;

    GUM_SCALAR maxNonOneParam() const;

    virtual std::string toDot() const;

    std::string toString() const;

    /***
     * @return the minimal subset of soids that conditions the target
     *
     * i.e. P(target| soids)=P(target|@return)
     */
    NodeSet minimalCondSet(NodeId target, const NodeSet& soids) const;


    /***
     * @return the minimal subset of soids that conditions the targets
     *
     * i.e. P(targets| soids)=P(targets|@return)
     */
    NodeSet minimalCondSet(const NodeSet& targets, const NodeSet& soids) const;

    private:
    void __minimalCondSetVisitUp(NodeId         node,
                                 const NodeSet& soids,
                                 NodeSet&       minimal,
                                 NodeSet&       alreadyVisitedUp,
                                 NodeSet&       alreadyVisitedDn) const;
    void __minimalCondSetVisitDn(NodeId         node,
                                 const NodeSet& soids,
                                 NodeSet&       minimal,
                                 NodeSet&       alreadyVisitedUp,
                                 NodeSet&       alreadyVisitedDn) const;
  };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class IBayesNet< double >;
#endif


  template < typename GUM_SCALAR >
  std::ostream& operator<<(std::ostream&                  output,
                           const IBayesNet< GUM_SCALAR >& bn);

} /* namespace gum */

#include <agrum/BN/IBayesNet_tpl.h>

#endif /* GUM_SIMPLE_BAYES_NET_H */