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

Collaboration diagram for gum::prm::InstanceBayesNet< GUM_SCALAR >:

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 !
bool	operator!= (const IBayesNet< GUM_SCALAR > &from) const
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
std::string	toString () const
Tensor< GUM_SCALAR >	evEq (const std::string &name, double value) const
Tensor< GUM_SCALAR >	evIn (const std::string &name, double val1, double val2) const
Tensor< GUM_SCALAR >	evLt (const std::string &name, double value) const
Tensor< GUM_SCALAR >	evGt (const std::string &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)
NodeSet	minimalCondSet (NodeId target, const NodeSet &soids) const
NodeSet	minimalCondSet (const NodeSet &targets, const NodeSet &soids) const
NodeSet	minimalCondSet (const std::string &target, const std::vector< std::string > &soids) const
NodeSet	minimalCondSet (const std::vector< std::string > &targets, const std::vector< std::string > &soids) const
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.
virtual	~InstanceBayesNet ()
	Destructor.
Variable manipulation methods.
virtual const Tensor< GUM_SCALAR > &	cpt (NodeId varId) const
	See gum::IBaseBayesNet::cpt().
virtual const VariableNodeMap &	variableNodeMap () const
	See gum::IBaseBayesNet::variableNodeMap().
virtual const DiscreteVariable &	variable (NodeId id) const
	See gum::IBaseBayesNet::variable().
virtual NodeId	nodeId (const DiscreteVariable &var) const
	See gum::IBaseBayesNet::nodeId().
virtual NodeId	idFromName (const std::string &name) const
	See gum::IBaseBayesNet::idFromName().
virtual const DiscreteVariable &	variableFromName (const std::string &name) const
	See gum::IBaseBayesNet::variableFromName().
const NodeProperty< Size > &	modalities () const
	See gum::IBaseBayesNet::cpt().
Graphical methods
virtual std::string	toDot () const
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.
const DAG &	dag () const
	Returns a constant reference to the dag of this Bayes Net.
virtual 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 constant reference to the dag of this Bayes Net.
bool	exists (NodeId node) const final
	Return true if this node exists in this graphical model.
bool	exists (const std::string &name) const final
	Returns a constant reference to the dag of this Bayes Net.
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 (const std::string &nametail, const std::string &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 (const std::string &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 (const std::string &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 (const std::string &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 (const std::string &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 (const std::string &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 (const std::string &Xname, const std::string &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.
Getter and setters
const std::string &	property (const std::string &name) const
	Return the value of the property name of this GraphicalModel.
const std::string &	propertyWithDefault (const std::string &name, const std::string &byDefault) const
	Return the value of the property name of this GraphicalModel.
void	setProperty (const std::string &name, const std::string &value)
	Add or change a property of this GraphicalModel.
std::vector< std::string >	properties () const
	List of all the properties.
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 void	spaceCplxToStream (std::stringstream &s, double dSize, int dim, Size usedMem)
	send to the stream the space complexity with 3 parametrs

Protected Attributes
DAG	dag_
	The DAG of this Directed Graphical Model.

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_ (const std::string &name) const
void	_init_ (const PRMInstance< GUM_SCALAR > &i)
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<typename 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<typename GUM_SCALAR>

INLINE gum::prm::InstanceBayesNet< GUM_SCALAR >::InstanceBayesNet

(

const PRMInstance< GUM_SCALAR > &

i

)

Default constructor.

Parameters

i	The PRMInstance<GUM_SCALAR> decorated by this InstanceBayesNet.

Definition at line 78 of file instanceBayesNet_tpl.h.

                                                                                              :
        IBayesNet< GUM_SCALAR >(), _inst_(&i) {
      GUM_CONSTRUCTOR(InstanceBayesNet);
      _init_(i);
    }

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

INLINE gum::prm::InstanceBayesNet< GUM_SCALAR >::InstanceBayesNet

(

const InstanceBayesNet< GUM_SCALAR > &

from

)

Copy constructor.

Definition at line 85 of file instanceBayesNet_tpl.h.

                                                                                        :
        IBayesNet< GUM_SCALAR >(from), _varNodeMap_(from._varNodeMap_), _inst_(from._inst_) {
      GUM_CONS_CPY(InstanceBayesNet);
    }

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

Here is the call graph for this function:

~InstanceBayesNet()

template<typename GUM_SCALAR>

INLINE gum::prm::InstanceBayesNet< GUM_SCALAR >::~InstanceBayesNet ( )

virtual

Destructor.

Definition at line 91 of file instanceBayesNet_tpl.h.

                                                             {
      GUM_DESTRUCTOR(InstanceBayesNet);
    }

References InstanceBayesNet().

Here is the call graph for this function:

Member Function Documentation

_get_() [1/2]

template<typename GUM_SCALAR>

INLINE const PRMClassElement< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::_get_ ( const std::string & name ) const

private

Definition at line 146 of file instanceBayesNet_tpl.h.

                                                                                  {
      try {
        return _inst_->get(name);
      } catch (NotFound const&) { GUM_ERROR(NotFound, "no element found with that name") }
    }

References _inst_, and GUM_ERROR.

_get_() [2/2]

template<typename GUM_SCALAR>

INLINE 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

NotFound

Raised if id is not a formal attribute.

Definition at line 140 of file instanceBayesNet_tpl.h.

                                                                      {
      return _inst_->get(id);
    }

References _inst_.

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

Here is the caller graph for this function:

_init_()

template<typename GUM_SCALAR>

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

private

Definition at line 56 of file instanceBayesNet_tpl.h.

                                                                                  {
      for (const auto node: i.type().containerDag().nodes()) {
        try {
          // Adding the attribute
          const PRMAttribute< GUM_SCALAR >& attr = i.get(node);
          this->dag_.addNodeWithId(attr.id());
          _varNodeMap_.insert(&(attr.type().variable()), &attr);
        } catch (NotFound const&) {
          // Not an attribute
        }
      }
 
      for (const auto& arc: i.type().containerDag().arcs()) {
        try {
          this->dag_.addArc(arc.tail(), arc.head());
        } catch (InvalidNode const&) {
          // Not added means not an attribute
        }
      }
    }

References _varNodeMap_, gum::DAGmodel::dag_, 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:

_properties_()

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

privateinherited

Return the properties of this Directed Graphical Model.

Definition at line 70 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

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

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

{ return dag().ancestors(id); }

References gum::ArcGraphPart::ancestors(), and dag().

Referenced by ancestors().

Here is the call graph for this function:

Here is the caller graph for this function:

ancestors() [2/2]

INLINE NodeSet gum::DAGmodel::ancestors ( const std::string & name ) const

inherited

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

                                                                {
    return ancestors(idFromName(name));
  }

References ancestors(), and gum::GraphicalModel::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

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

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

check()

template<typename GUM_SCALAR>

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

inherited

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

Returns

a list of comments on the consistency of the Bayes Net

Definition at line 314 of file IBayesNet_tpl.h.

                                                              {
    std::vector< std::string > comments;
 
    const double epsilon       = 1e-8;
    const double error_epsilon = 1e-1;
 
    // CHECKING domain
    for (const auto i: nodes())
      if (variable(i).domainSize() < 2) {
        std::stringstream s;
        s << "Variable " << variable(i).name() << ": not consistent (domainSize=1).";
        comments.push_back(s.str());
      }
 
    // CHECKING parameters are probabilities
    // >0
    for (const auto i: nodes()) {
      const auto [amin, minval] = cpt(i).argmin();
      if (minval < (GUM_SCALAR)0.0) {
        std::stringstream s;
        s << "Variable " << variable(i).name() << " : P(" << *(amin.begin()) << ") < 0.0";
        comments.push_back(s.str());
      }
    }
    // <1
    for (const auto i: nodes()) {
      const auto [amax, maxval] = cpt(i).argmax();
      if (maxval > (GUM_SCALAR)1.0) {
        std::stringstream s;
        s << "Variable " << variable(i).name() << " : P(" << *(amax.begin()) << ") > 1.0";
        comments.push_back(s.str());
      }
    }
 
    // CHECKING distributions sum to 1
    for (const auto i: nodes()) {
      const auto p              = cpt(i).sumOut({&variable(i)});
      const auto [amin, minval] = p.argmin();
      if (minval < (GUM_SCALAR)(1.0 - epsilon)) {
        std::stringstream s;
        s << "Variable " << variable(i).name() << " : ";
        if (!parents(i).empty()) s << "with (at least) parents " << *(amin.begin()) << ", ";
        s << "the CPT sum to less than 1";
        if (minval > (GUM_SCALAR)(1.0 - error_epsilon)) s << " (normalization problem ?)";
        s << ".";
        comments.push_back(s.str());
        continue;
      }
      const auto [amax, maxval] = p.argmax();
      if (maxval > (GUM_SCALAR)(1.0 + epsilon)) {
        std::stringstream s;
        s << "Variable " << variable(i).name() << " : ";
        if (!parents(i).empty()) s << "with (at least) parents " << *(amax.begin()) << ", ";
        s << "the CPT sum to more than 1";
        if (maxval < (GUM_SCALAR)(1.0 + error_epsilon)) s << " (normalization problem ?)";
        s << ".";
        comments.push_back(s.str());
      }
    }
 
    return comments;
  }

References cpt(), gum::GraphicalModel::empty(), gum::DAGmodel::nodes(), gum::DAGmodel::parents(), and variable().

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

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

{ return dag_.children(id); }

References dag_.

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

Definition at line 93 of file DAGmodel_inl.h.

{ return dag_.children(ids); }

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

Here is the call graph for this function:

children() [3/4]

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

inherited

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

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

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

Here is the call graph for this function:

children() [4/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

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

                                                                             {
    return children(nodeset(names));
  }

References gum::GraphicalModel::names().

Here is the call graph for this function:

completeInstantiation()

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

inherited

Get an instantiation over all the variables of the model.

Definition at line 106 of file graphicalModel_inl.h.

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

References nodes().

Here is the call graph for this function:

cpt()

template<typename GUM_SCALAR>

INLINE const Tensor< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::cpt ( NodeId varId ) const

virtual

See gum::IBaseBayesNet::cpt().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 108 of file instanceBayesNet_tpl.h.

                                                                                             {
      return _get_(varId).cpf();
    }

References _get_().

Here is the call graph for this function:

dag()

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

inherited

Returns a constant reference to the dag of this Bayes Net.

Definition at line 57 of file DAGmodel_inl.h.

{ return dag_; }

References dag_.

Referenced by gum::BayesNetFragment< GUM_SCALAR >::BayesNetFragment(), gum::MarginalTargetedInference< GUM_SCALAR >::MarginalTargetedInference(), gum::BayesNet< GUM_SCALAR >::add(), ancestors(), gum::IBayesNet< double >::arcs(), descendants(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), isIndependent(), isIndependent(), gum::BayesNetFragment< GUM_SCALAR >::isInstalledNode(), moralGraph(), moralizedAncestralGraph(), gum::BayesBall::relevantTensors(), gum::dSeparationAlgorithm::relevantTensors(), gum::BayesNet< GUM_SCALAR >::reverseArc(), size(), gum::BayesNetFragment< GUM_SCALAR >::toBN(), gum::BayesNetFragment< GUM_SCALAR >::toDot(), gum::IBayesNet< GUM_SCALAR >::toString(), gum::InfluenceDiagram< GUM_SCALAR >::toString(), and gum::BayesNetFragment< GUM_SCALAR >::whenArcDeleted().

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

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

{ return dag().descendants(id); }

References dag(), and gum::ArcGraphPart::descendants().

Referenced by descendants().

Here is the call graph for this function:

Here is the caller graph for this function:

descendants() [2/2]

INLINE NodeSet gum::DAGmodel::descendants ( const std::string & name ) const

inherited

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

                                                                  {
    return descendants(idFromName(name));
  }

References descendants(), and gum::GraphicalModel::idFromName().

Here is the call graph for this function:

dim()

template<typename 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 95 of file IBayesNet_tpl.h.

                                          {
    Size dim = 0;
 
    for (auto node: nodes()) {
      Size q = 1;
 
      for (auto parent: parents(node))
        q *= variable(parent).domainSize();
 
      dim += (variable(node).domainSize() - 1) * q;
    }
 
    return dim;
  }

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

Referenced by dim(), and toString().

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

{ return size() == 0; }

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:

evEq()

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evEq ( const std::string & 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 378 of file IBayesNet_tpl.h.

                                                                                              {
    return Tensor< GUM_SCALAR >::evEq(variableFromName(name), value);
  }

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

Here is the call graph for this function:

evGt()

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evGt ( const std::string & 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 389 of file IBayesNet_tpl.h.

                                                                                            {
    return Tensor< GUM_SCALAR >::evGt(variableFromName(name), val);
  }

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

Here is the call graph for this function:

evIn()

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evIn ( const std::string & 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 384 of file IBayesNet_tpl.h.

                                                                                         {
    return Tensor< GUM_SCALAR >::evIn(variableFromName(name), val1, val2);
  }

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

Here is the call graph for this function:

evLt()

template<typename GUM_SCALAR>

Tensor< GUM_SCALAR > gum::IBayesNet< GUM_SCALAR >::evLt ( const std::string & 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 394 of file IBayesNet_tpl.h.

                                                                                            {
    return Tensor< GUM_SCALAR >::evLt(variableFromName(name), val);
  }

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

Here is the call graph for this function:

exists() [1/2]

INLINE bool gum::DAGmodel::exists ( const std::string & name ) const

finalvirtualinherited

Returns a constant reference to the dag of this Bayes Net.

Implements gum::GraphicalModel.

Definition at line 107 of file DAGmodel_inl.h.

                                                          {
    try {
      return exists(idFromName(name));
    } catch ([[maybe_unused]] gum::NotFound& e) { return false; }
  }

exists() [2/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 105 of file DAGmodel_inl.h.

{ return dag_.exists(node); }

References dag_.

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

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 67 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 ( const std::string & nametail, const std::string & namehead ) const

inherited

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

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

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

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

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

{ return dag_.family(id); }

References dag_.

family() [2/2]

INLINE NodeSet gum::DAGmodel::family ( const std::string & name ) const

finalvirtualinherited

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

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

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

Here is the call graph for this function:

hasSameStructure()

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

inherited

Returns

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

Definition at line 66 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()) {
      try {
        other.idFromName(variable(nid).name());
      } catch (NotFound const&) { 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(), gum::Set< Key >::exists(), gum::GraphicalModel::idFromName(), nodes(), size(), sizeArcs(), and gum::GraphicalModel::variable().

Here is the call graph for this function:

idFromName()

template<typename GUM_SCALAR>

INLINE NodeId gum::prm::InstanceBayesNet< GUM_SCALAR >::idFromName ( const std::string & name ) const

virtual

See gum::IBaseBayesNet::idFromName().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 128 of file instanceBayesNet_tpl.h.

                                                                                        {
      return _get_(name).id();
    }

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.

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

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

Here is the call graph for this function:

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

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

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

Here is the call graph for this function:

isIndependent() [2/4]

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

inlineinherited

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 202 of file DAGmodel.h.

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

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

Here is the call graph for this function:

isIndependent() [3/4]

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

inlineinherited

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 208 of file DAGmodel.h.

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

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

Here is the call graph for this function:

isIndependent() [4/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 138 of file DAGmodel_inl.h.

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

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

Referenced by isIndependent(), and isIndependent().

Here is the call graph for this function:

Here is the caller graph for this function:

jointProbability()

template<typename 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 221 of file IBayesNet_tpl.h.

                                                                                   {
    auto value = (GUM_SCALAR)1.0;
 
    GUM_SCALAR tmp;
 
    for (auto node: nodes()) {
      if ((tmp = cpt(node)[i]) == (GUM_SCALAR)0) { return (GUM_SCALAR)0; }
 
      value *= tmp;
    }
 
    return value;
  }

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

Here is the call graph for this function:

log10DomainSize()

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

inherited

Definition at line 95 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::IBayesNet< GUM_SCALAR >::toString(), 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:

log2JointProbability()

template<typename 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 239 of file IBayesNet_tpl.h.

                                                                                       {
    auto value = (GUM_SCALAR)0.0;
 
    GUM_SCALAR tmp;
 
    for (auto node: nodes()) {
      if ((tmp = cpt(node)[i]) == (GUM_SCALAR)0) {
        return (GUM_SCALAR)(-std::numeric_limits< double >::infinity());
      }
 
      value += std::log2(cpt(node)[i]);
    }
 
    return value;
  }

maxNonOneParam()

template<typename 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 151 of file IBayesNet_tpl.h.

                                                           {
    GUM_SCALAR res = 0.0;
    for (auto node: nodes()) {
      auto v = cpt(node).maxNonOne();
      if (v > res) { res = v; }
    }
    return res;
  }

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

Here is the call graph for this function:

maxParam()

template<typename GUM_SCALAR>

GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::maxParam ( ) const

inherited

Returns

the biggest value in the CPTs of *this

Definition at line 131 of file IBayesNet_tpl.h.

                                                     {
    GUM_SCALAR res = 1.0;
    for (auto node: nodes()) {
      auto v = cpt(node).max();
      if (v > res) { res = v; }
    }
    return res;
  }

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

Here is the call graph for this function:

maxVarDomainSize()

template<typename GUM_SCALAR>

Size gum::IBayesNet< GUM_SCALAR >::maxVarDomainSize ( ) const

inherited

Returns

the biggest domainSize among the variables of *this

Definition at line 111 of file IBayesNet_tpl.h.

                                                       {
    Size res = 0;
    for (auto node: nodes()) {
      auto v = variable(node).domainSize();
      if (v > res) { res = v; }
    }
    return res;
  }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

memoryFootprint()

template<typename GUM_SCALAR>

INLINE 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 161 of file IBayesNet_tpl.h.

                                                             {
    Size usedMem = 0;
 
    for (auto node: nodes())
      usedMem += cpt(node).memoryFootprint();
    return usedMem;
  }

References gum::DAGmodel::nodes().

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

inherited

Definition at line 150 of file DAGmodel_inl.h.

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

References dag_.

minimalCondSet() [2/4]

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

inherited

Definition at line 154 of file DAGmodel_inl.h.

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

minimalCondSet() [3/4]

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

inherited

Definition at line 159 of file DAGmodel_inl.h.

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

minimalCondSet() [4/4]

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

inherited

Definition at line 146 of file DAGmodel_inl.h.

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

minNonZeroParam()

template<typename 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 141 of file IBayesNet_tpl.h.

                                                            {
    GUM_SCALAR res = 1.0;
    for (auto node: nodes()) {
      auto v = cpt(node).minNonZero();
      if (v < res) { res = v; }
    }
    return res;
  }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

minParam()

template<typename GUM_SCALAR>

GUM_SCALAR gum::IBayesNet< GUM_SCALAR >::minParam ( ) const

inherited

Returns

the smallest value in the CPTs of *this

Definition at line 121 of file IBayesNet_tpl.h.

                                                     {
    GUM_SCALAR res = 1.0;
    for (auto node: nodes()) {
      auto v = cpt(node).min();
      if (v < res) { res = v; }
    }
    return res;
  }

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

Here is the call graph for this function:

modalities()

template<typename GUM_SCALAR>

INLINE const NodeProperty< Size > & gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities

(

)

const

See gum::IBaseBayesNet::cpt().

Definition at line 153 of file instanceBayesNet_tpl.h.

                                                                                        {
      if (_modalities_.empty()) {
        for (const auto node: this->nodes()) {
          _modalities_.insert(node, variable(node).domainSize());
        }
      }
 
      return _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 64 of file DAGmodel.cpp.

{ return dag().moralGraph(); }

References 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

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

Returns

the moralized ancestral graph

Definition at line 134 of file DAGmodel_inl.h.

                                                                               {
    return dag().moralizedAncestralGraph(nodes);
  }

References dag(), gum::DAG::moralizedAncestralGraph(), 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

inherited

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

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

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

References ids(), and variableNodeMap().

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

INLINE NodeId gum::prm::InstanceBayesNet< GUM_SCALAR >::nodeId ( const DiscreteVariable & var ) const

virtual

See gum::IBaseBayesNet::nodeId().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 123 of file instanceBayesNet_tpl.h.

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

References _varNodeMap_.

nodes()

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

finalvirtualinherited

Returns a constant reference to the dag of this Bayes Net.

Implements gum::GraphicalModel.

Definition at line 113 of file DAGmodel_inl.h.

{ return (NodeGraphPart&)dag_; }

References dag_.

Referenced by gum::Estimator< GUM_SCALAR >::Estimator(), gum::BayesNetFragment< GUM_SCALAR >::~BayesNetFragment(), 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 >::jointProbability(), gum::IBayesNet< GUM_SCALAR >::maxNonOneParam(), gum::IBayesNet< GUM_SCALAR >::maxParam(), gum::IBayesNet< GUM_SCALAR >::maxVarDomainSize(), gum::IBayesNet< GUM_SCALAR >::memoryFootprint(), gum::IBayesNet< GUM_SCALAR >::minNonZeroParam(), gum::IBayesNet< GUM_SCALAR >::minParam(), gum::prm::ClassBayesNet< GUM_SCALAR >::modalities(), gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities(), moralizedAncestralGraph(), 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 60 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::IBayesNet< double >::children(), gum::IBayesNet< double >::children(), gum::DAGmodel::isIndependent(), 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<typename GUM_SCALAR>

bool gum::IBayesNet< GUM_SCALAR >::operator!= ( const IBayesNet< GUM_SCALAR > & from ) const

inherited

Returns

Returns false if the src and this are equal.

Definition at line 303 of file IBayesNet_tpl.h.

                                                                    {
    return !this->operator==(from);
  }

References IBayesNet(), and gum::operator==().

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR>

INLINE InstanceBayesNet< GUM_SCALAR > & gum::prm::InstanceBayesNet< GUM_SCALAR >::operator=

(

const InstanceBayesNet< GUM_SCALAR > &

from

)

Copy operator.

Definition at line 97 of file instanceBayesNet_tpl.h.

                                                                               {
      if (this != &from) {
        IBayesNet< GUM_SCALAR >::operator=(from);
 
        _varNodeMap_ = from._varNodeMap_;
      }
 
      return *this;
    }

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

Here is the call graph for this function:

operator==()

template<typename 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 256 of file IBayesNet_tpl.h.

                                                                    {
    if (size() != from.size()) { return false; }
 
    if (sizeArcs() != from.sizeArcs()) { return false; }
 
    for (auto node: nodes()) {
      try {
        const auto& v1 = variable(node);
        const auto& v2 = from.variableFromName(variable(node).name());
        if (v1 != v2) { return false; }
      } catch (NotFound const&) {
        // a name is not found in from
        return false;
      }
    }
 
    for (auto node: nodes()) {
      NodeId fromnode = from.idFromName(variable(node).name());
 
      if (cpt(node).nbrDim() != from.cpt(fromnode).nbrDim()) { return false; }
 
      if (cpt(node).domainSize() != from.cpt(fromnode).domainSize()) { return false; }
 
      for (Idx i = 0; i < cpt(node).nbrDim(); ++i) {
        if (!from.cpt(fromnode).contains(from.variableFromName(cpt(node).variable(i).name()))) {
          return false;
        }
      }
 
      Instantiation i(cpt(node));
      Instantiation j(from.cpt(fromnode));
 
      AlmostDifferent< GUM_SCALAR > cmp;
      for (i.setFirst(); !i.end(); i.inc()) {
        for (Idx indice = 0; indice < cpt(node).nbrDim(); ++indice) {
          const DiscreteVariable* p = &(i.variable(indice));
          j.chgVal(j.pos(from.variableFromName(p->name())), i.val(*p));
        }
 
        if (cmp(cpt(node).get(i), from.cpt(fromnode).get(j))) { return false; }
      }
    }
 
    return true;
  }

References IBayesNet(), and gum::DAGmodel::size().

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

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

{ return dag_.parents(id); }

References dag_.

Referenced by gum::IBayesNet< GUM_SCALAR >::check(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::InfluenceDiagram< GUM_SCALAR >::copyStructureAndTables_(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::installCPT_(), parents(), 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

inherited

returns the parents of a set of nodes

Definition at line 99 of file DAGmodel_inl.h.

{ return dag_.children(ids); }

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

Here is the call graph for this function:

parents() [3/4]

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

inherited

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

                                                                     {
    return parents(idFromName(name));
  }

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

Here is the call graph for this function:

parents() [4/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

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

                                                                            {
    return parents(nodeset(names));
  }

References gum::GraphicalModel::names(), gum::GraphicalModel::nodeset(), 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 properties.

Definition at line 81 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 ( const std::string & name ) const

inherited

Return the value of the property name of this GraphicalModel.

Exceptions

NotFound

Raised if no name property is found.

Definition at line 60 of file graphicalModel_inl.h.

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

References _properties_(), and GUM_ERROR.

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:

propertyWithDefault()

INLINE const std::string & gum::GraphicalModel::propertyWithDefault ( const std::string & name, const std::string & byDefault ) const

inherited

Return the value of the property name of this GraphicalModel.

return byDefault if the property name is not found

Definition at line 75 of file graphicalModel_inl.h.

                                                                                           {
    return (_propertiesMap_.exists(name)) ? _propertiesMap_[name] : byDefault;
  }

References _propertiesMap_.

setProperty()

INLINE void gum::GraphicalModel::setProperty ( const std::string & name, const std::string & value )

inherited

Add or change a property of this GraphicalModel.

Definition at line 89 of file graphicalModel_inl.h.

                                                                                {
    if (_propertiesMap_.exists(name)) _propertiesMap_[name] = value;
    else _propertiesMap_.insert(name, 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

finalvirtualinherited

Returns the number of variables in this Directed Graphical Model.

Implements gum::GraphicalModel.

Definition at line 60 of file DAGmodel_inl.h.

{ return dag().size(); }

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

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

{ return dag_.sizeArcs(); }

References dag_.

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

Here is the caller graph for this function:

spaceCplxToStream()

void gum::GraphicalModel::spaceCplxToStream ( std::stringstream & s, 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 69 of file graphicalModel.cpp.

                                                                                               {
    if (dSize > 6) s << "domainSize: 10^" << dSize;
    else s << "domainSize: " << std::round(std::pow(10.0, dSize));
 
    s << ", dim: " << dim << ", mem: ";
 
    if (const Size go = usedMem / (1024 * 1024 * 1024); go > 0) s << go << "Go ";
    if (const Size mo = (usedMem / (1024 * 1024)) % 1024; mo > 0) s << mo << "Mo ";
    if (const Size ko = (usedMem / 1024) % 1024; ko > 0) s << ko << "Ko ";
    s << usedMem % 1024 << "o";
  }

Referenced by gum::IBayesNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

toDot()

template<typename GUM_SCALAR>

INLINE std::string gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot ( ) const

virtual

Returns

Returns a dot representation of this IBayesNet.

Reimplemented from gum::IBayesNet< GUM_SCALAR >.

Definition at line 164 of file instanceBayesNet_tpl.h.

                                                                 {
      std::string       tab = "  ";
      std::stringstream output;
      output << "digraph \"";
      output << _inst_->name() << "\" {" << std::endl;
 
      for (const auto node: this->nodes()) {
        if (this->children(node).size() > 0) {
          const NodeSet& children = this->children(node);
 
          for (const auto chi: children) {
            output << tab << "\"" << variable(node).name() << "\" -> ";
            output << "\"" << variable(chi).name() << "\";" << std::endl;
          }
        } else if (this->parents(node).size() == 0) {
          output << tab << "\"" << variable(node).name() << "\";" << std::endl;
        }
      }
 
      output << "}" << std::endl;
      return output.str();
    }

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

clear

If false returns the previously created topology.

Definition at line 115 of file DAGmodel_inl.h.

{ return dag().topologicalOrder(); }

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:

toString()

template<typename GUM_SCALAR>

INLINE std::string gum::IBayesNet< GUM_SCALAR >::toString ( ) const

inherited

Returns

Returns a string representation of this IBayesNet.

Definition at line 170 of file IBayesNet_tpl.h.

                                                           {
    std::stringstream s;
    s << "BN{nodes: " << size() << ", arcs: " << dag().sizeArcs() << ", ";
    spaceCplxToStream(s, log10DomainSize(), (int)dim(), memoryFootprint());
    s << "}";
    return s.str();
  }

References gum::DAGmodel::dag(), dim(), gum::GraphicalModel::log10DomainSize(), memoryFootprint(), gum::DAGmodel::size(), and gum::GraphicalModel::spaceCplxToStream().

Referenced by gum::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

variable()

template<typename GUM_SCALAR>

INLINE const DiscreteVariable & gum::prm::InstanceBayesNet< GUM_SCALAR >::variable ( NodeId id ) const

virtual

See gum::IBaseBayesNet::variable().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 118 of file instanceBayesNet_tpl.h.

                                                                                           {
      return _get_(id).type().variable();
    }

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

INLINE const DiscreteVariable & gum::prm::InstanceBayesNet< GUM_SCALAR >::variableFromName ( const std::string & name ) const

virtual

See gum::IBaseBayesNet::variableFromName().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 134 of file instanceBayesNet_tpl.h.

                                                                                    {
      return _get_(name).type().variable();
    }

References _get_().

Here is the call graph for this function:

variableNodeMap()

template<typename GUM_SCALAR>

INLINE const VariableNodeMap & gum::prm::InstanceBayesNet< GUM_SCALAR >::variableNodeMap ( ) const

virtual

See gum::IBaseBayesNet::variableNodeMap().

Implements gum::IBayesNet< GUM_SCALAR >.

Definition at line 113 of file instanceBayesNet_tpl.h.

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

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.

                                                              {
    VariableSet            s;
    const VariableNodeMap& v = variableNodeMap();
    for (const auto& node: l) {
      s.insert(&v.get(node));
    }
    return s;
  }

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

Here is the call graph for this function:

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

Here is the call graph for this function:

Member Data Documentation

_inst_

template<typename 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<typename 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 236 of file graphicalModel.h.

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

_varNodeMap_

template<typename 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 272 of file DAGmodel.h.

Referenced by 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_(), arcs(), children(), children(), children(), dag(), 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(), minimalCondSet(), gum::InfluenceDiagram< GUM_SCALAR >::moralGraph_(), nodes(), operator=(), parents(), parents(), gum::InfluenceDiagram< GUM_SCALAR >::removeTables_(), sizeArcs(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), gum::BayesNetFragment< GUM_SCALAR >::uninstallArc_(), and gum::BayesNetFragment< GUM_SCALAR >::uninstallNode().

---

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

• agrum/PRM/instanceBayesNet.h
• agrum/PRM/instanceBayesNet_tpl.h