gum::IMarkovNet< GUM_SCALAR > Class Template Reference

Class representing the minimal interface for Markov Network. More...

#include <agrum/BN/IMarkovNet.h>

Inheritance diagram for gum::IMarkovNet< GUM_SCALAR >:

Collaboration diagram for gum::IMarkovNet< GUM_SCALAR >:

Public Member Functions
bool	operator== (const IMarkovNet< GUM_SCALAR > &from) const
	This operator compares 2 BNs ! More...
bool	operator!= (const IMarkovNet< GUM_SCALAR > &from) const
Size	dim () const
	Returns the dimension (the number of free parameters) in this bayes net. More...
Size	maxVarDomainSize () const
GUM_SCALAR	minParam () const
GUM_SCALAR	maxParam () const
GUM_SCALAR	minNonZeroParam () const
GUM_SCALAR	maxNonOneParam () const
virtual std::string	toDot () const
virtual std::string	toDotAsFactorGraph () const
std::string	toString () const
NodeSet	minimalCondSet (NodeId target, const NodeSet &soids) const
NodeSet	minimalCondSet (const NodeSet &targets, const NodeSet &soids) const
bool	hasSameStructure (const UGmodel &other)
	check if nodes X and nodes Y are independent given nodes Z More...
double	log10DomainSize () const
Constructors / Destructors
	IMarkovNet ()
	Default constructor. More...
	IMarkovNet (std::string name)
	Default constructor. More...
virtual	~IMarkovNet ()
	Destructor. More...
	IMarkovNet (const IMarkovNet< GUM_SCALAR > &source)
	Copy constructor. More...
IMarkovNet< GUM_SCALAR > &	operator= (const IMarkovNet< GUM_SCALAR > &source)
	Copy operator. More...
Pure Virtual methods
virtual const Potential< GUM_SCALAR > &	factor (const NodeSet &varIds) const =0
	Returns the factor of a set of variable. More...
virtual const NodeSet &	smallestFactorFromNode (NodeId node) const =0
	Returns the smallest factor that contains this variable. More...
virtual const NodeSet &	smallestFactorFromNode (const std::string &name) const
	Returns the smallest factor that contains this variable. More...
virtual const FactorTable< GUM_SCALAR > &	factors () const =0
	Returns the set of factors as a IMarkovNet::FactorTable. More...
virtual const VariableNodeMap &	variableNodeMap () const =0
	Returns a constant reference to the VariableNodeMap of thisBN. More...
virtual const DiscreteVariable &	variable (NodeId id) const =0
	Returns a constant reference over a variable given it's node id. More...
virtual NodeId	nodeId (const DiscreteVariable &var) const =0
	Return id node from discrete var pointer. More...
virtual NodeId	idFromName (const std::string &name) const =0
	Getter by name. More...
virtual const DiscreteVariable &	variableFromName (const std::string &name) const =0
	Getter by name. More...
Variable manipulation methods.
const UndiGraph &	graph () const
	Returns a constant reference to the dag of this Bayes Net. More...
virtual Size	size () const final
	Returns the number of variables in this Directed Graphical Model. More...
Size	sizeEdges () const
	Returns the number of arcs in this Directed Graphical Model. More...
const NodeGraphPart &	nodes () const final
	Returns a constant reference to the dag of this Bayes Net. More...
bool	exists (NodeId node) const final
	Return true if this node exists in this graphical model. More...
Variable manipulation methods.
bool	exists (const std::string &name) const
	Return true if this graphical model is empty. More...
virtual bool	empty () const
	Return true if this graphical model is empty. More...
std::vector< std::string >	names (const std::vector< NodeId > &ids) const
	transform a vector of NodeId in a vector of names More...
std::vector< std::string >	names (const NodeSet &ids) const
	transform a NodeSet in a vector of names More...
std::vector< NodeId >	ids (const std::vector< std::string > &names) const
	transform a vector of names into a vector of nodeId More...
NodeSet	nodeset (const std::vector< std::string > &names) const
	transform a vector of names into a NodeSet More...
Instantiation	completeInstantiation () const
	Get an instantiation over all the variables of the model. More...
Edge manipulation methods.
const EdgeSet &	edges () const
	return true if the edge node1-node2 exists in the UGModel More...
bool	existsEdge (const NodeId node1, const NodeId node2) const
	return true if the edge node1-node2 exists in the UGModel More...
bool	existsEdge (const std::string &name1, const std::string &name2) const
	return true if the edge node1-node2 exists in the UGModel More...
const NodeSet &	neighbours (const NodeId id) const
	returns the neighbours of a node as set of nodes More...
const NodeSet &	neighbours (const std::string &name) const
	return true if the edge node1-node2 exists in the UGModel More...
virtual bool	isIndependent (NodeId X, NodeId Y, const NodeSet &Z) const final
	check if X and Y are independent given Z More...
bool	isIndependent (const NodeSet &X, const NodeSet &Y, const NodeSet &Z) const final
	check if nodes X and nodes Y are independent given nodes Z More...
bool	isIndependent (const std::string &Xname, const std::string &Yname, const std::vector< std::string > &Znames) const
	return true if the edge node1-node2 exists in the UGModel More...
bool	isIndependent (const std::vector< std::string > &Xnames, const std::vector< std::string > &Ynames, const std::vector< std::string > &Znames) const
	return true if the edge node1-node2 exists in the UGModel More...
Getter and setters
const std::string &	property (const std::string &name) const
	Return the value of the property name of this GraphicalModel. More...
const std::string &	propertyWithDefault (const std::string &name, const std::string &byDefault) const
	Return the value of the property name of this GraphicalModel. More...
void	setProperty (const std::string &name, const std::string &value)
	Add or change a property of this GraphicalModel. More...

Protected Attributes
UndiGraph	graph_
	The DAG of this Directed Graphical Model. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::IMarkovNet< GUM_SCALAR >

Class representing the minimal interface for Markov Network.

This class is used as a base class for different versions of Markov Networks. No data (except the graph herited from UGModel are included in this class. Many algorithms (inference for instance) may use this class when a simple MN is needed.

Definition at line 60 of file IMarkovNet.h.

Constructor & Destructor Documentation

IMarkovNet() [1/3]

template<typename GUM_SCALAR >

INLINE gum::IMarkovNet< GUM_SCALAR >::IMarkovNet

(

)

Default constructor.

Definition at line 40 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                              : UGmodel() {
    GUM_CONSTRUCTOR(IMarkovNet);
  }

Here is the call graph for this function:

IMarkovNet() [2/3]

template<typename GUM_SCALAR >

INLINE gum::IMarkovNet< GUM_SCALAR >::IMarkovNet ( std::string  name )

explicit

Default constructor.

Definition at line 45 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            : UGmodel() {
    GUM_CONSTRUCTOR(IMarkovNet);
    this->setProperty("name", name);
  }

Here is the call graph for this function:

~IMarkovNet()

template<typename GUM_SCALAR >

gum::IMarkovNet< GUM_SCALAR >::~IMarkovNet ( )

virtual

Destructor.

Definition at line 64 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                        {
    GUM_DESTRUCTOR(IMarkovNet);
  }

Here is the call graph for this function:

IMarkovNet() [3/3]

template<typename GUM_SCALAR >

gum::IMarkovNet< GUM_SCALAR >::IMarkovNet

(

const IMarkovNet< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 51 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                             : UGmodel(source) {
    GUM_CONS_CPY(IMarkovNet);
  }

Here is the call graph for this function:

Member Function Documentation

_minimalCondSetVisit_()

template<typename GUM_SCALAR >

void gum::IMarkovNet< GUM_SCALAR >::_minimalCondSetVisit_ ( NodeId  node, const NodeSet &  soids, NodeSet &  minimal, NodeSet &  alreadyVisited  ) const

private

Definition at line 309 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    if (alreadyVisited.contains(node)) return;
    alreadyVisited << node;

    if (soids.contains(node)) {
      minimal << node;
    } else {
      for (auto neig: graph_.neighbours(node))
        _minimalCondSetVisit_(neig, soids, minimal, alreadyVisited);
    }
  }

Here is the call graph for this function:

completeInstantiation()

INLINE Instantiation gum::GraphicalModel::completeInstantiation ( ) const

inherited

Get an instantiation over all the variables of the model.

Definition at line 84 of file graphicalModel_inl.h.

                                                            {
    Instantiation I;

    for (const auto node: nodes())
      I << variable(node);

    return I;
  }

dim()

template<typename GUM_SCALAR >

INLINE Size gum::IMarkovNet< GUM_SCALAR >::dim

(

)

const

Returns the dimension (the number of free parameters) in this bayes net.

\( dim(G)=\sum_{i \in nodes} ((r_i-1)\cdot q_i) \) where \( r_i \) is the number of instantiations of node \( i \) and \( q_i \) is the number of instantiations of its parents.

Definition at line 69 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                  {
    Size res = 0;
    for (auto f: factors()) {
      res += f.second->domainSize();
    }
    return res;
  }

Here is the call graph for this function:

edges()

INLINE const EdgeSet & gum::UGmodel::edges ( ) const

inherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 43 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph_.edges(); }

Here is the call graph for this function:

empty()

INLINE bool gum::GraphicalModel::empty ( ) const

virtualinherited

Return true if this graphical model is empty.

Definition at line 94 of file graphicalModel_inl.h.

{ return size() == 0; }

exists() [1/2]

INLINE bool gum::UGmodel::exists ( NodeId  node ) const

finalvirtualinherited

Return true if this node exists in this graphical model.

Implements gum::GraphicalModel.

Definition at line 58 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph_.exists(node); }

Here is the call graph for this function:

exists() [2/2]

bool gum::GraphicalModel::exists ( const std::string &  name ) const

inlineinherited

Return true if this graphical model is empty.

Definition at line 112 of file graphicalModel.h.

{ return exists(idFromName(name)); };

existsEdge() [1/2]

INLINE bool gum::UGmodel::existsEdge ( const NodeId  node1, const NodeId  node2  ) const

inherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 45 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                              {
    return graph_.existsEdge(node1, node2);
  }

Here is the call graph for this function:

existsEdge() [2/2]

INLINE bool gum::UGmodel::existsEdge ( const std::string &  name1, const std::string &  name2  ) const

inherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 49 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                      {
    return existsEdge(idFromName(name1), idFromName(name2));
  }

Here is the call graph for this function:

factor()

template<typename GUM_SCALAR >

virtual const Potential< GUM_SCALAR >& gum::IMarkovNet< GUM_SCALAR >::factor ( const NodeSet &  varIds ) const

pure virtual

Returns the factor of a set of variable.

Exceptions

NotFound

If no variable's id matches varId.

factors()

template<typename GUM_SCALAR >

virtual const FactorTable< GUM_SCALAR >& gum::IMarkovNet< GUM_SCALAR >::factors ( ) const

pure virtual

Returns the set of factors as a IMarkovNet::FactorTable.

graph()

INLINE const UndiGraph & gum::UGmodel::graph ( ) const

inherited

Returns a constant reference to the dag of this Bayes Net.

Definition at line 35 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph_; }

Here is the call graph for this function:

hasSameStructure()

bool gum::UGmodel::hasSameStructure ( const UGmodel &  other )

inherited

check if nodes X and nodes Y are independent given nodes Z

Returns

true if all the named node are the same and all the named arcs are the same

Definition at line 50 of file UGmodel.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                     {
    if (this == &other) return true;

    if (size() != other.size()) return false;

    if (sizeEdges() != other.sizeEdges()) return false;

    for (const auto& nid: nodes()) {
      try {
        other.idFromName(variable(nid).name());
      } catch (NotFound) { return false; }
    }

    for (const auto& edge: edges()) {
      if (!other.edges().exists(Edge(other.idFromName(variable(edge.first()).name()),
                                     other.idFromName(variable(edge.second()).name()))))
        return false;
    }

    return true;
  }

Here is the call graph for this function:

idFromName()

template<typename GUM_SCALAR >

virtual NodeId gum::IMarkovNet< GUM_SCALAR >::idFromName ( const std::string &  name ) const

pure virtual

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implements gum::GraphicalModel.

ids()

INLINE std::vector< NodeId > gum::GraphicalModel::ids ( const std::vector< std::string > &  names ) const

inherited

transform a vector of names into a vector of nodeId

Returns

the vector of names

Definition at line 117 of file graphicalModel_inl.h.

                                                                                   {
    std::vector< NodeId >  res;
    const VariableNodeMap& v = variableNodeMap();
    std::transform(names.cbegin(),
                   names.cend(),
                   std::back_inserter(res),
                   [v](const std::string& n) { return v.idFromName(n); });
    return res;
  }

isIndependent() [1/4]

INLINE bool gum::UGmodel::isIndependent ( NodeId  X, NodeId  Y, const NodeSet &  Z  ) const

finalvirtualinherited

check if X and Y are independent given Z

Implements gum::GraphicalModel.

Definition at line 62 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    return !graph().hasUndirectedPath(X, Y, Z);
  }

Here is the call graph for this function:

isIndependent() [2/4]

INLINE bool gum::UGmodel::isIndependent ( const NodeSet &  X, const NodeSet &  Y, const NodeSet &  Z  ) const

finalvirtualinherited

check if nodes X and nodes Y are independent given nodes Z

Implements gum::GraphicalModel.

Definition at line 66 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                               {
    return !graph().hasUndirectedPath(X, Y, Z);
  }

Here is the call graph for this function:

isIndependent() [3/4]

bool gum::UGmodel::isIndependent ( const std::string &  Xname, const std::string &  Yname, const std::vector< std::string > &  Znames  ) const

inlineinherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 125 of file UGmodel.h.

                                                                   {
      return isIndependent(idFromName(Xname), idFromName(Yname), nodeset(Znames));
    };

isIndependent() [4/4]

bool gum::UGmodel::isIndependent ( const std::vector< std::string > &  Xnames, const std::vector< std::string > &  Ynames, const std::vector< std::string > &  Znames  ) const

inlineinherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 130 of file UGmodel.h.

                                                                   {
      return isIndependent(nodeset(Xnames), nodeset(Ynames), nodeset(Znames));
    };

log10DomainSize()

INLINE double gum::GraphicalModel::log10DomainSize ( ) const

inherited

Definition at line 73 of file graphicalModel_inl.h.

                                               {
    double dSize = 0.0;

    for (const auto node: nodes()) {
      dSize += std::log10(variable(node).domainSize());
    }

    return dSize;
  }

maxNonOneParam()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::IMarkovNet< GUM_SCALAR >::maxNonOneParam

(

)

const

Returns

the biggest value (not equal to 1) in the CPTs of *this

Definition at line 118 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                   {
    GUM_SCALAR res = 0.0;
    for (auto elt: factors()) {
      auto v = elt.second->maxNonOne();
      if (v > res) { res = v; }
    }
    return res;
  }

Here is the call graph for this function:

maxParam()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::IMarkovNet< GUM_SCALAR >::maxParam

(

)

const

Returns

the biggest value in the CPTs of *this

Definition at line 98 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    GUM_SCALAR res = 1.0;
    for (auto elt: factors()) {
      auto v = elt.second->max();
      if (v > res) { res = v; }
    }
    return res;
  }

Here is the call graph for this function:

maxVarDomainSize()

template<typename GUM_SCALAR >

INLINE Size gum::IMarkovNet< GUM_SCALAR >::maxVarDomainSize

(

)

const

Returns

the biggest domainSize among the variables of *this

Definition at line 78 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    Size res = 0;
    for (auto node: nodes()) {
      auto v = variable(node).domainSize();
      if (v > res) { res = v; }
    }
    return res;
  }

Here is the call graph for this function:

minimalCondSet() [1/2]

template<typename GUM_SCALAR >

NodeSet gum::IMarkovNet< GUM_SCALAR >::minimalCondSet	(	NodeId	target,
		const NodeSet &	soids
	)		const

Definition at line 326 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    if (soids.contains(target)) return NodeSet({target});

    NodeSet res;
    NodeSet alreadyVisited;
    alreadyVisited << target;

    for (auto neig: graph_.neighbours(target))
      _minimalCondSetVisit_(neig, soids, res, alreadyVisited);
    return res;
  }

Here is the call graph for this function:

minimalCondSet() [2/2]

template<typename GUM_SCALAR >

NodeSet gum::IMarkovNet< GUM_SCALAR >::minimalCondSet	(	const NodeSet &	targets,
		const NodeSet &	soids
	)		const

Definition at line 339 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    NodeSet res;
    for (auto node: targets) {
      res += minimalCondSet(node, soids);
    }
    return res;
  }

Here is the call graph for this function:

minNonZeroParam()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::IMarkovNet< GUM_SCALAR >::minNonZeroParam

(

)

const

Returns

the smallest value (not equal to 0) in the CPTs of *this

Definition at line 108 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                    {
    GUM_SCALAR res = 1.0;
    for (auto elt: factors()) {
      auto v = elt.second->minNonZero();
      if (v < res) { res = v; }
    }
    return res;
  }

Here is the call graph for this function:

minParam()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::IMarkovNet< GUM_SCALAR >::minParam

(

)

const

Returns

the smallest value in the CPTs of *this

Definition at line 88 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    GUM_SCALAR res = 1.0;
    for (auto elt: factors()) {
      auto v = elt.second->min();
      if (v < res) { res = v; }
    }
    return res;
  }

Here is the call graph for this function:

names() [1/2]

INLINE std::vector< std::string > gum::GraphicalModel::names ( const std::vector< NodeId > &  ids ) const

inherited

transform a vector of NodeId in a vector of names

Returns

the vector of names

Definition at line 97 of file graphicalModel_inl.h.

                                                                                   {
    std::vector< std::string > res;
    const VariableNodeMap&     v = variableNodeMap();
    std::transform(ids.cbegin(), ids.cend(), std::back_inserter(res), [v](NodeId n) {
      return v[n].name();
    });
    return res;
  }

names() [2/2]

INLINE std::vector< std::string > gum::GraphicalModel::names ( const NodeSet &  ids ) const

inherited

transform a NodeSet in a vector of names

Returns

the vector of names

Definition at line 107 of file graphicalModel_inl.h.

                                                                       {
    const VariableNodeMap&     v = variableNodeMap();
    std::vector< std::string > res;
    for (auto n: ids) {
      res.push_back(v.name(n));
    }
    return res;
  }

neighbours() [1/2]

INLINE const NodeSet & gum::UGmodel::neighbours ( const NodeId  id ) const

inherited

returns the neighbours of a node as set of nodes

Note that the set of nodes returned may be empty if no edge within the EdgeGraphPart contains the given node.

Parameters

id	the node toward which the edge returned are pointing

Definition at line 53 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph_.neighbours(id); }

Here is the call graph for this function:

neighbours() [2/2]

INLINE const NodeSet & gum::UGmodel::neighbours ( const std::string &  name ) const

inherited

return true if the edge node1-node2 exists in the UGModel

Parameters

node1	the nodeId (or the name) of the node1
node2	the nodeId (or the name) of the node2

Returns

true if the edge exists

Definition at line 54 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                       {
    return neighbours(idFromName(name));
  }

Here is the call graph for this function:

nodeId()

template<typename GUM_SCALAR >

virtual NodeId gum::IMarkovNet< GUM_SCALAR >::nodeId ( const DiscreteVariable &  var ) const

pure virtual

Return id node from discrete var pointer.

Exceptions

NotFound

If no variable matches var.

Implements gum::GraphicalModel.

nodes()

INLINE const NodeGraphPart & gum::UGmodel::nodes ( ) const

finalvirtualinherited

Returns a constant reference to the dag of this Bayes Net.

Implements gum::GraphicalModel.

Definition at line 60 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return (NodeGraphPart&)graph_; }

Here is the call graph for this function:

nodeset()

NodeSet gum::GraphicalModel::nodeset ( const std::vector< std::string > &  names ) const

inherited

transform a vector of names into a NodeSet

Returns

NodeSet

Definition at line 58 of file graphicalModel.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    NodeSet res;
    for (const auto& name: names) {
      res.insert(idFromName(name));
    }
    return res;
  }

Here is the call graph for this function:

operator!=()

template<typename GUM_SCALAR >

INLINE bool gum::IMarkovNet< GUM_SCALAR >::operator!=

(

const IMarkovNet< GUM_SCALAR > &

from

)

const

Returns

Returns false if the src and this are equal.

Definition at line 289 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    return !this->operator==(from);
  }

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR >

IMarkovNet< GUM_SCALAR > & gum::IMarkovNet< GUM_SCALAR >::operator=

(

const IMarkovNet< GUM_SCALAR > &

source

)

Copy operator.

Definition at line 57 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    if (this != &source) { UGmodel::operator=(source); }

    return *this;
  }

Here is the call graph for this function:

operator==()

template<typename GUM_SCALAR >

bool gum::IMarkovNet< GUM_SCALAR >::operator==

(

const IMarkovNet< GUM_SCALAR > &

from

)

const

This operator compares 2 BNs !

Warning

To identify nodes between BNs, it is assumed that they share the same name.

Returns

true if the src and this are equal.

Definition at line 243 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                        {
    if (size() != from.size()) { return false; }

    if (sizeEdges() != from.sizeEdges()) { return false; }

    // alignment of variables between the 2 BNs
    Bijection< const DiscreteVariable*, const DiscreteVariable* > alignment;

    for (auto node: nodes()) {
      try {
        alignment.insert(&variable(node), &from.variableFromName(variable(node).name()));
      } catch (NotFound&) {
        // a name is not found in from
        return false;
      }
    }

    for (const auto& elt: factors()) {
      const auto& key    = elt.first;
      const auto& factor = *elt.second;

      NodeSet fromkey;
      for (const auto n: key)
        fromkey.insert(from.idFromName(variable(n).name()));

      if (!from.factors().exists(fromkey)) { return false; }

      const auto& fromfactor = from.factor(fromkey);

      Instantiation i(factor);
      Instantiation j(fromfactor);
      for (i.setFirst(); !i.end(); i.inc()) {
        for (Idx indice = 0; indice < factor.nbrDim(); ++indice) {
          const DiscreteVariable* p = &(i.variable(indice));
          j.chgVal(*(alignment.second(p)), i.val(*p));
        }

        if (std::pow(factor.get(i) - fromfactor.get(j), (GUM_SCALAR)2) > (GUM_SCALAR)1e-6) {
          return false;
        }
      }
    }
    return true;
  }

Here is the call graph for this function:

property()

INLINE const std::string & gum::GraphicalModel::property ( const std::string &  name ) const

inherited

Return the value of the property name of this GraphicalModel.

Exceptions

NotFound

Raised if no name property is found.

Definition at line 38 of file graphicalModel_inl.h.

                                                                       {
    try {
      return _properties_()[name];
    } catch (NotFound&) {
      std::string msg = "The following property does not exists: ";
      GUM_ERROR(NotFound, msg + name)
    }
  }

propertyWithDefault()

INLINE const std::string & gum::GraphicalModel::propertyWithDefault ( const std::string &  name, const std::string &  byDefault  ) const

inherited

Return the value of the property name of this GraphicalModel.

return byDefault if the property name is not found

Definition at line 57 of file graphicalModel_inl.h.

                                                                                           {
    try {
      return _properties_()[name];
    } catch (NotFound&) { return byDefault; }
  }

setProperty()

INLINE void gum::GraphicalModel::setProperty ( const std::string &  name, const std::string &  value  )

inherited

Add or change a property of this GraphicalModel.

Definition at line 65 of file graphicalModel_inl.h.

                                                                                {
    try {
      _properties_()[name] = value;
    } catch (NotFound&) { _properties_().insert(name, value); }
  }

size()

INLINE Size gum::UGmodel::size ( ) const

finalvirtualinherited

Returns the number of variables in this Directed Graphical Model.

Implements gum::GraphicalModel.

Definition at line 38 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph().size(); }

Here is the call graph for this function:

sizeEdges()

INLINE Size gum::UGmodel::sizeEdges ( ) const

inherited

Returns the number of arcs in this Directed Graphical Model.

Definition at line 41 of file UGmodel_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return graph_.sizeEdges(); }

Here is the call graph for this function:

smallestFactorFromNode() [1/2]

template<typename GUM_SCALAR >

virtual const NodeSet& gum::IMarkovNet< GUM_SCALAR >::smallestFactorFromNode ( NodeId  node ) const

pure virtual

Returns the smallest factor that contains this variable.

Exceptions

NotFound

If no variable's id matches varId.

smallestFactorFromNode() [2/2]

template<typename GUM_SCALAR >

INLINE const NodeSet & gum::IMarkovNet< GUM_SCALAR >::smallestFactorFromNode ( const std::string &  name ) const

virtual

Returns the smallest factor that contains this variable.

Exceptions

NotFound

If no variable's id matches varId.

Definition at line 301 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                           {
    try {
      return smallestFactorFromNode(idFromName(name));
    } catch (NotFound) { GUM_ERROR(NotFound, "No factor containing the variable <" << name << ">") }
  }

Here is the call graph for this function:

toDot()

template<typename GUM_SCALAR >

std::string gum::IMarkovNet< GUM_SCALAR >::toDot ( ) const

virtual

Returns

Returns a dot representation of this IMarkovNet.

Definition at line 149 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                  {
    std::stringstream output;
    output << "graph \"";

    std::string mn_name;

    try {
      mn_name = this->property("name");
    } catch (NotFound&) { mn_name = "no_name"; }

    output << mn_name << "\" {" << std::endl;
    output << "  graph [bgcolor=transparent,label=\"" << mn_name << "\"];" << std::endl;
    output << "  node [style=filled fillcolor=\"#ffffaa\"];" << std::endl << std::endl;

    for (auto node: nodes())
      output << "  \"" << variable(node).name() << "\" [comment=\"" << node << ":"
             << variable(node).toStringWithDescription() << "\"];" << std::endl;

    output << std::endl;

    std::string tab = "  ";

    for (auto node: nodes()) {
      if (neighbours(node).size() > 0) {
        for (auto nei: neighbours(node)) {
          if (variable(node).name() < variable(nei).name()) {
            output << tab << "\"" << variable(node).name() << "\" -- "
                   << "\"" << variable(nei).name() << "\";" << std::endl;
          }
        }
      } else {
        output << tab << "\"" << variable(node).name() << "\";" << std::endl;
      }
    }

    output << "}" << std::endl;

    return output.str();
  }

Here is the call graph for this function:

toDotAsFactorGraph()

template<typename GUM_SCALAR >

std::string gum::IMarkovNet< GUM_SCALAR >::toDotAsFactorGraph ( ) const

virtual

Returns

Returns a dot representation of this IMarkovNet.

Definition at line 191 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    std::stringstream output;
    std::string       mn_name;
    try {
      mn_name = this->property("name");
    } catch (NotFound&) { mn_name = "no_name"; }

    output << "graph FG_" << mn_name << " {" << std::endl;
    output << "  layout=neato;" << std::endl;
    output << "  graph [bgcolor=transparent,label=\"factor graph for " << mn_name << "\"];"
           << std::endl;

    // the variables
    output << "  node [shape=rectangle,margin=0.04,width=0,height=0, "
              "style=filled,color=\"coral\"];"
           << std::endl;
    for (auto nod: nodes()) {
      output << "\"" << variable(nod).name() << "\";" << std::endl;
    }
    output << std::endl;

    // the factor
    output << "node[shape = point,width = 0.1,height = 0.1,style = filled,color = "
              "\"burlywood\"];"
           << std::endl;
    for (const auto& kv: factors()) {
      output << "  \"f";
      for (NodeId nod: kv.first) {
        output << "#" << variable(nod).name();
      }
      output << "\";" << std::endl;
    }

    // the link variable--factors
    output << "  edge[len = 0.7];" << std::endl;
    for (const auto& kv: factors()) {
      std::string clicname = "\"f";
      for (NodeId nod: kv.first) {
        clicname += "#";
        clicname += variable(nod).name();
      }
      clicname += "\"";

      for (NodeId nod: kv.first)
        output << "  " << clicname << " -- \"" << variable(nod).name() << "\";" << std::endl;
    }
    output << "}" << std::endl;

    return output.str();
  }

Here is the call graph for this function:

toString()

template<typename GUM_SCALAR >

INLINE std::string gum::IMarkovNet< GUM_SCALAR >::toString

(

)

const

Returns

Returns a string representation of this IMarkovNet.

Definition at line 128 of file IMarkovNet_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            {
    Size   param = 0;
    double dSize = log10DomainSize();

    for (auto factor: factors())
      param += factor.second->content()->realSize();

    std::stringstream s;
    s << "MN{nodes: " << size() << ", edges: " << graph().sizeEdges() << ", ";

    if (dSize > 6)
      s << "domainSize: 10^" << dSize;
    else
      s << "domainSize: " << std::round(std::pow(10.0, dSize));

    s << ", dim: " << param << "}";

    return s.str();
  }

Here is the call graph for this function:

variable()

template<typename GUM_SCALAR >

virtual const DiscreteVariable& gum::IMarkovNet< GUM_SCALAR >::variable ( NodeId  id ) const

pure virtual

Returns a constant reference over a variable given it's node id.

Exceptions

NotFound

If no variable's id matches varId.

Implements gum::GraphicalModel.

variableFromName()

template<typename GUM_SCALAR >

virtual const DiscreteVariable& gum::IMarkovNet< GUM_SCALAR >::variableFromName ( const std::string &  name ) const

pure virtual

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implements gum::GraphicalModel.

variableNodeMap()

template<typename GUM_SCALAR >

virtual const VariableNodeMap& gum::IMarkovNet< GUM_SCALAR >::variableNodeMap ( ) const

pure virtual

Returns a constant reference to the VariableNodeMap of thisBN.

Implements gum::GraphicalModel.

Member Data Documentation

graph_

UndiGraph gum::UGmodel::graph_

protectedinherited

The DAG of this Directed Graphical Model.

Definition at line 154 of file UGmodel.h.

---

The documentation for this class was generated from the following files:

• agrum/MN/IMarkovNet.h
• agrum/MN/IMarkovNet_tpl.h