IMarkovNet.h

Go to the documentation of this file.

#ifndef GUM_SIMPLE_MARKOV_NET_H
#define GUM_SIMPLE_MARKOV_NET_H

#include <utility>

#include <agrum/agrum.h>

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

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

namespace gum {
  template < typename GUM_SCALAR >
  using FactorTable = HashTable< NodeSet, const Potential< GUM_SCALAR >* >;

  // template < typename GUM_SCALAR >
  // class MarkovNetFactory;

  template < typename GUM_SCALAR >
  class IMarkovNet: public UGmodel {
    public:
    // ===========================================================================
    // ===========================================================================

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

    virtual ~IMarkovNet();

    IMarkovNet(const IMarkovNet< GUM_SCALAR >& source);

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



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

    virtual const Potential< GUM_SCALAR >& factor(const NodeSet& varIds) const = 0;
    virtual const FactorTable< GUM_SCALAR >& factors() 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;

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

    bool operator!=(const IMarkovNet< 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;
  };


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


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

} /* namespace gum */

#include <agrum/MN/IMarkovNet_tpl.h>

#endif /* GUM_SIMPLE_MARKOV_NET_H */