gum::GraphicalModel Class Reference

Virtual base class for probabilistic graphical models. More...

#include <graphicalModel.h>

Inheritance diagram for gum::GraphicalModel:

Collaboration diagram for gum::GraphicalModel:

Public Member Functions
double	log10DomainSize () const
virtual bool	isIndependent (NodeId X, NodeId Y, const NodeSet &Z) const =0
	check if node X and node Y are independent given nodes Z
virtual bool	isIndependent (const NodeSet &X, const NodeSet &Y, const NodeSet &Z) const =0
	check if nodes X and nodes Y are independent given nodes Z
virtual NodeSet	family (const NodeId id) const =0
	returns the family of a noe (parents or neighbours) of a node and the node
virtual NodeSet	family (const std::string &name) const =0
Constructors / Destructors
	GraphicalModel ()
	Default constructor.
virtual	~GraphicalModel ()
	Destructor.
	GraphicalModel (const GraphicalModel &source)
	Copy constructor.
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 Size	size () const =0
	Returns the number of variables in this Directed Graphical Model.
virtual bool	empty () const
	Return true if this graphical model is empty.
virtual bool	exists (NodeId node) const =0
	Return true if this node exists in this graphical model.
virtual bool	exists (const std::string &name) const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model.
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
virtual const NodeGraphPart &	nodes () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model.
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
GraphicalModel &	operator= (const GraphicalModel &source)
	Private copy operator.

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 probabilistic graphical models.

Definition at line 65 of file graphicalModel.h.

Constructor & Destructor Documentation

GraphicalModel() [1/2]

gum::GraphicalModel::GraphicalModel

(

)

Default constructor.

Definition at line 49 of file graphicalModel.cpp.

{ GUM_CONSTRUCTOR(GraphicalModel) }

References GraphicalModel().

Referenced by GraphicalModel(), GraphicalModel(), ~GraphicalModel(), family(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

~GraphicalModel()

gum::GraphicalModel::~GraphicalModel ( )

virtual

Destructor.

Definition at line 53 of file graphicalModel.cpp.

{ GUM_DESTRUCTOR(GraphicalModel); }

References GraphicalModel().

Here is the call graph for this function:

GraphicalModel() [2/2]

gum::GraphicalModel::GraphicalModel

(

const GraphicalModel &

source

)

Copy constructor.

Do nothing.

Definition at line 51 of file graphicalModel.cpp.

{ GUM_CONS_CPY(GraphicalModel); }

References GraphicalModel().

Here is the call graph for this function:

Member Function Documentation

_properties_()

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

private

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

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:

empty()

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

virtual

Return true if this graphical model is empty.

Definition at line 116 of file graphicalModel_inl.h.

{ return size() == 0; }

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]

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

pure virtual

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

Implemented in gum::DAGmodel, and gum::UGmodel.

References ids(), and names().

Here is the call graph for this function:

exists() [2/2]

virtual bool gum::GraphicalModel::exists ( NodeId node ) const

pure virtual

Return true if this node exists in this graphical model.

Implemented in gum::DAGmodel, and gum::UGmodel.

family() [1/2]

virtual NodeSet gum::GraphicalModel::family ( const NodeId id ) const

pure virtual

returns the family of a noe (parents or neighbours) of a node and the node

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

Implemented in gum::DAGmodel, and gum::UGmodel.

family() [2/2]

virtual NodeSet gum::GraphicalModel::family ( const std::string & name ) const

pure virtual

Implemented in gum::DAGmodel, and gum::UGmodel.

References GraphicalModel().

Here is the call graph for this function:

idFromName()

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

pure virtual

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

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/2]

virtual bool gum::GraphicalModel::isIndependent ( const NodeSet & X, const NodeSet & Y, const NodeSet & Z ) const

pure virtual

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

Implemented in gum::DAGmodel, and gum::UGmodel.

isIndependent() [2/2]

virtual bool gum::GraphicalModel::isIndependent ( NodeId X, NodeId Y, const NodeSet & Z ) const

pure virtual

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

Implemented in gum::DAGmodel, and gum::UGmodel.

log10DomainSize()

INLINE double gum::GraphicalModel::log10DomainSize

(

)

const

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

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

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:

nodeId()

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

pure virtual

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()

virtual const NodeGraphPart & gum::GraphicalModel::nodes ( ) const

pure virtual

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

Implemented in gum::DAGmodel, and gum::UGmodel.

Referenced by completeInstantiation(), and log10DomainSize().

Here is the caller graph for this function:

nodeset()

NodeSet gum::GraphicalModel::nodeset

(

const std::vector< std::string > &

names

)

const

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=()

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

protected

Private copy operator.

Definition at line 55 of file graphicalModel.cpp.

                                                                      {
    if (this != &source) { _propertiesMap_ = source._propertiesMap_; }
    return *this;
  }

References GraphicalModel(), and _propertiesMap_.

Referenced by gum::DAGmodel::operator=(), and gum::UGmodel::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

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

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

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 )

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()

virtual Size gum::GraphicalModel::size ( ) const

pure virtual

Returns the number of variables in this Directed Graphical Model.

Implemented in gum::DAGmodel, and gum::UGmodel.

Referenced by empty().

Here is the caller graph for this function:

spaceCplxToStream()

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

static

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 virtual

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 virtual

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 virtual

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

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

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_

private

The properties of this Directed Graphical Model.

Definition at line 236 of file graphicalModel.h.

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

---

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

• agrum/base/graphicalModels/graphicalModel.h
• agrum/base/graphicalModels/graphicalModel.cpp
• agrum/base/graphicalModels/graphicalModel_inl.h