gum::UGmodel Class Reference

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

#include <agrum/tools/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 More...
double	log10DomainSize () const
Constructors / Destructors
	UGmodel ()
	Default constructor. More...
virtual	~UGmodel ()
	Destructor. More...
	UGmodel (const UGmodel &source)
	Copy constructor. 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...
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...
Variable manipulation methods.
virtual const VariableNodeMap &	variableNodeMap () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model. More...
virtual bool	empty () const
	Return true if this graphical model is empty. 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...
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 Attributes
UndiGraph	graph_
	The DAG of this Directed Graphical Model. More...

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

Detailed Description

Virtual base class for PGMs using a undirected graph.

Definition at line 46 of file UGmodel.h.

Constructor & Destructor Documentation

UGmodel() [1/2]

gum::UGmodel::UGmodel

(

)

Default constructor.

Definition at line 29 of file UGmodel.cpp.

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

                   {
    GUM_CONSTRUCTOR(UGmodel);
    ;
  }

Here is the call graph for this function:

~UGmodel()

gum::UGmodel::~UGmodel ( )

virtual

Destructor.

Definition at line 36 of file UGmodel.cpp.

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

                    {
    GUM_DESTRUCTOR(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 34 of file UGmodel.cpp.

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

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

Here is the call graph for this function:

Member Function Documentation

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

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

finalvirtual

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

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

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:

graph()

INLINE const UndiGraph & gum::UGmodel::graph

(

)

const

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

)

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

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

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

finalvirtual

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

finalvirtual

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

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

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

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

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

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

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

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

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

protected

Private copy operator.

Definition at line 41 of file UGmodel.cpp.

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

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

    return *this;
  }

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

finalvirtual

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

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:

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::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 virtualinherited

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 virtualinherited

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

graph_

UndiGraph gum::UGmodel::graph_

protected

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/tools/graphicalModels/UGmodel.h
• agrum/tools/graphicalModels/UGmodel.cpp
• agrum/tools/graphicalModels/UGmodel_inl.h