Virtual base class for PGMs using a DAG. More...

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

Inheritance diagram for gum::DAGmodel:

Collaboration diagram for gum::DAGmodel:

Public Member Functions
bool	hasSameStructure (const DAGmodel &other) const
NodeSet	minimalCondSet (NodeId target, const NodeSet &soids) const
NodeSet	minimalCondSet (const NodeSet &targets, const NodeSet &soids) const
NodeSet	minimalCondSet (std::string_view target, const std::vector< std::string > &soids) const
NodeSet	minimalCondSet (const std::vector< std::string > &targets, const std::vector< std::string > &soids) const
const DAG &	internalDag () const
	Returns a const reference to the internal (unnamed) DAG. O(1), no copy. Use for stable references or pointers (e.g. graph listeners). For named node access, use dag() instead.
double	log10DomainSize () const
Constructors / Destructors
	DAGmodel ()
	Default constructor.
	~DAGmodel () override
	Destructor.
	DAGmodel (const DAGmodel &source)
	Copy constructor.
	DAGmodel (DAGmodel &&source) noexcept
	Move constructor.
Variable manipulation methods.
DAG	dag () const
	Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.
Size	size () const final
	Returns the number of variables in this Directed Graphical Model.
Size	sizeArcs () const
	Returns the number of arcs in this Directed Graphical Model.
const NodeGraphPart &	nodes () const final
	Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.
bool	exists (NodeId node) const final
	Return true if this node exists in this graphical model.
bool	exists (std::string_view name) const final
	Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.
Arc manipulation methods.
const ArcSet &	arcs () const
	return true if the arc tail->head exists in the DAGmodel
bool	existsArc (const NodeId tail, const NodeId head) const
	return true if the arc tail->head exists in the DAGmodel
bool	existsArc (std::string_view nametail, std::string_view namehead) const
	return true if the arc tail->head exists in the DAGmodel
const NodeSet &	parents (const NodeId id) const
	returns the set of nodes with arc ingoing to a given node
const NodeSet &	parents (std::string_view name) const
	return true if the arc tail->head exists in the DAGmodel
NodeSet	parents (const NodeSet &ids) const
	returns the parents of a set of nodes
NodeSet	parents (const std::vector< std::string > &names) const
	return true if the arc tail->head exists in the DAGmodel
NodeSet	family (const NodeId id) const final
	returns the parents of a node and the node
NodeSet	family (std::string_view name) const final
	return true if the arc tail->head exists in the DAGmodel
const NodeSet &	children (const NodeId id) const
	returns the set of nodes with arc outgoing from a given node
const NodeSet &	children (std::string_view name) const
	return true if the arc tail->head exists in the DAGmodel
NodeSet	children (const NodeSet &ids) const
	returns the children of a set of nodes
NodeSet	children (const std::vector< std::string > &names) const
	return true if the arc tail->head exists in the DAGmodel
NodeSet	descendants (const NodeId id) const
	returns the set of nodes with directed path outgoing from a given node
NodeSet	descendants (std::string_view name) const
	return true if the arc tail->head exists in the DAGmodel
NodeSet	ancestors (const NodeId id) const
	returns the set of nodes with directed path ingoing to a given node
NodeSet	ancestors (std::string_view name) const
	return true if the arc tail->head exists in the DAGmodel
Graphical methods
UndiGraph	moralizedAncestralGraph (const NodeSet &nodes) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
UndiGraph	moralizedAncestralGraph (const std::vector< std::string > &nodenames) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
bool	isIndependent (NodeId X, NodeId Y, const NodeSet &Z) const final
	check if node X and node Y are independent given nodes 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 (std::string_view Xname, std::string_view Yname, const std::vector< std::string > &Znames) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
bool	isIndependent (const std::vector< std::string > &Xnames, const std::vector< std::string > &Ynames, const std::vector< std::string > &Znames) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
UndiGraph	moralGraph () const
	The node's id are coherent with the variables and nodes of the topology.
Sequence< NodeId >	topologicalOrder () const
	The topological order stays the same as long as no variable or arcs are added or erased src the topology.
NodeProperty< NodeId >	connectedComponents () const
	Returns the weakly connected components of the underlying DAG. Each node maps to the id of its component root.
Variable accessor methods
const VariableNodeMap &	variableNodeMap () const override
	Returns a constant reference to the VariableNodeMap of this model.
const DiscreteVariable &	variable (NodeId id) const override
	Returns a constant reference over a variable given its node id.
NodeId	nodeId (const DiscreteVariable &var) const override
	Returns the NodeId of a variable.
NodeId	idFromName (std::string_view name) const override
	Returns the NodeId of a variable given its name.
const DiscreteVariable &	variableFromName (std::string_view name) const override
	Returns a constant reference over a variable given its name.
Getter and setters
const std::string &	property (std::string_view name) const
	Return the value of the property name of this GraphicalModel.
const std::string &	propertyWithDefault (std::string_view name, const std::string &byDefault) const
	Return the value of the property name of this GraphicalModel.
void	setProperty (std::string_view name, std::string_view value)
	Add or change a property of this GraphicalModel.
std::vector< std::string >	properties () const
	List of all the names of property in the Graphical model.
bool	existsProperty (std::string_view name) const
	check wether a property exists in this GraphicalModel
void	updateMetaData ()
	update the meta data of this Graphical Model (version, creation date, last modification date) This method is called by the writers ONLY before writing the model to a file.
Variable manipulation methods.
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.

Static Public Member Functions
static std::string	spaceCplxToString (double dSize, int dim, Size usedMem)
	send to the stream the space complexity with 3 parametrs

Protected Member Functions
DAGmodel &	operator= (const DAGmodel &source)
	Private copy operator.
DAGmodel &	operator= (DAGmodel &&source) noexcept
void	_nameNodes_ (NodeGraphPart &g) const
	Names every node of g using variable(id).name() for each node id in g.

Protected Attributes
DAG	dag_
	The DAG of this Directed Graphical Model.
VariableNodeMap	varMap_
	Mapping between NodeIds and discrete variables.

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

Definition at line 64 of file DAGmodel.h.

Constructor & Destructor Documentation

◆ DAGmodel() [1/3]

gum::DAGmodel::DAGmodel ( )

Default constructor.

Definition at line 49 of file DAGmodel.cpp.

49{ GUM_CONSTRUCTOR(DAGmodel); }

gum::DAGmodel::DAGmodel

DAGmodel()

Default constructor.

Definition DAGmodel.cpp:49

References DAGmodel().

Referenced by DAGmodel(), DAGmodel(), DAGmodel(), gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::InfluenceDiagram< GUM_SCALAR >::InfluenceDiagram(), gum::InfluenceDiagram< GUM_SCALAR >::InfluenceDiagram(), ~DAGmodel(), hasSameStructure(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~DAGmodel()

gum::DAGmodel::~DAGmodel ( )

override

Destructor.

Definition at line 60 of file DAGmodel.cpp.

60{ GUM_DESTRUCTOR(DAGmodel); }

References DAGmodel().

Here is the call graph for this function:

◆ DAGmodel() [2/3]

gum::DAGmodel::DAGmodel ( const DAGmodel & source )

Copy constructor.

Do nothing.

Definition at line 51 of file DAGmodel.cpp.

                                         : DiscreteGraphicalModel(from), dag_(from.dag_) {
    GUM_CONS_CPY(DAGmodel);
  }

References DAGmodel(), gum::DiscreteGraphicalModel::DiscreteGraphicalModel(), and dag_.

Here is the call graph for this function:

◆ DAGmodel() [3/3]

gum::DAGmodel::DAGmodel ( DAGmodel && source )

noexcept

Move constructor.

Definition at line 55 of file DAGmodel.cpp.

                                             :
      DiscreteGraphicalModel(std::move(from)), dag_(std::move(from.dag_)) {
    GUM_CONS_MOV(DAGmodel);
  }

References DAGmodel(), gum::DiscreteGraphicalModel::DiscreteGraphicalModel(), and dag_.

Here is the call graph for this function:

Member Function Documentation

◆ _nameNodes_()

INLINE void gum::GraphicalModel::_nameNodes_ ( NodeGraphPart & g ) const

protectedinherited

Names every node of g using variable(id).name() for each node id in g.

Call this before returning any newly constructed graph from a model method.

Definition at line 175 of file graphicalModel_inl.h.

                                                         {
    for (auto id: g)
      g.setName(id, variable(id).name());
  }

References gum::NodeGraphPart::setName(), and variable().

Referenced by gum::DAGmodel::dag(), gum::UGmodel::graph(), gum::DAGmodel::moralGraph(), and gum::DAGmodel::moralizedAncestralGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _properties_()

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

privateinherited

Return the properties of this Directed Graphical Model.

Definition at line 67 of file graphicalModel_inl.h.

                                                                              {
    return _propertiesMap_;
  }

References _propertiesMap_.

Referenced by property().

Here is the caller graph for this function:

◆ ancestors() [1/2]

INLINE NodeSet gum::DAGmodel::ancestors ( const NodeId id ) const

returns the set of nodes with directed path ingoing to a given node

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is ingoing to the given node.

Parameters

id	the node which is the head of a directed path with the returned nodes
name	the name of the node which is the head of a directed path with the returned nodes

Definition at line 135 of file DAGmodel_inl.h.

135{ return dag_.ancestors(id); }

References dag_.

Referenced by ancestors().

Here is the caller graph for this function:

◆ ancestors() [2/2]

INLINE NodeSet gum::DAGmodel::ancestors ( std::string_view name ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 137 of file DAGmodel_inl.h.

                                                              {
    return ancestors(idFromName(name));
  }

References ancestors(), and gum::DiscreteGraphicalModel::idFromName().

Here is the call graph for this function:

◆ arcs()

INLINE const ArcSet & gum::DAGmodel::arcs ( ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 73 of file DAGmodel_inl.h.

73{ return dag_.arcs(); }

References dag_.

Referenced by hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), and gum::BayesNetFragment< GUM_SCALAR >::toBN().

Here is the caller graph for this function:

◆ children() [1/4]

INLINE const NodeSet & gum::DAGmodel::children ( const NodeId id ) const

returns the set of nodes with arc outgoing from a given node

Note that the set of nodes returned may be empty if no node is outgoing from the given node.

Parameters

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

Definition at line 95 of file DAGmodel_inl.h.

95{ return dag_.children(id); }

References dag_.

Referenced by children(), gum::BayesNet< GUM_SCALAR >::erase(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot().

Here is the caller graph for this function:

◆ children() [2/4]

INLINE NodeSet gum::DAGmodel::children ( const NodeSet & ids ) const

returns the children of a set of nodes

Definition at line 101 of file DAGmodel_inl.h.

101{ return dag_.children(ids); }

gum::GraphicalModel::ids

std::vector< NodeId > ids(const std::vector< std::string > &names) const

transform a vector of names into a vector of nodeId

Definition graphicalModel_inl.h:139

References dag_, and gum::GraphicalModel::ids().

Here is the call graph for this function:

◆ children() [3/4]

INLINE NodeSet gum::DAGmodel::children ( const std::vector< std::string > & names ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 103 of file DAGmodel_inl.h.

                                                                             {
    return children(nodeset(names));
  }

References children(), gum::GraphicalModel::names(), and gum::GraphicalModel::nodeset().

Here is the call graph for this function:

◆ children() [4/4]

INLINE const NodeSet & gum::DAGmodel::children ( std::string_view name ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 97 of file DAGmodel_inl.h.

                                                                    {
    return dag_.children(idFromName(name));
  }

◆ completeInstantiation()

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

inherited

Get an instantiation over all the variables of the model.

Definition at line 104 of file graphicalModel_inl.h.

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

References nodes(), and variable().

Here is the call graph for this function:

◆ connectedComponents()

INLINE NodeProperty< NodeId > gum::DAGmodel::connectedComponents ( ) const

Returns the weakly connected components of the underlying DAG. Each node maps to the id of its component root.

Definition at line 125 of file DAGmodel_inl.h.

                                                                    {
    return dag_.connectedComponents();
  }

References dag_.

◆ dag()

INLINE DAG gum::DAGmodel::dag ( ) const

nodiscard

Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.

O(n) — allocates a new DAG. For a stable reference (listeners, long-lived pointers), use internalDag().

Definition at line 61 of file DAGmodel_inl.h.

                          {
    DAG g = dag_;
    _nameNodes_(g);
    return g;
  }

References gum::GraphicalModel::_nameNodes_(), and dag_.

Referenced by gum::BayesNetFragment< GUM_SCALAR >::BayesNetFragment(), gum::MarginalTargetedInference< GUM_SCALAR >::MarginalTargetedInference(), gum::BayesNet< GUM_SCALAR >::add(), gum::BayesNet< GUM_SCALAR >::reverseArc(), and gum::InfluenceDiagram< GUM_SCALAR >::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ descendants() [1/2]

INLINE NodeSet gum::DAGmodel::descendants ( const NodeId id ) const

returns the set of nodes with directed path outgoing from a given node

Note that the set of nodes returned may be empty if no path within the ArcGraphPart is outgoing from the given node.

Parameters

id	the node which is the tail of a directed path with the returned nodes
name	the name of the node which is the tail of a directed path with the returned nodes

Definition at line 129 of file DAGmodel_inl.h.

129{ return dag_.descendants(id); }

References dag_.

◆ descendants() [2/2]

INLINE NodeSet gum::DAGmodel::descendants ( std::string_view name ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 131 of file DAGmodel_inl.h.

                                                                {
    return descendants(idFromName(name));
  }

◆ empty()

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

virtualinherited

Return true if this graphical model is empty.

Definition at line 114 of file graphicalModel_inl.h.

114{ 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::DAGmodel::exists ( NodeId node ) const

finalvirtual

Return true if this node exists in this graphical model.

Implements gum::GraphicalModel.

Definition at line 113 of file DAGmodel_inl.h.

113{ return dag_.exists(node); }

References dag_.

Referenced by gum::build_node(), gum::build_node_for_ID(), hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), gum::IBayesNet< GUM_SCALAR >::operator==(), and gum::InfluenceDiagram< GUM_SCALAR >::operator==().

Here is the caller graph for this function:

◆ exists() [2/2]

INLINE bool gum::DAGmodel::exists ( std::string_view name ) const

finalvirtual

Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.

O(n) — allocates a new DAG. For a stable reference (listeners, long-lived pointers), use internalDag().

Implements gum::GraphicalModel.

Definition at line 115 of file DAGmodel_inl.h.

                                                        {
    return variableNodeMap().exists(name);
  }

◆ existsArc() [1/2]

INLINE bool gum::DAGmodel::existsArc	(	const NodeId	tail,
		const NodeId	head ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 75 of file DAGmodel_inl.h.

                                                                            {
    return dag_.existsArc(tail, head);
  }

References dag_.

Referenced by existsArc(), gum::BayesNet< GUM_SCALAR >::reverseArc(), gum::BayesNetFragment< GUM_SCALAR >::toDot(), and gum::BayesNetFragment< GUM_SCALAR >::whenArcDeleted().

Here is the caller graph for this function:

◆ existsArc() [2/2]

INLINE bool gum::DAGmodel::existsArc	(	std::string_view	nametail,
		std::string_view	namehead ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 79 of file DAGmodel_inl.h.

                                                                                        {
    return existsArc(idFromName(nametail), idFromName(namehead));
  }

References existsArc(), and gum::DiscreteGraphicalModel::idFromName().

Here is the call graph for this function:

◆ existsProperty()

INLINE bool gum::GraphicalModel::existsProperty ( std::string_view name ) const

inherited

check wether a property exists in this GraphicalModel

Definition at line 170 of file graphicalModel_inl.h.

                                                               {
    return _propertiesMap_.exists(name);
  }

References _propertiesMap_.

◆ family() [1/2]

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

finalvirtual

returns the parents 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

Implements gum::GraphicalModel.

Definition at line 89 of file DAGmodel_inl.h.

89{ return dag_.family(id); }

References dag_.

◆ family() [2/2]

INLINE NodeSet gum::DAGmodel::family ( std::string_view name ) const

finalvirtual

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Implements gum::GraphicalModel.

Definition at line 91 of file DAGmodel_inl.h.

                                                           {
    return dag_.family(idFromName(name));
  }

References dag_, and gum::DiscreteGraphicalModel::idFromName().

Here is the call graph for this function:

◆ hasSameStructure()

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

Returns: true if all the named node are the same and all the named arcs are the same

Definition at line 87 of file DAGmodel.cpp.

                                                             {
    if (this == &other) return true;
 
    if (size() != other.size()) return false;
 
    if (sizeArcs() != other.sizeArcs()) return false;
 
    for (const auto& nid: nodes()) {
      if (!other.exists(variable(nid).name())) return false;
    }
 
    for (const auto& arc: arcs()) {
      if (!other.arcs().exists(Arc(other.idFromName(variable(arc.tail()).name()),
                                   other.idFromName(variable(arc.head()).name()))))
        return false;
    }
 
    return true;
  }

References DAGmodel(), arcs(), exists(), gum::Set< Key >::exists(), gum::DiscreteGraphicalModel::idFromName(), nodes(), size(), sizeArcs(), and gum::DiscreteGraphicalModel::variable().

Here is the call graph for this function:

◆ idFromName()

INLINE NodeId gum::DiscreteGraphicalModel::idFromName ( std::string_view name ) const

overridevirtualinherited

Returns the NodeId of a variable given its name.

Exceptions

NotFound if no such name exists in the model.

Implements gum::GraphicalModel.

Reimplemented in gum::InfluenceDiagram< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Definition at line 61 of file discreteGraphicalModel_inl.h.

                                                                     {
    return varMap_.idFromName(name);
  }

References varMap_.

Referenced by gum::ASTposteriorProba< GUM_SCALAR >::_compute_knw_from_bn(), gum::DAGmodel::ancestors(), gum::InfluenceDiagram< GUM_SCALAR >::clear(), gum::ASTjointProba< GUM_SCALAR >::eval(), gum::ASTposteriorProba< GUM_SCALAR >::eval(), gum::ASTsum< GUM_SCALAR >::eval(), 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::DAGmodel::minimalCondSet(), gum::UGmodel::neighbours(), gum::IBayesNet< GUM_SCALAR >::operator==(), gum::IMarkovRandomField< GUM_SCALAR >::operator==(), gum::DAGmodel::parents(), and gum::IMarkovRandomField< GUM_SCALAR >::smallestFactorFromNode().

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(), and variableNodeMap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internalDag()

INLINE const DAG & gum::DAGmodel::internalDag ( ) const

Returns a const reference to the internal (unnamed) DAG. O(1), no copy. Use for stable references or pointers (e.g. graph listeners). For named node access, use dag() instead.

Definition at line 58 of file DAGmodel_inl.h.

58{ return dag_; }

References dag_.

Referenced by gum::BayesNetFragment< GUM_SCALAR >::BayesNetFragment(), gum::MarkovBlanket::MarkovBlanket(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::isInstalledNode(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::BayesNetFragment< GUM_SCALAR >::toBN(), gum::BayesNetFragment< GUM_SCALAR >::toDot(), and gum::BayesNetFragment< GUM_SCALAR >::whenArcDeleted().

Here is the caller graph for this function:

◆ isIndependent() [1/4]

INLINE bool gum::DAGmodel::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 156 of file DAGmodel_inl.h.

                                                                                                {
    return dag_.dSeparation(X, Y, Z);
  }

References dag_.

◆ isIndependent() [2/4]

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

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

Parameters

nodes	the set of nodeId
nodenames	the vector of names of nodes

Returns: the moralized ancestral graph

Definition at line 184 of file DAGmodel_inl.h.

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

◆ isIndependent() [3/4]

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 152 of file DAGmodel_inl.h.

                                                                                {
    return dag_.dSeparation(X, Y, Z);
  }

Referenced by gum::BayesNet< double >::ancestors(), and isIndependent().

Here is the caller graph for this function:

◆ isIndependent() [4/4]

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

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

Parameters

nodes	the set of nodeId
nodenames	the vector of names of nodes

Returns: the moralized ancestral graph

Definition at line 178 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

◆ log10DomainSize()

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

inherited

Definition at line 93 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::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:

◆ minimalCondSet() [1/4]

INLINE NodeSet gum::DAGmodel::minimalCondSet	(	const NodeSet &	targets,
		const NodeSet &	soids ) const

Definition at line 164 of file DAGmodel_inl.h.

                                                                                            {
    return dag_.minimalCondSet(targets, soids);
  }

◆ minimalCondSet() [2/4]

INLINE NodeSet gum::DAGmodel::minimalCondSet	(	const std::vector< std::string > &	targets,
		const std::vector< std::string > &	soids ) const

Definition at line 173 of file DAGmodel_inl.h.

                                                                                     {
    return dag_.minimalCondSet(nodeset(targets), nodeset(soids));
  }

◆ minimalCondSet() [3/4]

INLINE NodeSet gum::DAGmodel::minimalCondSet	(	NodeId	target,
		const NodeSet &	soids ) const

Definition at line 160 of file DAGmodel_inl.h.

                                                                                   {
    return dag_.minimalCondSet(target, soids);
  }

Referenced by gum::ASTposteriorProba< GUM_SCALAR >::_compute_knw_from_bn().

Here is the caller graph for this function:

◆ minimalCondSet() [4/4]

INLINE NodeSet gum::DAGmodel::minimalCondSet	(	std::string_view	target,
		const std::vector< std::string > &	soids ) const

Definition at line 168 of file DAGmodel_inl.h.

                                                                                     {
    return dag_.minimalCondSet(idFromName(target), nodeset(soids));
  }

References dag_, gum::DiscreteGraphicalModel::idFromName(), and gum::GraphicalModel::nodeset().

Here is the call graph for this function:

◆ moralGraph()

UndiGraph gum::DAGmodel::moralGraph ( ) const

The node's id are coherent with the variables and nodes of the topology.

Definition at line 81 of file DAGmodel.cpp.

                                       {
    auto g = dag_.moralGraph();
    _nameNodes_(g);
    return g;
  }

References gum::GraphicalModel::_nameNodes_(), and dag_.

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), and gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moralizedAncestralGraph() [1/2]

INLINE UndiGraph gum::DAGmodel::moralizedAncestralGraph ( const NodeSet & nodes ) const

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

Parameters

nodes	the set of nodeId
nodenames	the vector of names of nodes

Returns: the moralized ancestral graph

Definition at line 146 of file DAGmodel_inl.h.

                                                                               {
    auto g = dag_.moralizedAncestralGraph(nodes);
    _nameNodes_(g);
    return g;
  }

References gum::GraphicalModel::_nameNodes_(), dag_, and nodes().

Referenced by moralizedAncestralGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moralizedAncestralGraph() [2/2]

INLINE UndiGraph gum::DAGmodel::moralizedAncestralGraph ( const std::vector< std::string > & nodenames ) const

build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

Parameters

nodes	the set of nodeId
nodenames	the vector of names of nodes

Returns: the moralized ancestral graph

Definition at line 142 of file DAGmodel_inl.h.

                                                                                     {
    return moralizedAncestralGraph(nodeset(nodenames));
  }

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

Here is the call 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;
  }

References ids(), gum::VariableNodeMap::name(), and variableNodeMap().

Here is the call graph for this function:

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

                                                                                   {
    std::vector< std::string > res;
    const VariableNodeMap&     v = variableNodeMap();
 
    std::ranges::transform(ids, std::back_inserter(res), [&v](const NodeId n) {
      return v[n].name();
    });
 
    return res;
  }

References ids().

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

INLINE NodeId gum::DiscreteGraphicalModel::nodeId ( const DiscreteVariable & var ) const

overridevirtualinherited

Returns the NodeId of a variable.

Exceptions

NotFound if no variable matches var.

Implements gum::GraphicalModel.

Reimplemented in gum::InfluenceDiagram< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Definition at line 56 of file discreteGraphicalModel_inl.h.

                                                                         {
    return varMap_.get(var);
  }

References varMap_.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::clear(), gum::BayesBall::relevantTensors(), and gum::dSeparationAlgorithm::relevantTensors().

Here is the caller graph for this function:

◆ nodes()

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

finalvirtual

Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding variable.

O(n) — allocates a new DAG. For a stable reference (listeners, long-lived pointers), use internalDag().

Implements gum::GraphicalModel.

Definition at line 119 of file DAGmodel_inl.h.

                                                    {
    return static_cast< const NodeGraphPart& >(dag_);
  }

References dag_.

◆ 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 102 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::BayesNet< double >::ancestors(), gum::DAGmodel::children(), gum::DAGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::DAGmodel::minimalCondSet(), and gum::DAGmodel::moralizedAncestralGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

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

protected

Private copy operator.

Definition at line 62 of file DAGmodel.cpp.

                                                    {
    if (this != &source) {
      DiscreteGraphicalModel::operator=(source);
      dag_ = source.dag_;
      GUM_OP_CPY(DAGmodel);
    }
 
    return *this;
  }

References DAGmodel(), dag_, and gum::DiscreteGraphicalModel::operator=().

Referenced by gum::IBayesNet< GUM_SCALAR >::operator=(), gum::IBayesNet< GUM_SCALAR >::operator=(), and gum::InfluenceDiagram< GUM_SCALAR >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

DAGmodel & gum::DAGmodel::operator= ( DAGmodel && source )

protectednoexcept

Definition at line 72 of file DAGmodel.cpp.

                                                        {
    if (this != &source) {
      DiscreteGraphicalModel::operator=(std::move(source));
      dag_ = std::move(source.dag_);
      GUM_OP_MOV(DAGmodel);
    }
    return *this;
  }

References DAGmodel(), dag_, and gum::DiscreteGraphicalModel::operator=().

Here is the call graph for this function:

◆ parents() [1/4]

INLINE const NodeSet & gum::DAGmodel::parents ( const NodeId id ) const

returns the set of nodes with arc ingoing to a given node

Note that the set of nodes returned may be empty if no arc within the ArcGraphPart is ingoing into the given 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

Definition at line 83 of file DAGmodel_inl.h.

83{ return dag_.parents(id); }

References dag_.

Referenced by gum::IBayesNet< GUM_SCALAR >::check(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::InfluenceDiagram< GUM_SCALAR >::copyStructureAndTables_(), gum::IBayesNet< GUM_SCALAR >::dim(), gum::ASTposteriorProba< GUM_SCALAR >::eval(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::installCPT_(), parents(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot().

Here is the caller graph for this function:

◆ parents() [2/4]

INLINE NodeSet gum::DAGmodel::parents ( const NodeSet & ids ) const

returns the parents of a set of nodes

Definition at line 107 of file DAGmodel_inl.h.

107{ return dag_.parents(ids); }

References dag_, and gum::GraphicalModel::ids().

Here is the call graph for this function:

◆ parents() [3/4]

INLINE NodeSet gum::DAGmodel::parents ( const std::vector< std::string > & names ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 109 of file DAGmodel_inl.h.

                                                                            {
    return parents(nodeset(names));
  }

References gum::GraphicalModel::names().

Here is the call graph for this function:

◆ parents() [4/4]

INLINE const NodeSet & gum::DAGmodel::parents ( std::string_view name ) const

return true if the arc tail->head exists in the DAGmodel

Parameters

tail	the nodeId (or the name) of the tail in tail->head
head	the nodeId (or the name) of the head in tail->head

Returns: true if the arc exists

Definition at line 85 of file DAGmodel_inl.h.

                                                                   {
    return parents(idFromName(name));
  }

References gum::DiscreteGraphicalModel::idFromName(), and parents().

Here is the call graph for this function:

◆ properties()

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

inherited

List of all the names of property in the Graphical model.

Definition at line 79 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 ( std::string_view 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.

                                                                     {
    auto p = _properties_().tryGet(name);
    if (!p) { GUM_ERROR(NotFound, "The following property does not exists: " << name) }
    return *p;
  }

References _properties_(), GUM_ERROR, and gum::HashTable< Key, Val >::tryGet().

Here is the call graph for this function:

◆ propertyWithDefault()

INLINE const std::string & gum::GraphicalModel::propertyWithDefault	(	std::string_view	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 72 of file graphicalModel_inl.h.

                                                                                           {
    auto p = _propertiesMap_.tryGet(name);
    return p ? *p : byDefault;
  }

References _propertiesMap_.

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

Here is the caller graph for this function:

◆ setProperty()

INLINE void gum::GraphicalModel::setProperty	(	std::string_view	name,
		std::string_view	value )

inherited

Add or change a property of this GraphicalModel.

Definition at line 87 of file graphicalModel_inl.h.

                                                                            {
    if (auto p = _propertiesMap_.tryGet(name)) *p = value;
    else _propertiesMap_.insert(std::string(name), std::string(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::DAGmodel::size ( ) const

finalvirtual

Returns the number of variables in this Directed Graphical Model.

Implements gum::GraphicalModel.

Definition at line 68 of file DAGmodel_inl.h.

68{ return dag_.size(); }

References dag_.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::copyStructureAndTables_(), gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize(), hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), gum::IBayesNet< GUM_SCALAR >::operator==(), gum::InfluenceDiagram< GUM_SCALAR >::operator==(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot().

Here is the caller graph for this function:

◆ sizeArcs()

INLINE Size gum::DAGmodel::sizeArcs ( ) const

Returns the number of arcs in this Directed Graphical Model.

Definition at line 71 of file DAGmodel_inl.h.

71{ return dag_.sizeArcs(); }

References dag_.

Referenced by hasSameStructure(), gum::MarkovBlanket::hasSameStructure(), gum::IBayesNet< GUM_SCALAR >::operator==(), gum::InfluenceDiagram< GUM_SCALAR >::operator==(), and gum::InfluenceDiagram< GUM_SCALAR >::toString().

Here is the caller graph for this function:

◆ spaceCplxToString()

std::string gum::GraphicalModel::spaceCplxToString	(	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 110 of file graphicalModel.cpp.

                                                                                 {
    std::string result;
    if (dSize > 6) result = std::format("domainSize: 10^{:.6g}", dSize);
    else result = std::format("domainSize: {}", (long long)std::round(std::pow(10.0, dSize)));
 
    result += std::format(", dim: {}, mem: ", dim);
 
    if (const Size go = usedMem / (1024 * 1024 * 1024); go > 0) result += std::format("{}Go ", go);
    if (const Size mo = (usedMem / (1024 * 1024)) % 1024; mo > 0)
      result += std::format("{}Mo ", mo);
    if (const Size ko = (usedMem / 1024) % 1024; ko > 0) result += std::format("{}Ko ", ko);
    result += std::format("{}o", usedMem % 1024);
    return result;
  }

◆ topologicalOrder()

INLINE Sequence< NodeId > gum::DAGmodel::topologicalOrder ( ) const

The topological order stays the same as long as no variable or arcs are added or erased src the topology.

Parameters

clear If false returns the previously created topology.

Definition at line 123 of file DAGmodel_inl.h.

123{ return dag_.topologicalOrder(); }

References dag_.

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::_checkTemporalOrder_(), gum::InfluenceDiagram< GUM_SCALAR >::decisionOrder(), and gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists().

Here is the caller graph for this function:

◆ updateMetaData()

void gum::GraphicalModel::updateMetaData ( )

inherited

update the meta data of this Graphical Model (version, creation date, last modification date) This method is called by the writers ONLY before writing the model to a file.

Definition at line 81 of file graphicalModel.cpp.

                                      {
    auto const time = std::chrono::time_point_cast< std::chrono::milliseconds >(
        std::chrono::system_clock::now());
    auto const currentdate = std::format("{:%Y-%m-%d %T}", time);
 
    const std::string currentSoftware = "aGrUM " GUM_VERSION;
    if (auto software = _propertiesMap_.tryGet("software")) {
      *software = currentSoftware;
    } else {
      _propertiesMap_.insert("software", currentSoftware);
    }
 
    if (!_propertiesMap_.tryGet("creation")) { _propertiesMap_.insert("creation", currentdate); }
 
    if (auto lastModification = _propertiesMap_.tryGet("lastModification")) {
      *lastModification = currentdate;
    } else {
      _propertiesMap_.insert("lastModification", currentdate);
    }
  }

References _propertiesMap_.

◆ variable()

INLINE const DiscreteVariable & gum::DiscreteGraphicalModel::variable ( NodeId id ) const

overridevirtualinherited

Returns a constant reference over a variable given its node id.

Exceptions

NotFound if no variable's id matches id.

Implements gum::GraphicalModel.

Reimplemented in gum::InfluenceDiagram< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Definition at line 51 of file discreteGraphicalModel_inl.h.

                                                                          {
    return varMap_.get(id);
  }

References varMap_.

Referenced by gum::Estimator< GUM_SCALAR >::Estimator(), gum::ASTposteriorProba< GUM_SCALAR >::_compute_knw_from_bn(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::_insertEvidence_(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::_verticesSampling_(), gum::IBayesNet< GUM_SCALAR >::check(), gum::InfluenceDiagram< GUM_SCALAR >::clear(), gum::IBayesNet< GUM_SCALAR >::dim(), gum::ASTsum< GUM_SCALAR >::eval(), gum::DAGmodel::hasSameStructure(), gum::UGmodel::hasSameStructure(), gum::IBayesNet< GUM_SCALAR >::maxVarDomainSize(), gum::IMarkovRandomField< GUM_SCALAR >::maxVarDomainSize(), gum::IBayesNet< GUM_SCALAR >::operator==(), gum::IMarkovRandomField< GUM_SCALAR >::operator==(), gum::Estimator< GUM_SCALAR >::setFromBN(), gum::IMarkovRandomField< GUM_SCALAR >::toDot(), and gum::IMarkovRandomField< GUM_SCALAR >::toDotAsFactorGraph().

Here is the caller graph for this function:

◆ variableFromName()

INLINE const DiscreteVariable & gum::DiscreteGraphicalModel::variableFromName ( std::string_view name ) const

overridevirtualinherited

Returns a constant reference over a variable given its name.

Exceptions

NotFound if no such name exists in the model.

Implements gum::GraphicalModel.

Reimplemented in gum::InfluenceDiagram< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Definition at line 66 of file discreteGraphicalModel_inl.h.

                                                                                            {
    return varMap_.variableFromName(name);
  }

References varMap_.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::clear(), gum::IBayesNet< GUM_SCALAR >::evEq(), gum::IBayesNet< GUM_SCALAR >::evGt(), gum::IBayesNet< GUM_SCALAR >::evIn(), gum::IBayesNet< GUM_SCALAR >::evLt(), gum::IBayesNet< GUM_SCALAR >::operator==(), and gum::IMarkovRandomField< GUM_SCALAR >::operator==().

Here is the caller graph for this function:

◆ variableNodeMap()

INLINE const VariableNodeMap & gum::DiscreteGraphicalModel::variableNodeMap ( ) const

overridevirtualinherited

Returns a constant reference to the VariableNodeMap of this model.

Implements gum::GraphicalModel.

Reimplemented in gum::InfluenceDiagram< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Definition at line 48 of file discreteGraphicalModel_inl.h.

48{ return varMap_; }

References varMap_.

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

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

◆ 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 gum::Set< Key >::insert(), gum::VariableNodeMap::variableFromName(), and 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 262 of file graphicalModel.h.

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

◆ dag_

DAG gum::DAGmodel::dag_

protected

The DAG of this Directed Graphical Model.

Definition at line 284 of file DAGmodel.h.

Referenced by DAGmodel(), DAGmodel(), gum::prm::ClassBayesNet< GUM_SCALAR >::_get_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::InstanceBayesNet< GUM_SCALAR >::_init_(), gum::BayesNet< GUM_SCALAR >::add(), gum::BayesNet< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::addNode_(), ancestors(), arcs(), children(), children(), connectedComponents(), dag(), descendants(), gum::BayesNet< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::BayesNet< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), exists(), existsArc(), gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween(), family(), family(), gum::InfluenceDiagram< GUM_SCALAR >::getChildrenDecision_(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::BayesNetFragment< GUM_SCALAR >::installArc_(), gum::BayesNetFragment< GUM_SCALAR >::installNode(), internalDag(), isIndependent(), minimalCondSet(), moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::moralGraph_(), moralizedAncestralGraph(), nodes(), operator=(), operator=(), parents(), parents(), size(), sizeArcs(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), topologicalOrder(), gum::BayesNetFragment< GUM_SCALAR >::uninstallArc_(), and gum::BayesNetFragment< GUM_SCALAR >::uninstallNode().

◆ varMap_

VariableNodeMap gum::DiscreteGraphicalModel::varMap_

protectedinherited

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

agrum/base/graphicalModels/DAGmodel.h
agrum/base/graphicalModels/DAGmodel.cpp
agrum/base/graphicalModels/DAGmodel_inl.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DAGmodel() [1/3]

◆ ~DAGmodel()

◆ DAGmodel() [2/3]

◆ DAGmodel() [3/3]

Member Function Documentation

◆ _nameNodes_()

◆ _properties_()

◆ ancestors() [1/2]

◆ ancestors() [2/2]

◆ arcs()

◆ children() [1/4]

◆ children() [2/4]

◆ children() [3/4]

◆ children() [4/4]

◆ completeInstantiation()

◆ connectedComponents()

◆ dag()

◆ descendants() [1/2]

◆ descendants() [2/2]

◆ empty()

◆ exists() [1/2]

◆ exists() [2/2]

◆ existsArc() [1/2]

◆ existsArc() [2/2]

◆ existsProperty()

◆ family() [1/2]

◆ family() [2/2]

◆ hasSameStructure()

◆ idFromName()

◆ ids()

◆ internalDag()

◆ isIndependent() [1/4]

◆ isIndependent() [2/4]

◆ isIndependent() [3/4]

◆ isIndependent() [4/4]

◆ log10DomainSize()

◆ minimalCondSet() [1/4]

◆ minimalCondSet() [2/4]

◆ minimalCondSet() [3/4]

◆ minimalCondSet() [4/4]

◆ moralGraph()

◆ moralizedAncestralGraph() [1/2]

◆ moralizedAncestralGraph() [2/2]

◆ names() [1/2]

◆ names() [2/2]

◆ nodeId()

◆ nodes()

◆ nodeset()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parents() [1/4]

◆ parents() [2/4]

◆ parents() [3/4]

◆ parents() [4/4]

◆ properties()

◆ property()

◆ propertyWithDefault()

◆ setProperty()

◆ size()

◆ sizeArcs()

◆ spaceCplxToString()

◆ topologicalOrder()

◆ updateMetaData()

◆ variable()

◆ variableFromName()

◆ variableNodeMap()

◆ variables() [1/2]

◆ variables() [2/2]

Member Data Documentation

◆ _propertiesMap_

◆ dag_

◆ varMap_