Virtual base class for PGMs using a undirected graph. More...

#include <agrum/base/graphicalModels/UGmodel.h>

Inheritance diagram for gum::UGmodel:

Collaboration diagram for gum::UGmodel:

Public Member Functions
bool	hasSameStructure (const UGmodel &other)
	check if nodes X and nodes Y are independent given nodes Z
NodeSet	family (const NodeId id) const final
	returns the the node as a NodeSet (in mixed graph : family is the node and its parents
NodeSet	family (const std::string &name) const final
double	log10DomainSize () const
Constructors / Destructors
	UGmodel ()
	Default constructor.
virtual	~UGmodel ()
	Destructor.
	UGmodel (const UGmodel &source)
	Copy constructor.
Variable manipulation methods.
const UndiGraph &	graph () const
	Returns a constant reference to the dag of this Bayes Net.
virtual Size	size () const final
	Returns the number of variables in this Directed Graphical Model.
Size	sizeEdges () const
	Returns the number of arcs in this Directed Graphical Model.
const NodeGraphPart &	nodes () const final
	Returns a constant reference to the dag of this Bayes Net.
bool	exists (NodeId node) const final
	Return true if this node exists in this graphical model.
bool	exists (const std::string &name) const final
	Returns a constant reference to the dag of this Bayes Net.
Edge manipulation methods.
const EdgeSet &	edges () const
	return true if the edge node1-node2 exists in the UGModel
bool	existsEdge (const NodeId node1, const NodeId node2) const
	return true if the edge node1-node2 exists in the UGModel
bool	existsEdge (const std::string &name1, const std::string &name2) const
	return true if the edge node1-node2 exists in the UGModel
const NodeSet &	neighbours (const NodeId id) const
	returns the neighbours of a node as set of nodes
const NodeSet &	neighbours (const std::string &name) const
	return true if the edge node1-node2 exists in the UGModel
bool	isIndependent (NodeId X, NodeId Y, const NodeSet &Z) const final
	check if X and Y are independent given Z
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
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
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
Getter and setters
const std::string &	property (const std::string &name) const
	Return the value of the property name of this GraphicalModel.
const std::string &	propertyWithDefault (const std::string &name, const std::string &byDefault) const
	Return the value of the property name of this GraphicalModel.
void	setProperty (const std::string &name, const std::string &value)
	Add or change a property of this GraphicalModel.
std::vector< std::string >	properties () const
	List of all the properties.
Variable manipulation methods.
virtual const VariableNodeMap &	variableNodeMap () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model.
virtual bool	empty () const
	Return true if this graphical model is empty.
std::vector< std::string >	names (const std::vector< NodeId > &ids) const
	transform a vector of NodeId in a vector of names
std::vector< std::string >	names (const NodeSet &ids) const
	transform a NodeSet in a vector of names
std::vector< NodeId >	ids (const std::vector< std::string > &names) const
	transform a vector of names into a vector of nodeId
NodeSet	nodeset (const std::vector< std::string > &names) const
	transform a vector of names into a NodeSet
gum::VariableSet	variables (const std::vector< std::string > &l) const
	transform a vector of names into a VariableeSet
gum::VariableSet	variables (const NodeSet &ids) const
	transform a vector of NodeId into a VariableeSet
Instantiation	completeInstantiation () const
	Get an instantiation over all the variables of the model.
virtual const DiscreteVariable &	variable (NodeId id) const =0
	Returns a constant reference over a variable given it's node id.
virtual NodeId	nodeId (const DiscreteVariable &var) const =0
	Return id node src discrete var pointer.
virtual NodeId	idFromName (const std::string &name) const =0
	Getter by name.
virtual const DiscreteVariable &	variableFromName (const std::string &name) const =0
	Getter by name.

Static Public Member Functions
static void	spaceCplxToStream (std::stringstream &s, double dSize, int dim, Size usedMem)
	send to the stream the space complexity with 3 parametrs

Protected Member Functions
UGmodel &	operator= (const UGmodel &source)
	Private copy operator.

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

Private Member Functions
const HashTable< std::string, std::string > &	_properties_ () const
	Return the properties of this Directed Graphical Model.

Private Attributes
HashTable< std::string, std::string >	_propertiesMap_
	The properties of this Directed Graphical Model.

Detailed Description

Virtual base class for PGMs using a undirected graph.

Definition at line 64 of file UGmodel.h.

Constructor & Destructor Documentation

◆ UGmodel() [1/2]

gum::UGmodel::UGmodel ( )

Default constructor.

Definition at line 49 of file UGmodel.cpp.

                   {
    GUM_CONSTRUCTOR(UGmodel);
    ;
  }

References UGmodel().

Referenced by gum::IMarkovRandomField< GUM_SCALAR >::IMarkovRandomField(), gum::IMarkovRandomField< GUM_SCALAR >::IMarkovRandomField(), gum::IMarkovRandomField< GUM_SCALAR >::IMarkovRandomField(), UGmodel(), UGmodel(), ~UGmodel(), hasSameStructure(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~UGmodel()

gum::UGmodel::~UGmodel ( )

virtual

Destructor.

Definition at line 56 of file UGmodel.cpp.

                    {
    GUM_DESTRUCTOR(UGmodel);
    ;
  }

References UGmodel().

Here is the call graph for this function:

◆ UGmodel() [2/2]

gum::UGmodel::UGmodel ( const UGmodel & source )

Copy constructor.

Do nothing.

Definition at line 54 of file UGmodel.cpp.

54: graph_(from.graph_) { GUM_CONS_CPY(UGmodel); }

gum::UGmodel::graph_

UndiGraph graph_

The DAG of this Directed Graphical Model.

Definition UGmodel.h:182

References UGmodel(), and graph_.

Here is the call graph for this function:

Member Function Documentation

◆ _properties_()

INLINE const HashTable< std::string, std::string > & gum::GraphicalModel::_properties_ ( ) const

privateinherited

Return the properties of this Directed Graphical Model.

Definition at line 70 of file graphicalModel_inl.h.

                                                                              {
    return _propertiesMap_;
  }

References _propertiesMap_.

Referenced by property().

Here is the caller 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 106 of file graphicalModel_inl.h.

                                                            {
    Instantiation I;
 
    for (const auto node: nodes())
      I << variable(node);
 
    return I;
  }

References nodes().

Here is the call graph for this function:

◆ edges()

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

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 65 of file UGmodel_inl.h.

65{ return graph_.edges(); }

References graph_.

Referenced by hasSameStructure().

Here is the caller graph for this function:

◆ empty()

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

virtualinherited

Return true if this graphical model is empty.

Definition at line 116 of file graphicalModel_inl.h.

116{ return size() == 0; }

gum::GraphicalModel::size

virtual Size size() const =0

Returns the number of variables in this Directed Graphical Model.

References size().

Referenced by gum::IBayesNet< GUM_SCALAR >::check(), and gum::BayesNet< GUM_SCALAR >::clear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists() [1/2]

INLINE bool gum::UGmodel::exists ( const std::string & name ) const

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 83 of file UGmodel_inl.h.

                                                         {
    try {
      return exists(idFromName(name));
    } catch ([[maybe_unused]] gum::NotFound& e) { return false; }
  }

References exists(), and gum::GraphicalModel::idFromName().

Here is the call graph for this function:

◆ exists() [2/2]

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

finalvirtual

Return true if this node exists in this graphical model.

Implements gum::GraphicalModel.

Definition at line 81 of file UGmodel_inl.h.

81{ return graph_.exists(node); }

References graph_.

Referenced by exists().

Here is the caller graph for this function:

◆ existsEdge() [1/2]

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

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 67 of file UGmodel_inl.h.

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

References graph_.

Referenced by existsEdge().

Here is the caller graph for this function:

◆ existsEdge() [2/2]

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

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 71 of file UGmodel_inl.h.

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

References existsEdge(), and gum::GraphicalModel::idFromName().

Here is the call graph for this function:

◆ family() [1/2]

INLINE NodeSet gum::UGmodel::family ( const NodeId id ) const

finalvirtual

returns the the node as a NodeSet (in mixed graph : family is the node and its parents

Parameters

id	the node which is the head of an arc with the returned nodes
name	the name of the node the node which is the head of an arc with the returned nodes

Implements gum::GraphicalModel.

Definition at line 99 of file UGmodel_inl.h.

                                                      {
    // family is the set of the note and its parent. So for a completely undirected model, it is
    // just the node.
    return gum::NodeSet{id};
  }

Referenced by family().

Here is the caller graph for this function:

◆ family() [2/2]

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

finalvirtual

Implements gum::GraphicalModel.

Definition at line 105 of file UGmodel_inl.h.

105{ return family(idFromName(name)); }

gum::UGmodel::family

NodeSet family(const NodeId id) const final

returns the the node as a NodeSet (in mixed graph : family is the node and its parents

Definition UGmodel_inl.h:99

References family(), and gum::GraphicalModel::idFromName().

Here is the call graph for this function:

◆ graph()

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

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

Definition at line 57 of file UGmodel_inl.h.

57{ return graph_; }

References graph_.

Referenced by gum::MarginalTargetedMRFInference< GUM_SCALAR >::MarginalTargetedMRFInference(), isIndependent(), isIndependent(), size(), and gum::IMarkovRandomField< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ hasSameStructure()

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

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 70 of file UGmodel.cpp.

                                                     {
    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 const&) { 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;
  }

References UGmodel(), edges(), gum::Set< Key >::exists(), gum::GraphicalModel::idFromName(), nodes(), size(), sizeEdges(), and gum::GraphicalModel::variable().

Here is the call graph for this function:

◆ idFromName()

virtual NodeId gum::GraphicalModel::idFromName ( const std::string & name ) const

pure virtualinherited

Getter by name.

Exceptions

NotFound if no such name exists in the graph.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::BayesNetFragment< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::IMarkovRandomField< GUM_SCALAR >, gum::InfluenceDiagram< GUM_SCALAR >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Referenced by gum::DAGmodel::ancestors(), gum::DAGmodel::children(), gum::IBayesNet< double >::children(), gum::DAGmodel::descendants(), gum::UGmodel::exists(), gum::DAGmodel::existsArc(), gum::UGmodel::existsEdge(), gum::DAGmodel::family(), gum::UGmodel::family(), gum::DAGmodel::hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), gum::UGmodel::hasSameStructure(), gum::DAGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::UGmodel::neighbours(), nodeset(), and gum::DAGmodel::parents().

Here is the caller graph for this function:

◆ 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 139 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;
  }

References names().

Referenced by gum::DAGmodel::children(), exists(), names(), and gum::DAGmodel::parents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIndependent() [1/4]

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 95 of file UGmodel_inl.h.

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

References graph(), and gum::EdgeGraphPart::hasUndirectedPath().

Here is the call graph for this function:

◆ isIndependent() [2/4]

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

inline

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 144 of file UGmodel.h.

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

References gum::GraphicalModel::idFromName(), isIndependent(), and gum::GraphicalModel::nodeset().

Here is the call graph for this function:

◆ isIndependent() [3/4]

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

inline

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 150 of file UGmodel.h.

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

References isIndependent(), and gum::GraphicalModel::nodeset().

Here is the call graph for this function:

◆ isIndependent() [4/4]

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

finalvirtual

check if X and Y are independent given Z

Implements gum::GraphicalModel.

Definition at line 91 of file UGmodel_inl.h.

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

References graph(), and gum::EdgeGraphPart::hasUndirectedPath().

Referenced by isIndependent(), and isIndependent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ log10DomainSize()

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

inherited

Definition at line 95 of file graphicalModel_inl.h.

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

References nodes().

Referenced by gum::IBayesNet< GUM_SCALAR >::toString(), gum::IMarkovRandomField< GUM_SCALAR >::toString(), and gum::InfluenceDiagram< GUM_SCALAR >::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ names() [1/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 129 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;
  }

◆ names() [2/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 119 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;
  }

References ids(), and variableNodeMap().

Referenced by gum::DAGmodel::children(), exists(), ids(), nodeset(), and gum::DAGmodel::parents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ neighbours() [1/2]

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

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 75 of file UGmodel_inl.h.

75{ return graph_.neighbours(id); }

References graph_.

Referenced by neighbours(), and gum::IMarkovRandomField< GUM_SCALAR >::toDot().

Here is the caller graph for this function:

◆ neighbours() [2/2]

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

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 77 of file UGmodel_inl.h.

                                                                       {
    return neighbours(idFromName(name));
  }

References gum::GraphicalModel::idFromName(), and neighbours().

Here is the call graph for this function:

◆ nodeId()

virtual NodeId gum::GraphicalModel::nodeId ( const DiscreteVariable & var ) const

pure virtualinherited

Return id node src discrete var pointer.

Exceptions

NotFound If no variable matches var.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::BayesNetFragment< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::IMarkovRandomField< GUM_SCALAR >, gum::InfluenceDiagram< GUM_SCALAR >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

◆ nodes()

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 89 of file UGmodel_inl.h.

89{ return (NodeGraphPart&)graph_; }

References graph_.

Referenced by hasSameStructure(), gum::IMarkovRandomField< GUM_SCALAR >::maxVarDomainSize(), gum::IMarkovRandomField< GUM_SCALAR >::operator==(), gum::IMarkovRandomField< GUM_SCALAR >::toDot(), and gum::IMarkovRandomField< GUM_SCALAR >::toDotAsFactorGraph().

Here is the caller 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 60 of file graphicalModel.cpp.

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

References idFromName(), gum::Set< Key >::insert(), and names().

Referenced by gum::IBayesNet< double >::children(), gum::IBayesNet< double >::children(), gum::DAGmodel::isIndependent(), gum::DAGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::DAGmodel::moralizedAncestralGraph(), and gum::DAGmodel::parents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

UGmodel & gum::UGmodel::operator= ( const UGmodel & source )

protected

Private copy operator.

Definition at line 61 of file UGmodel.cpp.

                                                 {
    if (this != &source) {
      GraphicalModel::operator=(source);
      graph_ = source.graph_;
    }
 
    return *this;
  }

References UGmodel(), graph_, and gum::GraphicalModel::operator=().

Referenced by gum::IMarkovRandomField< GUM_SCALAR >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ properties()

INLINE std::vector< std::string > gum::GraphicalModel::properties ( ) const

inherited

List of all the properties.

Definition at line 81 of file graphicalModel_inl.h.

                                                          {
    std::vector< std::string > prop;
    for (const auto& [p, v]: _propertiesMap_)
      prop.push_back(p);
    return prop;
  }

References _propertiesMap_.

◆ 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 60 of file graphicalModel_inl.h.

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

References _properties_(), and GUM_ERROR.

Referenced by gum::IMarkovRandomField< GUM_SCALAR >::toDot(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), and gum::IMarkovRandomField< GUM_SCALAR >::toDotAsFactorGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 75 of file graphicalModel_inl.h.

                                                                                           {
    return (_propertiesMap_.exists(name)) ? _propertiesMap_[name] : byDefault;
  }

References _propertiesMap_.

◆ 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 89 of file graphicalModel_inl.h.

                                                                                {
    if (_propertiesMap_.exists(name)) _propertiesMap_[name] = value;
    else _propertiesMap_.insert(name, value);
  }

References _propertiesMap_.

Referenced by gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::IMarkovRandomField< GUM_SCALAR >::IMarkovRandomField(), and gum::InfluenceDiagram< GUM_SCALAR >::fastPrototype().

Here is the caller graph for this function:

◆ size()

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

finalvirtual

Returns the number of variables in this Directed Graphical Model.

Implements gum::GraphicalModel.

Definition at line 60 of file UGmodel_inl.h.

60{ return graph().size(); }

gum::NodeGraphPart::size

Size size() const

alias for sizeNodes

Definition nodeGraphPart_inl.h:288

References graph(), and gum::NodeGraphPart::size().

Referenced by hasSameStructure(), gum::IMarkovRandomField< GUM_SCALAR >::operator==(), gum::IMarkovRandomField< GUM_SCALAR >::toDot(), and gum::IMarkovRandomField< GUM_SCALAR >::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sizeEdges()

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

Returns the number of arcs in this Directed Graphical Model.

Definition at line 63 of file UGmodel_inl.h.

63{ return graph_.sizeEdges(); }

References graph_.

Referenced by hasSameStructure(), and gum::IMarkovRandomField< GUM_SCALAR >::operator==().

Here is the caller graph for this function:

◆ spaceCplxToStream()

void gum::GraphicalModel::spaceCplxToStream	(	std::stringstream &	s,
		double	dSize,
		int	dim,
		Size	usedMem )

staticinherited

send to the stream the space complexity with 3 parametrs

Parameters

s	the stream
dSize	the log10domainSize
dim	the dimension
usedMem	the memory needed for the params

Definition at line 69 of file graphicalModel.cpp.

                                                                                               {
    if (dSize > 6) s << "domainSize: 10^" << dSize;
    else s << "domainSize: " << std::round(std::pow(10.0, dSize));
 
    s << ", dim: " << dim << ", mem: ";
 
    if (const Size go = usedMem / (1024 * 1024 * 1024); go > 0) s << go << "Go ";
    if (const Size mo = (usedMem / (1024 * 1024)) % 1024; mo > 0) s << mo << "Mo ";
    if (const Size ko = (usedMem / 1024) % 1024; ko > 0) s << ko << "Ko ";
    s << usedMem % 1024 << "o";
  }

Referenced by gum::IBayesNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ variable()

virtual const DiscreteVariable & gum::GraphicalModel::variable ( NodeId id ) const

pure virtualinherited

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

Exceptions

NotFound If no variable's id matches varId.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::BayesNetFragment< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::IMarkovRandomField< GUM_SCALAR >, gum::InfluenceDiagram< GUM_SCALAR >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Referenced by gum::DAGmodel::hasSameStructure(), and gum::UGmodel::hasSameStructure().

Here is the caller graph for this function:

◆ variableFromName()

virtual const DiscreteVariable & gum::GraphicalModel::variableFromName ( const std::string & name ) const

pure virtualinherited

Getter by name.

Exceptions

NotFound if no such name exists in the graph.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::BayesNetFragment< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::IMarkovRandomField< GUM_SCALAR >, gum::InfluenceDiagram< GUM_SCALAR >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

◆ variableNodeMap()

virtual const VariableNodeMap & gum::GraphicalModel::variableNodeMap ( ) const

pure virtualinherited

Returns a constant reference to the VariableNodeMap of this Graphical Model.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::BayesNetFragment< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::IMarkovRandomField< GUM_SCALAR >, gum::InfluenceDiagram< GUM_SCALAR >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Referenced by gum::IBayesNet< double >::empty(), names(), variables(), and variables().

Here is the caller graph for this function:

◆ variables() [1/2]

INLINE VariableSet gum::GraphicalModel::variables ( const NodeSet & ids ) const

inherited

transform a vector of NodeId into a VariableeSet

Returns: NodeSet

Definition at line 160 of file graphicalModel_inl.h.

                                                              {
    VariableSet            s;
    const VariableNodeMap& v = variableNodeMap();
    for (const auto& node: l) {
      s.insert(&v.get(node));
    }
    return s;
  }

References gum::VariableNodeMap::get(), gum::Set< Key >::insert(), and variableNodeMap().

Here is the call graph for this function:

◆ variables() [2/2]

INLINE VariableSet gum::GraphicalModel::variables ( const std::vector< std::string > & l ) const

inherited

transform a vector of names into a VariableeSet

Returns: NodeSet

Definition at line 150 of file graphicalModel_inl.h.

                                                                             {
    VariableSet            s;
    const VariableNodeMap& v = variableNodeMap();
    for (const auto& name: l) {
      s.insert(&v.variableFromName(name));
    }
    return s;
  }

References variableNodeMap().

Here is the call graph for this function:

Member Data Documentation

◆ _propertiesMap_

HashTable< std::string, std::string > gum::GraphicalModel::_propertiesMap_

privateinherited

The properties of this Directed Graphical Model.

Definition at line 236 of file graphicalModel.h.

Referenced by _properties_(), operator=(), properties(), propertyWithDefault(), and setProperty().

◆ graph_

UndiGraph gum::UGmodel::graph_

protected

The DAG of this Directed Graphical Model.

Definition at line 182 of file UGmodel.h.

Referenced by UGmodel(), gum::IMarkovRandomField< GUM_SCALAR >::_minimalCondSetVisit_(), edges(), exists(), existsEdge(), graph(), gum::IMarkovRandomField< GUM_SCALAR >::minimalCondSet(), neighbours(), nodes(), operator=(), and sizeEdges().

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

agrum/base/graphicalModels/UGmodel.h
agrum/base/graphicalModels/UGmodel.cpp
agrum/base/graphicalModels/UGmodel_inl.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UGmodel() [1/2]

◆ ~UGmodel()

◆ UGmodel() [2/2]

Member Function Documentation

◆ _properties_()

◆ completeInstantiation()

◆ edges()

◆ empty()

◆ exists() [1/2]

◆ exists() [2/2]

◆ existsEdge() [1/2]

◆ existsEdge() [2/2]

◆ family() [1/2]

◆ family() [2/2]

◆ graph()

◆ hasSameStructure()

◆ idFromName()

◆ ids()

◆ isIndependent() [1/4]

◆ isIndependent() [2/4]

◆ isIndependent() [3/4]

◆ isIndependent() [4/4]

◆ log10DomainSize()

◆ names() [1/2]

◆ names() [2/2]

◆ neighbours() [1/2]

◆ neighbours() [2/2]

◆ nodeId()

◆ nodes()

◆ nodeset()

◆ operator=()

◆ properties()

◆ property()

◆ propertyWithDefault()

◆ setProperty()

◆ size()

◆ sizeEdges()

◆ spaceCplxToStream()

◆ variable()

◆ variableFromName()

◆ variableNodeMap()

◆ variables() [1/2]

◆ variables() [2/2]

Member Data Documentation

◆ _propertiesMap_

◆ graph_