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 More...

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 More...

Constructors / Destructors
	GraphicalModel ()
	Default constructor. More...

virtual	~GraphicalModel ()
	Destructor. More...

	GraphicalModel (const GraphicalModel &source)
	Copy constructor. 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...

Variable manipulation methods.
virtual const VariableNodeMap &	variableNodeMap () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model. More...

virtual Size	size () const =0
	Returns the number of variables in this Directed Graphical Model. More...

virtual bool	empty () const
	Return true if this graphical model is empty. More...

virtual bool	exists (NodeId node) const =0
	Return true if this node exists in this graphical model. More...

bool	exists (const std::string &name) 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...

virtual const NodeGraphPart &	nodes () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model. More...

Instantiation	completeInstantiation () const
	Get an instantiation over all the variables of the model. 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 src 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...

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

Detailed Description

Virtual base class for probabilistic graphical models.

Definition at line 47 of file graphicalModel.h.

Constructor & Destructor Documentation

◆ GraphicalModel() [1/2]

gum::GraphicalModel::GraphicalModel ( )

Default constructor.

Definition at line 29 of file graphicalModel.cpp.

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

29 : _propertiesMap_(nullptr) { GUM_CONSTRUCTOR(GraphicalModel); }

gum::GraphicalModel::_propertiesMap_

HashTable< std::string, std::string > * _propertiesMap_

The properties of this Directed Graphical Model. Initialized using a lazy instantiation.

Definition: graphicalModel.h:184

gum::GraphicalModel::GraphicalModel

GraphicalModel()

Default constructor.

Definition: graphicalModel.cpp:29

Here is the call graph for this function:

◆ ~GraphicalModel()

gum::GraphicalModel::~GraphicalModel ( )

virtual

Destructor.

Definition at line 39 of file graphicalModel.cpp.

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

                                   {
     GUM_DESTRUCTOR(GraphicalModel);
     if (_propertiesMap_) { delete _propertiesMap_; }
   }

Here is the call graph for this function:

◆ GraphicalModel() [2/2]

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

Copy constructor.

Do nothing.

Definition at line 31 of file graphicalModel.cpp.

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

                                                            : _propertiesMap_(nullptr) {
     GUM_CONS_CPY(GraphicalModel);
 
     if (from._propertiesMap_) {
       _propertiesMap_ = new HashTable< std::string, std::string >(*(from._propertiesMap_));
     }
   }

Here is the call graph for this function:

Member Function Documentation

◆ _properties_()

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

private

Return the properties of this Directed Graphical Model and initialize the hash table is necessary.

Definition at line 48 of file graphicalModel_inl.h.

                                                                         {
     if (_propertiesMap_ == nullptr) {
       _propertiesMap_ = new HashTable< std::string, std::string >();
     }
 
     return *_propertiesMap_;
   }

◆ completeInstantiation()

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

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

◆ empty()

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

virtual

Return true if this graphical model is empty.

Definition at line 94 of file graphicalModel_inl.h.

94 { return size() == 0; }

gum::GraphicalModel::size

virtual Size size() const =0

Returns the number of variables in this Directed Graphical Model.

◆ exists() [1/2]

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

pure virtual

Return true if this node exists in this graphical model.

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

◆ exists() [2/2]

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

inline

Return true if this graphical model is empty.

Definition at line 112 of file graphicalModel.h.

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

gum::GraphicalModel::exists

virtual bool exists(NodeId node) const =0

Return true if this node exists in this graphical model.

gum::GraphicalModel::idFromName

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

Getter by name.

◆ 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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

◆ 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 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/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.

◆ isIndependent() [2/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.

◆ log10DomainSize()

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

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

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

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

◆ 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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, 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::UGmodel, and gum::DAGmodel.

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

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

protected

Private copy operator.

Definition at line 44 of file graphicalModel.cpp.

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

                                                                         {
     if (this != &source) {
       if (_propertiesMap_) {
         delete _propertiesMap_;
         _propertiesMap_ = nullptr;
       }
 
       if (source._propertiesMap_ != 0) {
         _propertiesMap_ = new HashTable< std::string, std::string >(*(source._propertiesMap_));
       }
     }
     return *this;
   }

Here is the call graph for this function:

◆ 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 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

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
	)

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

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

pure virtual

Returns the number of variables in this Directed Graphical Model.

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

◆ 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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

◆ 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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, 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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Member Data Documentation

◆ _propertiesMap_

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

mutableprivate

The properties of this Directed Graphical Model. Initialized using a lazy instantiation.

Definition at line 184 of file graphicalModel.h.

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

agrum/tools/graphicalModels/graphicalModel.h
agrum/tools/graphicalModels/graphicalModel.cpp
agrum/tools/graphicalModels/graphicalModel_inl.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GraphicalModel() [1/2]

◆ ~GraphicalModel()

◆ GraphicalModel() [2/2]

Member Function Documentation

◆ _properties_()

◆ completeInstantiation()

◆ empty()

◆ exists() [1/2]

◆ exists() [2/2]

◆ idFromName()

◆ ids()

◆ isIndependent() [1/2]

◆ isIndependent() [2/2]

◆ log10DomainSize()

◆ names() [1/2]

◆ names() [2/2]

◆ nodeId()

◆ nodes()

◆ nodeset()

◆ operator=()

◆ property()

◆ propertyWithDefault()

◆ setProperty()

◆ size()

◆ variable()

◆ variableFromName()

◆ variableNodeMap()

Member Data Documentation

◆ _propertiesMap_