aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
gum::prm::InstanceBayesNet< GUM_SCALAR > Class Template Reference

This class decorates an PRMInstance<GUM_SCALAR> as an IBaseBayesNet. More...

#include <agrum/PRM/instanceBayesNet.h>

Inheritance diagram for gum::prm::InstanceBayesNet< GUM_SCALAR >:
[legend]
Collaboration diagram for gum::prm::InstanceBayesNet< GUM_SCALAR >:
[legend]

Public Member Functions

std::vector< std::string > check () const
 Check if the BayesNet is consistent (variables, CPT).
bool operator== (const IBayesNet< GUM_SCALAR > &from) const
 This operator compares 2 BNs !
Size dim () const
 Returns the dimension (the number of free parameters) in this bayes net.
Size maxVarDomainSize () const
GUM_SCALAR minParam () const
GUM_SCALAR maxParam () const
GUM_SCALAR minNonZeroParam () const
GUM_SCALAR maxNonOneParam () const
virtual std::string toDot (const dot::DotOptions &options) const
 A dot representation of this IBayesNet, with the options given by the caller.
std::string toString () const
Tensor< GUM_SCALAR > evEq (std::string_view name, double value) const
Tensor< GUM_SCALAR > evIn (std::string_view name, double val1, double val2) const
Tensor< GUM_SCALAR > evLt (std::string_view name, double value) const
Tensor< GUM_SCALAR > evGt (std::string_view name, double value) const
Size memoryFootprint () const
 compute the (approximated) footprint in memory of the model (the footprints of CPTs)
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 & destructor.
 InstanceBayesNet (const PRMInstance< GUM_SCALAR > &i)
 Default constructor.
 InstanceBayesNet (const InstanceBayesNet &from)
 Copy constructor.
InstanceBayesNet & operator= (const InstanceBayesNet &from)
 Copy operator.
 ~InstanceBayesNet () override
 Destructor.
Variable manipulation methods.
const Tensor< GUM_SCALAR > & cpt (NodeId varId) const override
 See gum::IBaseBayesNet::cpt().
const VariableNodeMap & variableNodeMap () const override
 See gum::IBaseBayesNet::variableNodeMap().
const DiscreteVariable & variable (NodeId id) const override
 See gum::IBaseBayesNet::variable().
NodeId nodeId (const DiscreteVariable &var) const override
 See gum::IBaseBayesNet::nodeId().
NodeId idFromName (std::string_view name) const override
 See gum::IBaseBayesNet::idFromName().
const DiscreteVariable & variableFromName (std::string_view name) const override
 See gum::IBaseBayesNet::variableFromName().
const NodeProperty< Size > & modalities () const
 See gum::IBaseBayesNet::cpt().
Graphical methods
std::string toDot () const override
Joint Probability manipulation methods
GUM_SCALAR jointProbability (const Instantiation &i) const
 Compute a parameter of the joint probability for the BN (given an instantiation of the vars).
GUM_SCALAR log2JointProbability (const Instantiation &i) const
 Compute a parameter of the log joint probability for the BN (given an instantiation of the vars).
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.
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

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 PRMClassElement< GUM_SCALAR > & _get_ (NodeId id) const
 Private getter with type checking in case the id is not a formal PRMAttribute<GUM_SCALAR>.
const PRMClassElement< GUM_SCALAR > & _get_ (std::string_view name) const
void _init_ (const PRMInstance< GUM_SCALAR > &i)
void _checkNodeExists_ (NodeId id) const
const HashTable< std::string, std::string > & _properties_ () const
 Return the properties of this Directed Graphical Model.

Private Attributes

HashTable< const DiscreteVariable *, const PRMAttribute< GUM_SCALAR > * > _varNodeMap_
 Mapping between DiscreteVariable and their NodeId.
const PRMInstance< GUM_SCALAR > * _inst_
 The PRMClassElementContainer decorated by this.
NodeProperty< Size > _modalities_
HashTable< std::string, std::string > _propertiesMap_
 The properties of this Directed Graphical Model.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::prm::InstanceBayesNet< GUM_SCALAR >

This class decorates an PRMInstance<GUM_SCALAR> as an IBaseBayesNet.

Remember that an InstanceBayesNet does not contain input nodes parents and output nodes children. Thus you should be careful when using one of the BayesNetInference over a InstanceBayesNet since some variables are missing in the DAG but not in the nodes CPT.

Definition at line 74 of file instanceBayesNet.h.

Constructor & Destructor Documentation

◆ InstanceBayesNet() [1/2]

template<GUM_Numeric GUM_SCALAR>
gum::prm::InstanceBayesNet< GUM_SCALAR >::InstanceBayesNet ( const PRMInstance< GUM_SCALAR > & i)

Default constructor.

Parameters
iThe PRMInstance<GUM_SCALAR> decorated by this InstanceBayesNet.

Definition at line 77 of file instanceBayesNet_tpl.h.

77 :
80 _init_(i);
81 }
IBayesNet()
Default constructor.
This class decorates an PRMInstance<GUM_SCALAR> as an IBaseBayesNet.
InstanceBayesNet(const PRMInstance< GUM_SCALAR > &i)
Default constructor.
void _init_(const PRMInstance< GUM_SCALAR > &i)
const PRMInstance< GUM_SCALAR > * _inst_
The PRMClassElementContainer decorated by this.

References gum::IBayesNet< GUM_SCALAR >::IBayesNet(), InstanceBayesNet(), _init_(), and _inst_.

Referenced by InstanceBayesNet(), InstanceBayesNet(), ~InstanceBayesNet(), and operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InstanceBayesNet() [2/2]

template<GUM_Numeric GUM_SCALAR>
gum::prm::InstanceBayesNet< GUM_SCALAR >::InstanceBayesNet ( const InstanceBayesNet< GUM_SCALAR > & from)

Copy constructor.

Definition at line 84 of file instanceBayesNet_tpl.h.

84 :
87 }
HashTable< const DiscreteVariable *, const PRMAttribute< GUM_SCALAR > * > _varNodeMap_
Mapping between DiscreteVariable and their NodeId.

References gum::IBayesNet< GUM_SCALAR >::IBayesNet(), InstanceBayesNet(), _inst_, and _varNodeMap_.

Here is the call graph for this function:

◆ ~InstanceBayesNet()

template<GUM_Numeric GUM_SCALAR>
gum::prm::InstanceBayesNet< GUM_SCALAR >::~InstanceBayesNet ( )
override

Destructor.

Definition at line 90 of file instanceBayesNet_tpl.h.

References InstanceBayesNet().

Here is the call graph for this function:

Member Function Documentation

◆ _checkNodeExists_()

INLINE void gum::DAGmodel::_checkNodeExists_ ( NodeId id) const
privateinherited
Exceptions
NotFoundif id is not a node of the model

Definition at line 83 of file DAGmodel_inl.h.

83 {
84 if (!dag_.exists(id)) GUM_ERROR(NotFound, "No node with id " << id << " in the model")
85 }
DAG dag_
The DAG of this Directed Graphical Model.
Definition DAGmodel.h:291
bool exists(const NodeId id) const
alias for existsNode
#define GUM_ERROR(type, msg)
Definition exceptions.h:76

References dag_, gum::NodeGraphPart::exists(), and GUM_ERROR.

Referenced by ancestors(), children(), descendants(), family(), and parents().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ _get_() [1/2]

template<GUM_Numeric GUM_SCALAR>
const PRMClassElement< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::_get_ ( NodeId id) const
private

Private getter with type checking in case the id is not a formal PRMAttribute<GUM_SCALAR>.

Exceptions
NotFoundRaised if id is not a formal attribute.

Definition at line 138 of file instanceBayesNet_tpl.h.

138 {
139 return _inst_->get(id);
140 }

References _inst_.

Referenced by cpt(), idFromName(), variable(), and variableFromName().

Here is the caller graph for this function:

◆ _get_() [2/2]

template<GUM_Numeric GUM_SCALAR>
const PRMClassElement< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::_get_ ( std::string_view name) const
private

Definition at line 144 of file instanceBayesNet_tpl.h.

144 {
145 if (!_inst_->exists(name)) GUM_ERROR(NotFound, "no element found with that name")
147 }

References _inst_, and GUM_ERROR.

◆ _init_()

template<GUM_Numeric GUM_SCALAR>
void gum::prm::InstanceBayesNet< GUM_SCALAR >::_init_ ( const PRMInstance< GUM_SCALAR > & i)
private

Definition at line 57 of file instanceBayesNet_tpl.h.

57 {
58 for (const auto node: i.type().containerDag().nodes()) {
59 if (i.exists(node)) {
60 // Adding the attribute
62 this->dag_.addNodeWithId(attr.id());
63 _varNodeMap_.insert(&(attr.type().variable()), &attr);
64 }
65 }
66
67 for (const auto& arc: i.type().containerDag().arcs()) {
68 try {
69 this->dag_.addArc(arc.tail(), arc.head());
70 } catch (InvalidNode const&) {
71 // Not added means not an attribute
72 }
73 }
74 }
const ArcSet & arcs() const
return true if the arc tail->head exists in the DAGmodel
bool exists(NodeId node) const final
Return true if this node exists in this 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 vari...
const DiscreteVariable & variable(NodeId id) const override
See gum::IBaseBayesNet::variable().

References _varNodeMap_, gum::DAGmodel::dag_, gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMAttribute< GUM_SCALAR >::type(), gum::prm::PRMInstance< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

Referenced by InstanceBayesNet().

Here is the call graph for this function:
Here is the caller graph for this function:

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

175 {
176 for (auto id: g)
177 g.setName(id, variable(id).name());
178 }
virtual const DiscreteVariable & variable(NodeId id) const =0
Returns a constant reference over a variable given it's node id.

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

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

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.

67 {
68 return _propertiesMap_;
69 }
HashTable< std::string, std::string > _propertiesMap_
The properties of this Directed Graphical Model.

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
inherited

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
idthe node which is the head of a directed path with the returned nodes
namethe name of the node which is the head of a directed path with the returned nodes
Exceptions
NotFoundif the node does not exist in the model

Definition at line 167 of file DAGmodel_inl.h.

167 {
168 auto res = dag_.ancestors(id);
169 if (res.empty()) _checkNodeExists_(id);
170 return res;
171 }
void _checkNodeExists_(NodeId id) const
NodeSet ancestors(NodeId id) const
returns the set of all ancestors of id (nodes from which id is reachable)

References _checkNodeExists_(), gum::DiGraph::ancestors(), dag_, and gum::Set< Key >::empty().

Here is the call graph for this function:

◆ ancestors() [2/2]

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Definition at line 173 of file DAGmodel_inl.h.

173 {
174 return dag_.ancestors(idFromName(name));
175 }
NodeId idFromName(std::string_view name) const override
Returns the NodeId of a variable given its name.

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

Here is the call graph for this function:

◆ arcs()

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe 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(); }
const ArcSet & arcs() const
returns the set of arcs stored within the ArcGraphPart

References gum::ArcGraphPart::arcs(), and dag_.

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check()

template<GUM_Numeric GUM_SCALAR>
std::vector< std::string > gum::IBayesNet< GUM_SCALAR >::check ( ) const
inherited

Check if the BayesNet is consistent (variables, CPT).

A distribution is considered normalized if its sum is in [1-e, 1+e], where e is the standard tolerance of the configuration (core.epsilonStandard, 1e-6 by default). A sum that is out of this interval but in [1-c, 1+c], where c is the coarse tolerance (core.epsilonCoarse, 1e-2 by default), is reported with the hint "(normalization problem ?)".

Returns
a list of comments on the consistency of the Bayes Net

Definition at line 320 of file IBayesNet_tpl.h.

320 {
322
323 const double epsilon = config().epsilonStandard();
324 const double error_epsilon = config().epsilonCoarse();
325
326 // CHECKING domain
327 for (const auto i: nodes())
328 if (variable(i).domainSize() < 2) {
330 s << "Variable " << variable(i).name() << ": not consistent (domainSize=1).";
331 comments.push_back(s.str());
332 }
333
334 // CHECKING parameters are probabilities
335 // >0
336 for (const auto i: nodes()) {
337 const auto [amin, minval] = cpt(i).argmin();
338 if (minval < (GUM_SCALAR)0.0) {
340 s << "Variable " << variable(i).name() << " : P(" << *(amin.begin()) << ") < 0.0";
341 comments.push_back(s.str());
342 }
343 }
344 // <1
345 for (const auto i: nodes()) {
346 const auto [amax, maxval] = cpt(i).argmax();
347 if (maxval > (GUM_SCALAR)1.0) {
349 s << "Variable " << variable(i).name() << " : P(" << *(amax.begin()) << ") > 1.0";
350 comments.push_back(s.str());
351 }
352 }
353
354 // CHECKING distributions sum to 1
355 for (const auto i: nodes()) {
356 const auto p = cpt(i).sumOut({&variable(i)});
357 const auto [amin, minval] = p.argmin();
358 if (minval < (GUM_SCALAR)(1.0 - epsilon)) {
360 s << "Variable " << variable(i).name() << " : ";
361 if (!parents(i).empty()) s << "with (at least) parents " << *(amin.begin()) << ", ";
362 s << "the CPT sum to less than 1";
363 if (minval > (GUM_SCALAR)(1.0 - error_epsilon)) s << " (normalization problem ?)";
364 s << ".";
365 comments.push_back(s.str());
366 continue;
367 }
368 const auto [amax, maxval] = p.argmax();
369 if (maxval > (GUM_SCALAR)(1.0 + epsilon)) {
371 s << "Variable " << variable(i).name() << " : ";
372 if (!parents(i).empty()) s << "with (at least) parents " << *(amax.begin()) << ", ";
373 s << "the CPT sum to more than 1";
374 if (maxval < (GUM_SCALAR)(1.0 + error_epsilon)) s << " (normalization problem ?)";
375 s << ".";
376 comments.push_back(s.str());
377 }
378 }
379
380 return comments;
381 }
const NodeSet & parents(const NodeId id) const
returns the set of nodes with arc ingoing to a given node
const DiscreteVariable & variable(NodeId id) const override
Returns a constant reference over a variable given its node id.
virtual bool empty() const
Return true if this graphical model is empty.
Class representing the minimal interface for Bayesian network with no numerical data.
Definition IBayesNet.h:79
virtual const Tensor< GUM_SCALAR > & cpt(NodeId varId) const =0
Returns the CPT of a variable.

References gum::config(), cpt(), gum::GraphicalModel::empty(), gum::Configuration::epsilonCoarse(), gum::Configuration::epsilonStandard(), gum::DAGmodel::nodes(), gum::DAGmodel::parents(), and gum::DiscreteGraphicalModel::variable().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ children() [1/4]

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

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
idthe node which is the tail of an arc with the returned nodes
namethe name of the node which is the tail of an arc with the returned nodes
Exceptions
NotFoundif the node does not exist in the model

Definition at line 109 of file DAGmodel_inl.h.

109 {
110 const NodeSet& res = dag_.children(id);
111 if (res.empty()) _checkNodeExists_(id);
112 return res;
113 }
NodeSet children(const NodeSet &ids) const
returns the set of nodes which consists in the node and its parents returns the set of children of a ...
Set< NodeId > NodeSet
Some typdefs and define for shortcuts ...

Referenced by 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
inherited

returns the children of a set of nodes

Exceptions
NotFoundif one of the nodes does not exist in the model

Definition at line 119 of file DAGmodel_inl.h.

119 {
120 for (const auto id: ids)
122 return dag_.children(ids);
123 }
std::vector< NodeId > ids(const std::vector< std::string > &names) const
transform a vector of names into a vector of nodeId

References _checkNodeExists_(), 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
inherited

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Definition at line 126 of file DAGmodel_inl.h.

126 {
127 return dag_.children(nodeset(names));
128 }
std::vector< std::string > names(const std::vector< NodeId > &ids) const
transform a vector of NodeId in a vector of names
NodeSet nodeset(const std::vector< std::string > &names) const
transform a vector of names into a NodeSet

References gum::ArcGraphPart::children(), dag_, 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
inherited

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Definition at line 115 of file DAGmodel_inl.h.

115 {
116 return dag_.children(idFromName(name));
117 }

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

104 {
105 Instantiation I;
106
107 for (const auto node: nodes())
108 I << variable(node);
109
110 return I;
111 }
virtual const NodeGraphPart & nodes() const =0
Returns the number of variables in this Directed Graphical Model.

References nodes(), and variable().

Referenced by nodes().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ connectedComponents()

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

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

Definition at line 153 of file DAGmodel_inl.h.

153 {
154 return dag_.connectedComponents();
155 }
NodeProperty< NodeId > connectedComponents() const
returns a property {node:id of weakly connected component}

References gum::DiGraph::connectedComponents(), and dag_.

Here is the call graph for this function:

◆ cpt()

template<GUM_Numeric GUM_SCALAR>
const Tensor< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::cpt ( NodeId varId) const
overridevirtual

See gum::IBaseBayesNet::cpt().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 107 of file instanceBayesNet_tpl.h.

107 {
108 return _get_(varId).cpf();
109 }
const PRMClassElement< GUM_SCALAR > & _get_(NodeId id) const
Private getter with type checking in case the id is not a formal PRMAttribute<GUM_SCALAR>.

References _get_().

Here is the call graph for this function:

◆ dag()

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

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.

61 {
62 DAG g = dag_;
63 _nameNodes_(g);
64 return g;
65 }
void _nameNodes_(NodeGraphPart &g) const
Names every node of g using variable(id).name() for each node id in 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
inherited

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
idthe node which is the tail of a directed path with the returned nodes
namethe name of the node which is the tail of a directed path with the returned nodes
Exceptions
NotFoundif the node does not exist in the model

Definition at line 157 of file DAGmodel_inl.h.

157 {
158 auto res = dag_.descendants(id);
159 if (res.empty()) _checkNodeExists_(id);
160 return res;
161 }
NodeSet descendants(NodeId id) const
returns the set of all descendants of id (nodes reachable from id)

References _checkNodeExists_(), dag_, gum::DiGraph::descendants(), and gum::Set< Key >::empty().

Here is the call graph for this function:

◆ descendants() [2/2]

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Definition at line 163 of file DAGmodel_inl.h.

163 {
164 return dag_.descendants(idFromName(name));
165 }

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

Here is the call graph for this function:

◆ dim()

template<GUM_Numeric GUM_SCALAR>
Size gum::IBayesNet< GUM_SCALAR >::dim ( ) const
inherited

Returns the dimension (the number of free parameters) in this bayes net.

\( dim(G)=\sum_{i \in nodes} ((r_i-1)\cdot q_i) \) where \( r_i \) is the number of instantiations of node \( i \) and \( q_i \) is the number of instantiations of its parents.

Definition at line 116 of file IBayesNet_tpl.h.

116 {
117 Size dim = 0;
118
119 for (auto node: nodes()) {
120 Size q = 1;
121
122 for (auto parent: parents(node))
123 q *= variable(parent).domainSize();
124
125 dim += (variable(node).domainSize() - 1) * q;
126 }
127
128 return dim;
129 }
Size dim() const
Returns the dimension (the number of free parameters) in this bayes net.

References dim(), gum::DAGmodel::nodes(), gum::DAGmodel::parents(), and gum::DiscreteGraphicalModel::variable().

Referenced by cpt(), and dim().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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; }
virtual Size size() const =0
Returns the number of variables in this Directed Graphical Model.

References size().

Referenced by gum::IBayesNet< GUM_SCALAR >::check(), gum::BayesNet< GUM_SCALAR >::clear(), and size().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evEq()

template<GUM_Numeric GUM_SCALAR>
Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evEq ( std::string_view name,
double value ) const
inherited
Returns
a Tensor for a (numerical) discrete variable representing an evidence with a float as observed value

Definition at line 384 of file IBayesNet_tpl.h.

384 {
386 }
const DiscreteVariable & variableFromName(std::string_view name) const override
Returns a constant reference over a variable given its name.
static Tensor< GUM_SCALAR > evEq(const DiscreteVariable &v, double val)
numerical evidence generator

References gum::Tensor< GUM_SCALAR >::evEq(), and gum::DiscreteGraphicalModel::variableFromName().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evGt()

template<GUM_Numeric GUM_SCALAR>
Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evGt ( std::string_view name,
double value ) const
inherited
Returns
a Tensor for a (numerical) discrete variable representing an evidence with an observed value greater than the parameter

Definition at line 395 of file IBayesNet_tpl.h.

395 {
397 }
static Tensor< GUM_SCALAR > evGt(const DiscreteVariable &v, double val)
numerical evidence generator

References gum::Tensor< GUM_SCALAR >::evGt(), and gum::DiscreteGraphicalModel::variableFromName().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evIn()

template<GUM_Numeric GUM_SCALAR>
Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evIn ( std::string_view name,
double val1,
double val2 ) const
inherited
Returns
a Tensor for a (numerical) discrete variable representing an evidence with a interval of float as observed value

Definition at line 390 of file IBayesNet_tpl.h.

390 {
392 }
static Tensor< GUM_SCALAR > evIn(const DiscreteVariable &v, double val1, double val2)
numerical evidence generator

References gum::Tensor< GUM_SCALAR >::evIn(), and gum::DiscreteGraphicalModel::variableFromName().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evLt()

template<GUM_Numeric GUM_SCALAR>
Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evLt ( std::string_view name,
double value ) const
inherited
Returns
a Tensor for a (numerical) discrete variable representing an evidence with an observed value less than the parameter

Definition at line 400 of file IBayesNet_tpl.h.

400 {
402 }
static Tensor< GUM_SCALAR > evLt(const DiscreteVariable &v, double val)
numerical evidence generator

References gum::Tensor< GUM_SCALAR >::evLt(), and gum::DiscreteGraphicalModel::variableFromName().

Referenced by cpt().

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
finalvirtualinherited

Return true if this node exists in this graphical model.

Implements gum::GraphicalModel.

Definition at line 141 of file DAGmodel_inl.h.

141{ return dag_.exists(node); }

References dag_, and gum::NodeGraphPart::exists().

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 call graph for this function:
Here is the caller graph for this function:

◆ exists() [2/2]

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

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 143 of file DAGmodel_inl.h.

143 {
144 return variableNodeMap().exists(name);
145 }
const VariableNodeMap & variableNodeMap() const override
Returns a constant reference to the VariableNodeMap of this model.
bool exists(NodeId id) const
Return true if id matches a node.

References gum::VariableNodeMap::exists(), and gum::DiscreteGraphicalModel::variableNodeMap().

Here is the call graph for this function:

◆ existsArc() [1/2]

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe 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.

75 {
76 return dag_.existsArc(tail, head);
77 }
bool existsArc(const Arc &arc) const
indicates whether a given arc exists

References dag_, and gum::ArcGraphPart::existsArc().

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

Here is the call graph for this function:
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
inherited

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe 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.

79 {
80 return existsArc(idFromName(nametail), idFromName(namehead));
81 }
bool existsArc(const NodeId tail, const NodeId head) const
return true if the arc tail->head exists in the DAGmodel

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.

170 {
171 return _propertiesMap_.exists(name);
172 }
bool exists(const Key &key) const
Checks whether there exists an element with a given key in the hashtable.

References _propertiesMap_, and gum::HashTable< Key, Val >::exists().

Here is the call graph for this function:

◆ family() [1/2]

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

returns the parents of a node and the node

Parameters
idthe node which is the head of an arc with the returned nodes
namethe name of the node the node which is the head of an arc with the returned nodes
Exceptions
NotFoundif the node does not exist in the model

Implements gum::GraphicalModel.

Definition at line 100 of file DAGmodel_inl.h.

100 {
102 return dag_.family(id);
103 }
NodeSet family(NodeId id) const
returns { id } ∪ parents(id)

References _checkNodeExists_(), dag_, and gum::DiGraph::family().

Here is the call graph for this function:

◆ family() [2/2]

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Implements gum::GraphicalModel.

Definition at line 105 of file DAGmodel_inl.h.

105 {
106 return dag_.family(idFromName(name));
107 }

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

Here is the call graph for this function:

◆ hasSameStructure()

bool gum::DAGmodel::hasSameStructure ( const DAGmodel & other) const
inherited
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.

87 {
88 if (this == &other) return true;
89
90 if (size() != other.size()) return false;
91
92 if (sizeArcs() != other.sizeArcs()) return false;
93
94 for (const auto& nid: nodes()) {
95 if (!other.exists(variable(nid).name())) return false;
96 }
97
98 for (const auto& arc: arcs()) {
99 if (!other.arcs().exists(Arc(other.idFromName(variable(arc.tail()).name()),
100 other.idFromName(variable(arc.head()).name()))))
101 return false;
102 }
103
104 return true;
105 }
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 std::string & name() const
returns the name of the variable

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

Here is the call graph for this function:

◆ idFromName()

template<GUM_Numeric GUM_SCALAR>
NodeId gum::prm::InstanceBayesNet< GUM_SCALAR >::idFromName ( std::string_view name) const
overridevirtual

See gum::IBaseBayesNet::idFromName().

Reimplemented from gum::DiscreteGraphicalModel.

Definition at line 127 of file instanceBayesNet_tpl.h.

127 {
128 return _get_(name).id();
129 }

References _get_().

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

139 {
140 std::vector< NodeId > res;
141 const VariableNodeMap& v = variableNodeMap();
142 std::transform(names.cbegin(),
143 names.cend(),
144 std::back_inserter(res),
145 [&v](const std::string& n) { return v.idFromName(n); });
146 return res;
147 }
virtual const VariableNodeMap & variableNodeMap() const =0
Returns a constant reference to the VariableNodeMap of this Graphical Model.

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
inherited

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
finalvirtualinherited

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

Implements gum::GraphicalModel.

Definition at line 192 of file DAGmodel_inl.h.

192 {
193 return dag_.dSeparation(X, Y, Z);
194 }
bool dSeparation(NodeId X, NodeId Y, const NodeSet &Z) const
check if node X and node Y are independent given nodes Z (in the sense of d-separation)
Definition DAG.cpp:80

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

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

Parameters
nodesthe set of nodeId
nodenamesthe vector of names of nodes
Returns
the moralized ancestral graph

Definition at line 220 of file DAGmodel_inl.h.

222 {
223 return isIndependent(nodeset(Xnames), nodeset(Ynames), nodeset(Znames));
224 }
bool isIndependent(NodeId X, NodeId Y, const NodeSet &Z) const final
check if node X and node Y are independent given nodes Z

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

Here is the call graph for this function:

◆ isIndependent() [3/4]

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

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

Implements gum::GraphicalModel.

Definition at line 188 of file DAGmodel_inl.h.

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

References dag_, and gum::DAG::dSeparation().

Referenced by isIndependent().

Here is the call graph for this function:
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
inherited

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

Parameters
nodesthe set of nodeId
nodenamesthe vector of names of nodes
Returns
the moralized ancestral graph

Definition at line 214 of file DAGmodel_inl.h.

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

◆ jointProbability()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::jointProbability ( const Instantiation & i) const
inherited

Compute a parameter of the joint probability for the BN (given an instantiation of the vars).

Warning
a variable not present in the instantiation is assumed to be instantiated to 0.

Definition at line 236 of file IBayesNet_tpl.h.

236 {
237 auto value = (GUM_SCALAR)1.0;
238
240
241 for (auto node: nodes()) {
242 if ((tmp = cpt(node)[i]) == (GUM_SCALAR)0) { return (GUM_SCALAR)0; }
243
244 value *= tmp;
245 }
246
247 return value;
248 }

Referenced by cpt().

Here is the caller graph for this function:

◆ log10DomainSize()

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

Definition at line 93 of file graphicalModel_inl.h.

93 {
94 double dSize = 0.0;
95
96 for (const auto node: nodes()) {
97 dSize += std::log10(variable(node).domainSize());
98 }
99
100 return dSize;
101 }

References nodes().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ log2JointProbability()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::log2JointProbability ( const Instantiation & i) const
inherited

Compute a parameter of the log joint probability for the BN (given an instantiation of the vars).

Compute a parameter of the joint probability for the BN (given an instantiation of the vars).

Warning
a variable not present in the instantiation is assumed to be instantiated to 0.

Definition at line 254 of file IBayesNet_tpl.h.

254 {
255 auto value = (GUM_SCALAR)0.0;
256
258
259 for (auto node: nodes()) {
260 if ((tmp = cpt(node)[i]) == (GUM_SCALAR)0) {
262 }
263
264 value += std::log2(cpt(node)[i]);
265 }
266
267 return value;
268 }

Referenced by cpt().

Here is the caller graph for this function:

◆ maxNonOneParam()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::maxNonOneParam ( ) const
inherited
Returns
the biggest value (not equal to 1) in the CPTs of *this
Warning
can return one if no other value in the CPTs than one....

Definition at line 172 of file IBayesNet_tpl.h.

172 {
173 GUM_SCALAR res = 0.0;
174 for (auto node: nodes()) {
175 auto v = cpt(node).maxNonOne();
176 if (v > res) { res = v; }
177 }
178 return res;
179 }

References cpt(), and gum::DAGmodel::nodes().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ maxParam()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::maxParam ( ) const
inherited
Returns
the biggest value in the CPTs of *this

Definition at line 152 of file IBayesNet_tpl.h.

152 {
153 GUM_SCALAR res = 1.0;
154 for (auto node: nodes()) {
155 auto v = cpt(node).max();
156 if (v > res) { res = v; }
157 }
158 return res;
159 }

References cpt(), and gum::DAGmodel::nodes().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ maxVarDomainSize()

template<GUM_Numeric GUM_SCALAR>
Size gum::IBayesNet< GUM_SCALAR >::maxVarDomainSize ( ) const
inherited
Returns
the biggest domainSize among the variables of *this

Definition at line 132 of file IBayesNet_tpl.h.

132 {
133 Size res = 0;
134 for (auto node: nodes()) {
135 auto v = variable(node).domainSize();
136 if (v > res) { res = v; }
137 }
138 return res;
139 }

References gum::DAGmodel::nodes(), and gum::DiscreteGraphicalModel::variable().

Referenced by cpt(), and gum::ImportanceSampling< GUM_SCALAR >::onContextualize_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ memoryFootprint()

template<GUM_Numeric GUM_SCALAR>
Size gum::IBayesNet< GUM_SCALAR >::memoryFootprint ( ) const
inherited

compute the (approximated) footprint in memory of the model (the footprints of CPTs)

Returns
the size in bytes

Definition at line 182 of file IBayesNet_tpl.h.

182 {
183 Size usedMem = 0;
184
185 for (auto node: nodes())
187 return usedMem;
188 }
Size memoryFootprint() const
compute the (approximated) footprint in memory of the model (the footprints of CPTs)

References cpt(), and gum::DAGmodel::nodes().

Referenced by cpt().

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
inherited

Definition at line 200 of file DAGmodel_inl.h.

200 {
201 return dag_.minimalCondSet(targets, soids);
202 }
NodeSet minimalCondSet(NodeId target, const NodeSet &soids) const
Definition DAG.cpp:88

References dag_, and gum::DAG::minimalCondSet().

Here is the call graph for this function:

◆ minimalCondSet() [2/4]

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

Definition at line 209 of file DAGmodel_inl.h.

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

◆ minimalCondSet() [3/4]

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

Definition at line 196 of file DAGmodel_inl.h.

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

References dag_, and gum::DAG::minimalCondSet().

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

Here is the call graph for this function:
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
inherited

Definition at line 204 of file DAGmodel_inl.h.

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

◆ minNonZeroParam()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::minNonZeroParam ( ) const
inherited
Returns
the smallest value (not equal to 0) in the CPTs of *this
Warning
can return 0 if no other value in the CPTs than 0...

Definition at line 162 of file IBayesNet_tpl.h.

162 {
163 GUM_SCALAR res = 1.0;
164 for (auto node: nodes()) {
165 auto v = cpt(node).minNonZero();
166 if (v < res) { res = v; }
167 }
168 return res;
169 }

Referenced by cpt(), and gum::ImportanceSampling< GUM_SCALAR >::onContextualize_().

Here is the caller graph for this function:

◆ minParam()

template<GUM_Numeric GUM_SCALAR>
GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::minParam ( ) const
inherited
Returns
the smallest value in the CPTs of *this

Definition at line 142 of file IBayesNet_tpl.h.

142 {
143 GUM_SCALAR res = 1.0;
144 for (auto node: nodes()) {
145 auto v = cpt(node).min();
146 if (v < res) { res = v; }
147 }
148 return res;
149 }

References cpt(), and gum::DAGmodel::nodes().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ modalities()

template<GUM_Numeric GUM_SCALAR>
const NodeProperty< Size > & gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities ( ) const

See gum::IBaseBayesNet::cpt().

Definition at line 150 of file instanceBayesNet_tpl.h.

150 {
151 if (_modalities_.empty()) {
152 for (const auto node: this->nodes()) {
154 }
155 }
156
157 return _modalities_;
158 }
NodeProperty< Size > _modalities_

References _modalities_, gum::DAGmodel::nodes(), and variable().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ moralGraph()

UndiGraph gum::DAGmodel::moralGraph ( ) const
inherited

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

Definition at line 81 of file DAGmodel.cpp.

81 {
82 auto g = dag_.moralGraph();
83 _nameNodes_(g);
84 return g;
85 }
UndiGraph moralGraph() const
build a UndiGraph by moralizing the dag
Definition DAG.cpp:74

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

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
inherited

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

Parameters
nodesthe set of nodeId
nodenamesthe vector of names of nodes
Returns
the moralized ancestral graph

Definition at line 182 of file DAGmodel_inl.h.

182 {
184 _nameNodes_(g);
185 return g;
186 }
UndiGraph moralizedAncestralGraph(const NodeSet &nodes) const
build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes
Definition DAG.cpp:76

Referenced by moralizedAncestralGraph().

Here is the caller graph for this function:

◆ moralizedAncestralGraph() [2/2]

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

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

Parameters
nodesthe set of nodeId
nodenamesthe vector of names of nodes
Returns
the moralized ancestral graph

Definition at line 178 of file DAGmodel_inl.h.

178 {
179 return moralizedAncestralGraph(nodeset(nodenames));
180 }
UndiGraph moralizedAncestralGraph(const NodeSet &nodes) const
build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes

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.

129 {
130 const VariableNodeMap& v = variableNodeMap();
131 std::vector< std::string > res;
132 for (auto n: ids) {
133 res.push_back(v.name(n));
134 }
135 return res;
136 }

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.

117 {
118 std::vector< std::string > res;
119 const VariableNodeMap& v = variableNodeMap();
120
121 std::ranges::transform(ids, std::back_inserter(res), [&v](const NodeId n) {
122 return v[n].name();
123 });
124
125 return res;
126 }
Size NodeId
Type for node ids.

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

template<GUM_Numeric GUM_SCALAR>
NodeId gum::prm::InstanceBayesNet< GUM_SCALAR >::nodeId ( const DiscreteVariable & var) const
overridevirtual

See gum::IBaseBayesNet::nodeId().

Reimplemented from gum::DiscreteGraphicalModel.

Definition at line 122 of file instanceBayesNet_tpl.h.

122 {
123 return _varNodeMap_[&var]->id();
124 }

References _varNodeMap_.

◆ nodes()

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

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 147 of file DAGmodel_inl.h.

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

References dag_.

Referenced by gum::BayesNetFragment< GUM_SCALAR >::BayesNetFragment(), gum::Estimator< GUM_SCALAR >::Estimator(), gum::BayesNetFragment< GUM_SCALAR >::~BayesNetFragment(), gum::EssentialGraph::_buildEssentialGraph_(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::_verticesSampling_(), gum::BayesNet< GUM_SCALAR >::beginTopologyTransformation(), gum::InfluenceDiagram< GUM_SCALAR >::beginTopologyTransformation(), gum::IBayesNet< GUM_SCALAR >::check(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::BayesNet< GUM_SCALAR >::clear(), gum::InfluenceDiagram< GUM_SCALAR >::copyStructureAndTables_(), gum::IBayesNet< GUM_SCALAR >::dim(), gum::BayesNet< GUM_SCALAR >::endTopologyTransformation(), gum::InfluenceDiagram< GUM_SCALAR >::endTopologyTransformation(), gum::InfluenceDiagram< GUM_SCALAR >::fastPrototype(), gum::BayesNet< GUM_SCALAR >::generateCPTs(), gum::getMaxModality(), hasSameStructure(), gum::IBayesNet< GUM_SCALAR >::maxNonOneParam(), gum::IBayesNet< GUM_SCALAR >::maxParam(), gum::IBayesNet< GUM_SCALAR >::maxVarDomainSize(), gum::IBayesNet< GUM_SCALAR >::memoryFootprint(), gum::IBayesNet< GUM_SCALAR >::minParam(), gum::prm::ClassBayesNet< GUM_SCALAR >::modalities(), gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities(), gum::IBayesNet< GUM_SCALAR >::operator==(), gum::InfluenceDiagram< GUM_SCALAR >::operator==(), gum::Estimator< GUM_SCALAR >::setFromBN(), gum::BayesNetFragment< GUM_SCALAR >::toBN(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot(), and gum::ImportanceSampling< GUM_SCALAR >::unsharpenBN_().

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

102 {
103 NodeSet res;
104 for (const auto& name: names) {
105 res.insert(idFromName(name));
106 }
107 return res;
108 }
virtual NodeId idFromName(std::string_view name) const =0
Getter by name.

References idFromName(), gum::Set< Key >::insert(), and names().

Referenced by gum::DAGmodel::children(), exists(), gum::DAGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::UGmodel::isIndependent(), gum::DAGmodel::moralizedAncestralGraph(), and gum::DAGmodel::parents().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

template<GUM_Numeric GUM_SCALAR>
InstanceBayesNet< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::operator= ( const InstanceBayesNet< GUM_SCALAR > & from)

Copy operator.

Definition at line 96 of file instanceBayesNet_tpl.h.

96 {
97 if (this != &from) {
99
101 }
102
103 return *this;
104 }
IBayesNet< GUM_SCALAR > & operator=(const IBayesNet< GUM_SCALAR > &source)
Copy operator.

References InstanceBayesNet(), _varNodeMap_, and gum::IBayesNet< GUM_SCALAR >::operator=().

Here is the call graph for this function:

◆ operator==()

template<GUM_Numeric GUM_SCALAR>
bool gum::IBayesNet< GUM_SCALAR >::operator== ( const IBayesNet< GUM_SCALAR > & from) const
inherited

This operator compares 2 BNs !

Warning
To identify nodes between BNs, it is assumed that they share the same name.
Returns
true if the src and this are equal.

Definition at line 271 of file IBayesNet_tpl.h.

271 {
272 if (size() != from.size()) { return false; }
273
274 if (sizeArcs() != from.sizeArcs()) { return false; }
275
276 for (auto node: nodes()) {
277 const auto& v1 = variable(node);
278 if (!from.exists(v1.name())) { return false; }
279 const auto& v2 = from.variableFromName(v1.name());
280 if (v1 != v2) { return false; }
281 }
282
283 for (auto node: nodes()) {
285
286 if (cpt(node).nbrDim() != from.cpt(fromnode).nbrDim()) { return false; }
287
288 if (cpt(node).domainSize() != from.cpt(fromnode).domainSize()) { return false; }
289
290 for (Idx i = 0; i < cpt(node).nbrDim(); ++i) {
291 if (!from.cpt(fromnode).contains(from.variableFromName(cpt(node).variable(i).name()))) {
292 return false;
293 }
294 }
295
298
300 for (i.setFirst(); !i.end(); i.inc()) {
301 for (Idx indice = 0; indice < cpt(node).nbrDim(); ++indice) {
302 const DiscreteVariable* p = &(i.variable(indice));
303 j.chgVal(j.pos(from.variableFromName(p->name())), i.val(*p));
304 }
305
306 if (cmp(cpt(node).get(i), from.cpt(fromnode).get(j))) { return false; }
307 }
308 }
309
310 return true;
311 }

References IBayesNet(), gum::Instantiation::chgVal(), cpt(), gum::Instantiation::end(), gum::DAGmodel::exists(), gum::DiscreteGraphicalModel::idFromName(), gum::Instantiation::inc(), gum::Variable::name(), gum::Instantiation::nbrDim(), gum::DAGmodel::nodes(), gum::Instantiation::pos(), gum::Instantiation::setFirst(), gum::DAGmodel::size(), gum::DAGmodel::sizeArcs(), gum::Instantiation::val(), gum::DiscreteGraphicalModel::variable(), gum::Instantiation::variable(), and gum::DiscreteGraphicalModel::variableFromName().

Referenced by cpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parents() [1/4]

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

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
idthe node which is the head of an arc with the returned nodes
namethe name of the node the node which is the head of an arc with the returned nodes
Exceptions
NotFoundif the node does not exist in the model

Definition at line 89 of file DAGmodel_inl.h.

89 {
90 const NodeSet& res = dag_.parents(id);
91 if (res.empty()) _checkNodeExists_(id);
92 return res;
93 }
const NodeSet & parents(NodeId id) const
returns the set of nodes with arc ingoing to a given node

References _checkNodeExists_(), dag_, gum::Set< Key >::empty(), and gum::ArcGraphPart::parents().

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_(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parents() [2/4]

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

returns the parents of a set of nodes

Exceptions
NotFoundif one of the nodes does not exist in the model

Definition at line 130 of file DAGmodel_inl.h.

130 {
131 for (const auto id: ids)
133 return dag_.parents(ids);
134 }

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe 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.

137 {
138 return dag_.parents(nodeset(names));
139 }

References dag_, gum::GraphicalModel::names(), gum::GraphicalModel::nodeset(), and gum::ArcGraphPart::parents().

Here is the call graph for this function:

◆ parents() [4/4]

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

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

Parameters
tailthe nodeId (or the name) of the tail in tail->head
headthe nodeId (or the name) of the head in tail->head
Returns
true if the arc exists

Definition at line 96 of file DAGmodel_inl.h.

96 {
97 return dag_.parents(idFromName(name));
98 }

References dag_, gum::DiscreteGraphicalModel::idFromName(), and gum::ArcGraphPart::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.

79 {
80 std::vector< std::string > prop;
81 for (const auto& [p, v]: _propertiesMap_)
82 prop.push_back(p);
83 return prop;
84 }

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
NotFoundRaised if no name property is found.

Definition at line 60 of file graphicalModel_inl.h.

60 {
61 auto p = _properties_().tryGet(name);
62 if (!p) { GUM_ERROR(NotFound, "The following property does not exists: " << name) }
63 return *p;
64 }
const HashTable< std::string, std::string > & _properties_() const
Return the properties of this Directed Graphical Model.
optional_ref< Val > tryGet(const Key &key)
Returns a pointer to the value associated with a given key, or nullptr if the key does not exist.

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.

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

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

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

87 {
88 if (auto p = _propertiesMap_.tryGet(name)) *p = value;
89 else _propertiesMap_.insert(std::string(name), std::string(value));
90 }
value_type & insert(const Key &key, const Val &val)
Adds a new element (actually a copy of this element) into the hash table.

References _propertiesMap_, gum::HashTable< Key, Val >::insert(), and gum::HashTable< Key, Val >::tryGet().

Referenced by gum::IBayesNet< GUM_SCALAR >::IBayesNet(), gum::IMarkovRandomField< GUM_SCALAR >::IMarkovRandomField(), gum::BayesNet< GUM_SCALAR >::fastPrototype(), and gum::InfluenceDiagram< GUM_SCALAR >::fastPrototype().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ size()

INLINE Size gum::DAGmodel::size ( ) const
finalvirtualinherited

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(); }
Size size() const
alias for sizeNodes

References dag_, and gum::NodeGraphPart::size().

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 call graph for this function:
Here is the caller graph for this function:

◆ sizeArcs()

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

Returns the number of arcs in this Directed Graphical Model.

Definition at line 71 of file DAGmodel_inl.h.

71{ return dag_.sizeArcs(); }
Size sizeArcs() const
indicates the number of arcs stored within the ArcGraphPart

References dag_, and gum::ArcGraphPart::sizeArcs().

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 call graph for this function:
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
sthe stream
dSizethe log10domainSize
dimthe dimension
usedMemthe memory needed for the params

Definition at line 110 of file graphicalModel.cpp.

110 {
111 std::string result;
112 if (dSize > 6) result = std::format("domainSize: 10^{:.6g}", dSize);
113 else result = std::format("domainSize: {}", (long long)std::round(std::pow(10.0, dSize)));
114
115 result += std::format(", dim: {}, mem: ", dim);
116
117 if (const Size go = usedMem / (1024 * 1024 * 1024); go > 0) result += std::format("{}Go ", go);
118 if (const Size mo = (usedMem / (1024 * 1024)) % 1024; mo > 0)
119 result += std::format("{}Mo ", mo);
120 if (const Size ko = (usedMem / 1024) % 1024; ko > 0) result += std::format("{}Ko ", ko);
121 result += std::format("{}o", usedMem % 1024);
122 return result;
123 }
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition types.h:74

Referenced by isIndependent().

Here is the caller graph for this function:

◆ toDot() [1/2]

template<GUM_Numeric GUM_SCALAR>
std::string gum::IBayesNet< GUM_SCALAR >::toDot ( const dot::DotOptions & options) const
virtualinherited

A dot representation of this IBayesNet, with the options given by the caller.

The nodes are named after the variables, with the tooltip "(id) name"; the options are indexed by the identifiers of the nodes.

Reimplemented in gum::BayesNetFragment< GUM_SCALAR >.

Definition at line 205 of file IBayesNet_tpl.h.

205 {
206 const auto style = dot::DotStyle::read();
207 dot::DotWriter writer(true, this->propertyWithDefault("name", ""));
209
210 for (const auto node: nodes()) {
211 const auto& name = variable(node).name();
212 writer.node(name,
214 options.node(node),
215 "",
216 "(" + std::to_string(node) + ") " + name));
217 }
218
219 for (const auto& arc: arcs()) {
220 auto attributes = dot::arcAttributes(options.arc(arc.tail(), arc.head()));
222 "tooltip",
223 std::to_string(arc.tail()) + "&nbsp;&rarr;&nbsp;"
224 + std::to_string(arc.head()));
225 dot::addDefaultAttribute(attributes, "fontsize", "10");
226 writer.edge(variable(arc.tail()).name(), variable(arc.head()).name(), attributes);
227 }
228
229 return writer.str();
230 }
const std::string & propertyWithDefault(std::string_view name, const std::string &byDefault) const
Return the value of the property name of this GraphicalModel.
void writePreamble(DotWriter &writer, const DotStyle &style, const DotOptions &options, std::string_view defaultLabel)
Writes the beginning of a graph, as pyAgrum displays it.
void addDefaultAttribute(DotAttributes &attributes, std::string_view key, std::string_view value)
Adds an attribute at the beginning of the list, unless the list already gives a value for this key : ...
DotAttributes arcAttributes(const DotArcOptions *options)
The attributes of an arc or an edge given by the options : color, penwidth, label,...
static DotStyle read()
the style of the graphs of the section notebook
Definition dotStyle.cpp:89

◆ toDot() [2/2]

template<GUM_Numeric GUM_SCALAR>
std::string gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot ( ) const
overridevirtual
Returns
Returns a dot representation of this IBayesNet.

Reimplemented from gum::IBayesNet< GUM_SCALAR >.

Definition at line 161 of file instanceBayesNet_tpl.h.

161 {
162 std::string tab = " ";
164 output << std::format("digraph \"{}\" {{\n", _inst_->name());
165
166 for (const auto node: this->nodes()) {
167 if (this->children(node).size() > 0) {
168 const NodeSet& children = this->children(node);
169
170 for (const auto chi: children) {
171 output << std::format("{}\"{}\" -> \"{}\";\n",
172 tab,
173 variable(node).name(),
174 variable(chi).name());
175 }
176 } else if (this->parents(node).size() == 0) {
177 output << std::format("{}\"{}\";\n", tab, variable(node).name());
178 }
179 }
180
181 output << "}\n";
182 return output.str();
183 }
const NodeSet & children(const NodeId id) const
returns the set of nodes with arc outgoing from a given node

References _inst_, gum::DAGmodel::children(), gum::DAGmodel::nodes(), gum::DAGmodel::parents(), gum::DAGmodel::size(), and variable().

Here is the call graph for this function:

◆ topologicalOrder()

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

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

Parameters
clearIf false returns the previously created topology.

Definition at line 151 of file DAGmodel_inl.h.

151{ return dag_.topologicalOrder(); }
Sequence< NodeId > topologicalOrder() const
Build and return a topological order.

References dag_, and gum::DiGraph::topologicalOrder().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString()

template<GUM_Numeric GUM_SCALAR>
std::string gum::IBayesNet< GUM_SCALAR >::toString ( ) const
inherited
Returns
Returns a string representation of this IBayesNet.

Definition at line 191 of file IBayesNet_tpl.h.

191 {
193 s << std::format("BN{{nodes: {}, arcs: {}, ", size(), dag().sizeArcs());
195 s << "}";
196 return s.str();
197 }
DAG dag() const
Returns a named copy of the internal DAG: each node id is assigned the name of the corresponding vari...
double log10DomainSize() const
static std::string spaceCplxToString(double dSize, int dim, Size usedMem)
send to the stream the space complexity with 3 parametrs

Referenced by cpt(), and gum::operator<<().

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.

81 {
82 auto const time = std::chrono::time_point_cast< std::chrono::milliseconds >(
83 std::chrono::system_clock::now());
84 auto const currentdate = std::format("{:%Y-%m-%d %T}", time);
85
86 const std::string currentSoftware = "aGrUM " GUM_VERSION;
87 if (auto software = _propertiesMap_.tryGet("software")) {
88 *software = currentSoftware;
89 } else {
90 _propertiesMap_.insert("software", currentSoftware);
91 }
92
93 if (!_propertiesMap_.tryGet("creation")) { _propertiesMap_.insert("creation", currentdate); }
94
95 if (auto lastModification = _propertiesMap_.tryGet("lastModification")) {
96 *lastModification = currentdate;
97 } else {
98 _propertiesMap_.insert("lastModification", currentdate);
99 }
100 }

References _propertiesMap_, gum::HashTable< Key, Val >::insert(), and gum::HashTable< Key, Val >::tryGet().

Here is the call graph for this function:

◆ variable()

template<GUM_Numeric GUM_SCALAR>
const DiscreteVariable & gum::prm::InstanceBayesNet< GUM_SCALAR >::variable ( NodeId id) const
overridevirtual

See gum::IBaseBayesNet::variable().

Reimplemented from gum::DiscreteGraphicalModel.

Definition at line 117 of file instanceBayesNet_tpl.h.

117 {
118 return _get_(id).type().variable();
119 }

References _get_().

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesDownward_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesUpward_(), gum::prm::SVE< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVE< GUM_SCALAR >::_variableElimination_(), modalities(), and toDot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ variableFromName()

template<GUM_Numeric GUM_SCALAR>
const DiscreteVariable & gum::prm::InstanceBayesNet< GUM_SCALAR >::variableFromName ( std::string_view name) const
overridevirtual

See gum::IBaseBayesNet::variableFromName().

Reimplemented from gum::DiscreteGraphicalModel.

Definition at line 133 of file instanceBayesNet_tpl.h.

133 {
134 return _get_(name).type().variable();
135 }

References _get_().

Here is the call graph for this function:

◆ variableNodeMap()

template<GUM_Numeric GUM_SCALAR>
const VariableNodeMap & gum::prm::InstanceBayesNet< GUM_SCALAR >::variableNodeMap ( ) const
overridevirtual

See gum::IBaseBayesNet::variableNodeMap().

Reimplemented from gum::DiscreteGraphicalModel.

Definition at line 112 of file instanceBayesNet_tpl.h.

112 {
113 GUM_ERROR(NotFound, "no VariableNodeMap in an InstanceBayesNet")
114 }

References GUM_ERROR.

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

160 {
161 VariableSet s;
162 const VariableNodeMap& v = variableNodeMap();
163 for (const auto& node: l) {
164 s.insert(&v.get(node));
165 }
166 return s;
167 }
Set< const DiscreteVariable * > VariableSet

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

150 {
151 VariableSet s;
152 const VariableNodeMap& v = variableNodeMap();
153 for (const auto& name: l) {
154 s.insert(&v.variableFromName(name));
155 }
156 return s;
157 }

References gum::Set< Key >::insert(), gum::VariableNodeMap::variableFromName(), and variableNodeMap().

Referenced by exists().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _inst_

template<GUM_Numeric GUM_SCALAR>
const PRMInstance< GUM_SCALAR >* gum::prm::InstanceBayesNet< GUM_SCALAR >::_inst_
private

The PRMClassElementContainer decorated by this.

Definition at line 143 of file instanceBayesNet.h.

Referenced by InstanceBayesNet(), InstanceBayesNet(), _get_(), _get_(), and toDot().

◆ _modalities_

template<GUM_Numeric GUM_SCALAR>
NodeProperty< Size > gum::prm::InstanceBayesNet< GUM_SCALAR >::_modalities_
mutableprivate

Definition at line 145 of file instanceBayesNet.h.

Referenced by modalities().

◆ _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().

◆ _varNodeMap_

template<GUM_Numeric GUM_SCALAR>
HashTable< const DiscreteVariable*, const PRMAttribute< GUM_SCALAR >* > gum::prm::InstanceBayesNet< GUM_SCALAR >::_varNodeMap_
private

Mapping between DiscreteVariable and their NodeId.

Definition at line 133 of file instanceBayesNet.h.

Referenced by InstanceBayesNet(), _init_(), nodeId(), and operator=().

◆ dag_

DAG gum::DAGmodel::dag_
protectedinherited

The DAG of this Directed Graphical Model.

Definition at line 291 of file DAGmodel.h.

Referenced by DAGmodel(), DAGmodel(), _checkNodeExists_(), 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(), ancestors(), arcs(), children(), connectedComponents(), dag(), descendants(), 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(), minimalCondSet(), moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::moralGraph_(), nodes(), operator=(), operator=(), parents(), parents(), parents(), size(), sizeArcs(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), topologicalOrder(), gum::BayesNetFragment< GUM_SCALAR >::uninstallArc_(), and gum::BayesNetFragment< GUM_SCALAR >::uninstallNode().

◆ varMap_


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