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
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
	Retursn true if this Directed Graphical Model is empty. 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 48 of file graphicalModel.h.

Constructor & Destructor Documentation

GraphicalModel() [1/2]

gum::GraphicalModel::GraphicalModel

(

)

Default constructor.

Definition at line 30 of file graphicalModel.cpp.

                                 : __propertiesMap(nullptr) {
    GUM_CONSTRUCTOR(GraphicalModel);
  }

~GraphicalModel()

gum::GraphicalModel::~GraphicalModel ( )

virtual

Destructor.

Definition at line 44 of file graphicalModel.cpp.

References __propertiesMap.

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

GraphicalModel() [2/2]

gum::GraphicalModel::GraphicalModel

(

const GraphicalModel &

source

)

Copy constructor.

Do nothing.

Definition at line 34 of file graphicalModel.cpp.

References __propertiesMap.

                                                           :
      __propertiesMap(nullptr) {
    GUM_CONS_CPY(GraphicalModel);

    if (from.__propertiesMap) {
      __propertiesMap =
         new HashTable< std::string, std::string >(*(from.__propertiesMap));
    }
  }

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

References __propertiesMap.

Referenced by property(), propertyWithDefault(), and setProperty().

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

    return *__propertiesMap;
  }

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

References nodes(), and variable().

                                                            {
    Instantiation I;

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

    return I;
  }

Here is the call graph for this function:

empty()

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

virtual

Retursn true if this Directed Graphical Model is empty.

Definition at line 95 of file graphicalModel_inl.h.

References size().

{ return size() == 0; }

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

log10DomainSize()

INLINE double gum::GraphicalModel::log10DomainSize

(

)

const

Definition at line 74 of file graphicalModel_inl.h.

References nodes(), and variable().

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

                                               {
    double dSize = 0.0;

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

    return dSize;
  }

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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, gum::DAGmodel, gum::UGmodel, 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:

operator=()

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

protected

Private copy operator.

Definition at line 49 of file graphicalModel.cpp.

References __propertiesMap.

Referenced by gum::UGmodel::operator=(), and gum::DAGmodel::operator=().

                                                                        {
    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 caller 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 37 of file graphicalModel_inl.h.

References __properties(), and GUM_ERROR.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::toDot().

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

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

References __properties().

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

Here is the call graph for this function:

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.

References __properties(), and gum::HashTable< Key, Val, Alloc >::insert().

Referenced by gum::BayesNet< double >::fastPrototype(), and gum::IMarkovNet< GUM_SCALAR >::IMarkovNet().

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

Here is the call graph for this function:

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:

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 >, gum::DAGmodel, gum::UGmodel, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Referenced by completeInstantiation(), and log10DomainSize().

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::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, gum::DAGmodel, gum::UGmodel, 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::IMarkovNet< GUM_SCALAR >, gum::InfluenceDiagram< 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 148 of file graphicalModel.h.

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

---

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