gum::InfluenceDiagram< GUM_SCALAR > Class Template Reference

Class representing an Influence Diagram. More...

#include <agrum/ID/influenceDiagram.h>

Inheritance diagram for gum::InfluenceDiagram< GUM_SCALAR >:

Collaboration diagram for gum::InfluenceDiagram< GUM_SCALAR >:

Public Member Functions
std::string	toDot () const
std::string	toString () const
double	log10DomainSize () const
bool	hasSameStructure (const DAGmodel &other)
Constructors / Destructors
	InfluenceDiagram ()
	Default constructor. More...
virtual	~InfluenceDiagram ()
	Destructor. More...
	InfluenceDiagram (const InfluenceDiagram< GUM_SCALAR > &source)
	Copy Constructor. More...
InfluenceDiagram< GUM_SCALAR > &	operator= (const InfluenceDiagram< GUM_SCALAR > &source)
	Copy Operator. More...
Variable manipulation methods.
virtual const Potential< GUM_SCALAR > &	cpt (NodeId varId) const
	Returns the CPT of a potential variable. More...
virtual const Potential< GUM_SCALAR > &	utility (NodeId varId) const
	Returns the utility table of a utility node. More...
virtual const VariableNodeMap &	variableNodeMap () const
	Returns a constant reference to the VariableNodeMap of this Influence Diagram. More...
bool	isUtilityNode (NodeId varId) const
	Returns true if node is a utility one. More...
bool	isDecisionNode (NodeId varId) const
	Returns true if node is a decision one. More...
bool	isChanceNode (NodeId varId) const
	Returns true if node is a chance one. More...
Size	utilityNodeSize () const
	Returns the number of utility nodes. More...
Size	chanceNodeSize () const
	Returns the number of chance nodes. More...
Size	decisionNodeSize () const
	Returns the number of decision nodes. More...
virtual const DiscreteVariable &	variable (NodeId id) const
	Returns a constant reference over a variabe given it's node id. More...
virtual NodeId	nodeId (const DiscreteVariable &var) const
	Return id node from discrete var pointer. More...
virtual NodeId	idFromName (const std::string &name) const
	Getter by name. More...
virtual const DiscreteVariable &	variableFromName (const std::string &name) const
	Getter by name. More...
NodeId	add (const DiscreteVariable &variable, NodeId id=0)
	Add a chance variable, it's associate node and it's CPT. More...
NodeId	addChanceNode (const DiscreteVariable &variable, NodeId id=0)
	Add a chance variable, it's associate node and it's CPT. More...
NodeId	addUtilityNode (const DiscreteVariable &variable, NodeId id=0)
	Add a utility variable, it's associate node and it's UT. More...
NodeId	addDecisionNode (const DiscreteVariable &variable, NodeId id=0)
	Add a decision variable. More...
NodeId	addChanceNode (const DiscreteVariable &variable, MultiDimImplementation< GUM_SCALAR > *aContent, NodeId id=0)
	Add a chance variable, it's associate node and it's CPT. More...
NodeId	addUtilityNode (const DiscreteVariable &variable, MultiDimImplementation< GUM_SCALAR > *aContent, NodeId id=0)
	Add a chance variable, it's associate node and it's CPT. More...
void	erase (NodeId id)
	Erase a Variable from the network and remove the variable from all his childs. More...
void	erase (const DiscreteVariable &var)
	Erase a Variable from the network and remove the variable from all his childs. More...
void	changeVariableName (NodeId id, const std::string &new_name)
	we allow the user to change the name of a variable More...
Arc manipulation methods.
void	addArc (NodeId tail, NodeId head)
	Add an arc in the ID, and update diagram's potential nodes cpt if necessary. More...
void	eraseArc (const Arc &arc)
	Removes an arc in the ID, and update diagram's potential nodes cpt if necessary. More...
void	eraseArc (NodeId tail, NodeId head)
	RRemoves an arc in the ID, and update diagram's potential nodes cpt if necessary. More...
Decisions methods
bool	decisionOrderExists () const
	True if a directed path exist with all decison nodes. More...
gum::DAG *	getDecisionGraph () const
	Returns the temporal Graph. More...
std::vector< NodeId > *	getDecisionOrder () const
	Returns the sequence of decision nodes in the directed path. More...
bool	existsPathBetween (NodeId src, NodeId dest) const
	Returns true if a path exists between two nodes. More...
const List< NodeSet > &	getPartialTemporalOrder (bool clear=true) const
	Returns partial temporal ordering. More...
Getter and setters
const std::string &	property (const std::string &name) const
	Return the value of the property name of this DAGModel. More...
const std::string &	propertyWithDefault (const std::string &name, const std::string &byDefault) const
	Return the value of the property name of this DAGModel. More...
void	setProperty (const std::string &name, const std::string &value)
	Add or change a property of this DAGModel. More...
Variable manipulation methods.
const DAG &	dag () const
	Returns a constant reference to the dag of this Bayes Net. More...
Size	size () const
	Returns the number of variables in this Directed Graphical Model. More...
Size	sizeArcs () const
	Returns the number of arcs in this Directed Graphical Model. More...
bool	empty () const
	Retursn true if this Directed Graphical Model is empty. More...
const NodeGraphPart &	nodes () const
	Returns a constant reference to the dag of this Bayes Net. More...
virtual Instantiation	completeInstantiation () const final
	Get an instantiation over all the variables of the model. More...
Arc manipulation methods.
const ArcSet &	arcs () const
	returns the set of nodes with arc ingoing to a given node More...
const NodeSet &	parents (const NodeId id) const
	returns the set of nodes with arc ingoing to a given node More...
const NodeSet &	parents (const std::string &name) const
	returns the set of nodes with arc ingoing to a given node More...
const NodeSet &	children (const NodeId id) const
	returns the set of nodes with arc outgoing from a given node More...
const NodeSet &	children (const std::string &name) const
	returns the set of nodes with arc ingoing to a given node More...
Graphical methods
const UndiGraph &	moralGraph (bool clear=true) const
	The node's id are coherent with the variables and nodes of the topology. More...
const Sequence< NodeId > &	topologicalOrder (bool clear=true) const
	The topological order stays the same as long as no variable or arcs are added or erased src the topology. More...

Protected Attributes
DAG	_dag
	The DAG of this Directed Graphical Model. More...

Protected Member Functions
virtual void	_moralGraph (UndiGraph &graph) const
	Returns the moral graph of this InfluenceDiagram. More...
void	_removeTables ()
	Removing ancient table. More...
void	_copyTables (const InfluenceDiagram< GUM_SCALAR > &IDsource)
	Copying tables from another influence diagram. More...
NodeId	_addNode (const DiscreteVariable &variableType, NodeId DesiredId)
	Add a node. More...
Sequence< NodeId >	_getChildrenDecision (NodeId parentDecision) const
	Returns the list of children decision for a given nodeId. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::InfluenceDiagram< GUM_SCALAR >

Class representing an Influence Diagram.

Definition at line 54 of file influenceDiagram.h.

Constructor & Destructor Documentation

InfluenceDiagram() [1/2]

template<typename GUM_SCALAR >

INLINE gum::InfluenceDiagram< GUM_SCALAR >::InfluenceDiagram

(

)

Default constructor.

Definition at line 44 of file influenceDiagram_tpl.h.

                                                          : DAGmodel() {
    GUM_CONSTRUCTOR(InfluenceDiagram);
  }

~InfluenceDiagram()

template<typename GUM_SCALAR >

gum::InfluenceDiagram< GUM_SCALAR >::~InfluenceDiagram ( )

virtual

Destructor.

Definition at line 52 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::_removeTables().

                                                    {
    GUM_DESTRUCTOR(InfluenceDiagram);
    _removeTables();
  }

Here is the call graph for this function:

InfluenceDiagram() [2/2]

template<typename GUM_SCALAR >

gum::InfluenceDiagram< GUM_SCALAR >::InfluenceDiagram

(

const InfluenceDiagram< GUM_SCALAR > &

source

)

Copy Constructor.

Definition at line 61 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), and gum::InfluenceDiagram< GUM_SCALAR >::operator=().

                                                   :
      DAGmodel(source),
      __variableMap(source.__variableMap) {
    GUM_CONS_CPY(InfluenceDiagram);
    _copyTables(source);
  }

Here is the call graph for this function:

Member Function Documentation

_addNode()

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::_addNode ( const DiscreteVariable &  variableType, NodeId  DesiredId  )

protected

Add a node.

Definition at line 466 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, gum::DAGmodel::_dag, gum::NodeGraphPart::addNodeWithId(), gum::VariableNodeMap::insert(), and gum::NodeGraphPart::nextNodeId().

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::addDecisionNode(), and gum::InfluenceDiagram< GUM_SCALAR >::addUtilityNode().

                                                                                 {
    // None thread safe code!
    NodeId proposedId;

    if (DesiredId == 0)
      proposedId = _dag.nextNodeId();
    else
      proposedId = DesiredId;

    __variableMap.insert(proposedId, variableType);

    _dag.addNodeWithId(proposedId);

    // end critical section
    return proposedId;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

_copyTables()

template<typename GUM_SCALAR >

void gum::InfluenceDiagram< GUM_SCALAR >::_copyTables ( const InfluenceDiagram< GUM_SCALAR > &  IDsource )

protected

Copying tables from another influence diagram.

Definition at line 108 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::DAGmodel::_dag, gum::Instantiation::chgVal(), gum::Instantiation::end(), gum::Instantiation::inc(), gum::Instantiation::nbrDim(), gum::InfluenceDiagram< GUM_SCALAR >::nodeId(), gum::ArcGraphPart::parents(), gum::Instantiation::setFirst(), gum::Instantiation::val(), gum::InfluenceDiagram< GUM_SCALAR >::variable(), and gum::Instantiation::variable().

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

                                                     {
    // Copying potentials
    for (const auto& pot : IDsource.__potentialMap) {
      // Instanciation of the node's CPT
      auto potentialCpy = new Potential< GUM_SCALAR >;
      (*potentialCpy) << variable(pot.first);

      // Addition of the parents
      for (const auto par : _dag.parents(pot.first))
        (*potentialCpy) << variable(par);

      // Filling up of the table
      Instantiation srcInst(*pot.second);
      Instantiation cpyInst(*potentialCpy);

      for (cpyInst.setFirst(); !cpyInst.end(); cpyInst.inc()) {
        for (Idx i = 0; i < cpyInst.nbrDim(); i++) {
          NodeId id = nodeId(cpyInst.variable(i));
          srcInst.chgVal(IDsource.variable(id), cpyInst.val(i));
        }

        potentialCpy->set(cpyInst, (*pot.second)[srcInst]);
      }

      // Adding cpt to cpt map
      __potentialMap.set(pot.first, potentialCpy);
    }

    // Copying Utilities
    for (const auto& uti : IDsource.__utilityMap) {
      // Instanciation of the node's CPT
      auto utilityCpy = new Potential< GUM_SCALAR >;
      (*utilityCpy) << variable(uti.first);

      // Addition of the parents
      for (const auto par : _dag.parents(uti.first))
        (*utilityCpy) << variable(par);

      // Filling up of the table
      Instantiation srcInst(*uti.second);

      Instantiation cpyInst(*utilityCpy);

      for (cpyInst.setFirst(); !cpyInst.end(); cpyInst.inc()) {
        for (Idx i = 0; i < cpyInst.nbrDim(); i++) {
          NodeId id = nodeId(cpyInst.variable(i));
          srcInst.chgVal(IDsource.variable(id), cpyInst.val(i));
        }

        utilityCpy->set(cpyInst, (*uti.second)[srcInst]);
      }

      // Adding cpt to cpt map
      __utilityMap.set(uti.first, utilityCpy);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

_getChildrenDecision()

template<typename GUM_SCALAR >

Sequence< NodeId > gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision ( NodeId  parentDecision ) const

protected

Returns the list of children decision for a given nodeId.

Definition at line 699 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::ArcGraphPart::children(), gum::List< Val, Alloc >::empty(), gum::List< Val, Alloc >::front(), gum::SequenceImplementation< Key, Alloc, Gen >::insert(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), gum::NodeGraphPart::nodesProperty(), gum::List< Val, Alloc >::popFront(), and gum::List< Val, Alloc >::pushBack().

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

                                  {
    Sequence< NodeId > childrenSeq;

    List< NodeId > nodeFIFO;
    NodeId         current;

    // mark[node] contains false if not visited
    // mark[node] contains true if visited
    NodeProperty< bool > mark = _dag.nodesProperty(false);

    mark[parentDecision] = true;

    nodeFIFO.pushBack(parentDecision);

    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();

      for (const auto new_one : _dag.children(current)) {
        if (mark[new_one]) continue;   // if this node is already marked, continue

        mark[new_one] = true;

        if (!isDecisionNode(new_one))
          nodeFIFO.pushBack(new_one);
        else
          childrenSeq.insert(new_one);
      }
    }

    return childrenSeq;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

_moralGraph()

template<typename GUM_SCALAR >

void gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph ( UndiGraph &  graph ) const

protectedvirtual

Returns the moral graph of this InfluenceDiagram.

Definition at line 590 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::UndiGraph::addEdge(), gum::NodeGraphPart::addNodeWithId(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), gum::NodeGraphPart::nodes(), and gum::ArcGraphPart::parents().

                                                                         {
    for (const auto node : _dag.nodes())
      if (!isUtilityNode(node)) graph.addNodeWithId(node);

    for (const auto node : _dag.nodes()) {
      if (!isDecisionNode(node))
        for (const auto par : _dag.parents(node)) {
          if (isChanceNode(node)) graph.addEdge(node, par);

          for (const auto par2 : _dag.parents(node))
            if (par != par2) graph.addEdge(par, par2);
        }
    }
  }

Here is the call graph for this function:

_removeTables()

template<typename GUM_SCALAR >

void gum::InfluenceDiagram< GUM_SCALAR >::_removeTables ( )

protected

Removing ancient table.

Definition at line 95 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::InfluenceDiagram< GUM_SCALAR >::cpt(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), gum::NodeGraphPart::nodes(), and gum::InfluenceDiagram< GUM_SCALAR >::utility().

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

                                                     {
    for (const auto node : _dag.nodes()) {
      if (isChanceNode(node))
        delete &cpt(node);
      else if (isUtilityNode(node))
        delete &utility(node);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

add()

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::add	(	const DiscreteVariable &	variable,
		NodeId	id = 0
	)

Add a chance variable, it's associate node and it's CPT.

The id of the new variable is automatically generated.

The implementation of the Potential is by default a MultiDimArray.

Parameters

variable	The variable added by copy.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Returns

the id of the added variable.

Exceptions

DuplicateElement

if id(<>0) is already used

Definition at line 358 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode().

                                                                            {
    return addChanceNode(var, varId);
  }

Here is the call graph for this function:

addArc()

template<typename GUM_SCALAR >

INLINE void gum::InfluenceDiagram< GUM_SCALAR >::addArc	(	NodeId	tail,
		NodeId	head
	)

Add an arc in the ID, and update diagram's potential nodes cpt if necessary.

Parameters

head	and
tail	as NodeId

Exceptions

InvalidEdge	If arc.tail and/or arc.head are not in the ID.
InvalidEdge	if tail is a utility node

Definition at line 537 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::DAGmodel::_dag, gum::DAG::addArc(), GUM_ERROR, gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), and gum::InfluenceDiagram< GUM_SCALAR >::variable().

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::__checkTemporalOrder(), and gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                             {
    if (isUtilityNode(tail)) {
      GUM_ERROR(InvalidArc, "Tail cannot be a utility node");
    }

    _dag.addArc(tail, head);

    if (isChanceNode(head))
      // Add parent in the child's CPT
      (*(__potentialMap[head])) << variable(tail);
    else if (isUtilityNode(head))
      // Add parent in the child's UT
      (*(__utilityMap[head])) << variable(tail);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

addChanceNode() [1/2]

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode	(	const DiscreteVariable &	variable,
		NodeId	id = 0
	)

Add a chance variable, it's associate node and it's CPT.

The id of the new variable is automatically generated.

The implementation of the Potential is by default a MultiDimArray.

Parameters

variable	The variable added by copy.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Returns

the id of the added variable.

Exceptions

DuplicateElement

if id(<>0) is already used

Definition at line 401 of file influenceDiagram_tpl.h.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::add(), and gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                     {
    MultiDimArray< GUM_SCALAR >* newMultiDim = new MultiDimArray< GUM_SCALAR >();
    NodeId                       res = 0;

    try {
      res = addChanceNode(var, newMultiDim, varId);
    } catch (Exception&) {
      delete newMultiDim;
      throw;
    }

    return res;
  }

Here is the caller graph for this function:

addChanceNode() [2/2]

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode	(	const DiscreteVariable &	variable,
		MultiDimImplementation< GUM_SCALAR > *	aContent,
		NodeId	id = 0
	)

Add a chance variable, it's associate node and it's CPT.

The id of the new variable is automatically generated.

Parameters

variable	The variable added by copy.
aContent	The content used for the variable potential.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Returns

the id of the added variable.

Exceptions

DuplicateElement

if id(<>0) is already used

Definition at line 421 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::_addNode(), and gum::InfluenceDiagram< GUM_SCALAR >::variable().

                                                      {
    NodeId proposedId = _addNode(var, DesiredId);

    Potential< GUM_SCALAR >* varcpt = new Potential< GUM_SCALAR >(aContent);
    (*varcpt) << variable(proposedId);
    __potentialMap.insert(proposedId, varcpt);

    return proposedId;
  }

Here is the call graph for this function:

addDecisionNode()

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::addDecisionNode	(	const DiscreteVariable &	variable,
		NodeId	id = 0
	)

Add a decision variable.

The id of the new variable is automatically generated.

Parameters

variable	The variable added by copy.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Returns

the id of the added variable.

Exceptions

DuplicateElement

if id(<>0) is already used

Definition at line 391 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::_addNode().

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                   {
    return _addNode(var, varId);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

addUtilityNode() [1/2]

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::addUtilityNode	(	const DiscreteVariable &	variable,
		NodeId	id = 0
	)

Add a utility variable, it's associate node and it's UT.

The id of the new variable is automatically generated.

The implementation of the Utility is by default a MultiDimArray.

Parameters

variable	The variable added by copy.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Returns

the id of the added variable.

Exceptions

InvalidAgrument	If variable has more than one label
DuplicateElement	if id(<>0) is already used

Definition at line 370 of file influenceDiagram_tpl.h.

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                  {
    MultiDimArray< GUM_SCALAR >* newMultiDim = new MultiDimArray< GUM_SCALAR >();
    NodeId                       res = 0;

    try {
      res = addUtilityNode(var, newMultiDim, varId);
    } catch (Exception&) {
      delete newMultiDim;
      throw;
    }

    return res;
  }

Here is the caller graph for this function:

addUtilityNode() [2/2]

template<typename GUM_SCALAR >

NodeId gum::InfluenceDiagram< GUM_SCALAR >::addUtilityNode	(	const DiscreteVariable &	variable,
		MultiDimImplementation< GUM_SCALAR > *	aContent,
		NodeId	id = 0
	)

Add a chance variable, it's associate node and it's CPT.

The id of the new variable is automatically generated.

Parameters

variable	The variable added by copy.
aContent	The content used for the variable utility.
id	The chosen id. If 0, the NodeGraphPart will choose.

Warning

give an id (not 0) should be reserved for rare and specific situations !!!

Exceptions

InvalidAgrument	If variable has more than one label
DuplicateElement	if id(<>0) is already used

Definition at line 440 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::InfluenceDiagram< GUM_SCALAR >::_addNode(), gum::DiscreteVariable::domainSize(), GUM_ERROR, and gum::InfluenceDiagram< GUM_SCALAR >::variable().

                                                      {
    if (var.domainSize() != 1) {
      GUM_ERROR(InvalidArgument,
                "Utility var have no state ( which implicates a "
                "single label for data output reasons ).");
    }

    NodeId proposedId = _addNode(var, DesiredId);

    Potential< GUM_SCALAR >* varut = new Potential< GUM_SCALAR >(aContent);

    (*varut) << variable(proposedId);

    __utilityMap.insert(proposedId, varut);

    return proposedId;
  }

Here is the call graph for this function:

arcs()

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

inherited

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

Note that the set of arcs returned may be empty if no arc within the ArcGraphPart is ingoing into the given node.

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 104 of file DAGmodel_inl.h.

References gum::DAGmodel::_dag, and gum::ArcGraphPart::arcs().

Referenced by gum::EssentialGraph::__buildEssentialGraph(), gum::DAGmodel::__moralGraph(), gum::MarkovBlanket::hasSameStructure(), and gum::DAGmodel::hasSameStructure().

{ return _dag.arcs(); }

Here is the call graph for this function:

Here is the caller graph for this function:

chanceNodeSize()

template<typename GUM_SCALAR >

INLINE Size gum::InfluenceDiagram< GUM_SCALAR >::chanceNodeSize

(

)

const

Returns the number of chance nodes.

Definition at line 299 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap.

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

                                                                   {
    return __potentialMap.size();
  }

Here is the caller graph for this function:

changeVariableName()

template<typename GUM_SCALAR >

INLINE void gum::InfluenceDiagram< GUM_SCALAR >::changeVariableName	(	NodeId	id,
		const std::string &	new_name
	)

we allow the user to change the name of a variable

Exceptions

DuplicateLabel	if this name already exists
NotFound	Raised if no nodes matches id.

Definition at line 525 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, and gum::VariableNodeMap::changeName().

                                           {
    __variableMap.changeName(id, new_name);
  }

Here is the call graph for this function:

children() [1/2]

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 arcs returned may be empty if no arc within the ArcGraphPart is outgoing from the given node.

Parameters

id	the node which is the tail of the arcs returned

Definition at line 111 of file DAGmodel_inl.h.

References gum::DAGmodel::_dag, and gum::ArcGraphPart::children().

Referenced by gum::MarkovBlanket::__buildMarkovBlanket(), gum::DAGmodel::parents(), gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot(), and gum::prm::ClassBayesNet< GUM_SCALAR >::toDot().

                                                                {
    return _dag.children(id);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

children() [2/2]

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

inlineinherited

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

Note that the set of arcs returned may be empty if no arc within the ArcGraphPart is ingoing into the given node.

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 165 of file DAGmodel.h.

References gum::DAGmodel::hasSameStructure(), gum::DAGmodel::idFromName(), gum::DAGmodel::log10DomainSize(), gum::DAGmodel::moralGraph(), gum::DAGmodel::operator=(), gum::DAGmodel::parents(), and gum::DAGmodel::topologicalOrder().

                                                         {
      return parents(idFromName(name));
    };

Here is the call graph for this function:

completeInstantiation()

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

finalvirtualinherited

Get an instantiation over all the variables of the model.

Definition at line 86 of file DAGmodel_inl.h.

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

                                                      {
    Instantiation I;

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

    return I;
  }

Here is the call graph for this function:

cpt()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::InfluenceDiagram< GUM_SCALAR >::cpt ( NodeId  varId ) const

virtual

Returns the CPT of a potential variable.

Exceptions

NotFound

If no variable's id matches varId.

Definition at line 246 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), and gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                     {
    return *(__potentialMap[varId]);
  }

Here is the caller 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 63 of file DAGmodel_inl.h.

References gum::DAGmodel::_dag.

Referenced by gum::DAGmodel::__moralGraph(), gum::DAGmodel::completeInstantiation(), gum::learning::DAG2BNLearner< ALLOC >::createBN(), gum::learning::genericBNLearner::Database::Database(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::BayesNetFragment< GUM_SCALAR >::isInstalledNode(), gum::MarginalTargetedInference< GUM_SCALAR >::MarginalTargetedInference(), gum::BayesBall::relevantPotentials(), gum::dSeparation::relevantPotentials(), gum::DAGmodel::size(), gum::BayesNetFragment< GUM_SCALAR >::toDot(), gum::DAGmodel::topologicalOrder(), gum::InfluenceDiagram< GUM_SCALAR >::toString(), and gum::BayesNetFragment< GUM_SCALAR >::whenArcDeleted().

{ return _dag; }

Here is the caller graph for this function:

decisionNodeSize()

template<typename GUM_SCALAR >

INLINE Size gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize

(

)

const

Returns the number of decision nodes.

Definition at line 307 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, and gum::DAGmodel::size().

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

                                                                     {
    return (size() - __utilityMap.size() - __potentialMap.size());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

decisionOrderExists()

template<typename GUM_SCALAR >

bool gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists

(

)

const

True if a directed path exist with all decison nodes.

Definition at line 609 of file influenceDiagram_tpl.h.

References gum::SequenceImplementation< Key, Alloc, Gen >::begin(), gum::SequenceImplementation< Key, Alloc, Gen >::end(), gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::DAGmodel::topologicalOrder().

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::__checkTemporalOrder(), and gum::InfluenceDiagram< GUM_SCALAR >::getDecisionOrder().

                                                                 {
    const Sequence< NodeId >& order = topologicalOrder(true);

    // Finding first decision node
    Sequence< NodeId >::const_iterator orderIter = order.begin();

    while ((orderIter != order.end()) && (!isDecisionNode(*orderIter)))
      ++orderIter;

    if (orderIter == order.end()) return true;

    NodeId parentDecision = (*orderIter);
    ++orderIter;

    // Checking path between decisions nodes
    while (orderIter != order.end()) {
      if (isDecisionNode(*orderIter)) {
        if (!existsPathBetween(parentDecision, *orderIter)) return false;

        parentDecision = *orderIter;
      }

      ++orderIter;
    }

    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

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

inherited

Retursn true if this Directed Graphical Model is empty.

Definition at line 99 of file DAGmodel_inl.h.

References gum::DAGmodel::size().

{ return size() == 0; }

Here is the call graph for this function:

erase() [1/2]

template<typename GUM_SCALAR >

void gum::InfluenceDiagram< GUM_SCALAR >::erase

(

NodeId

id

)

Erase a Variable from the network and remove the variable from all his childs.

If no variable matches the id, then nothing is done.

Parameters

id	The id of the variable to erase.

Definition at line 490 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, gum::DAGmodel::_dag, gum::ArcGraphPart::children(), gum::VariableNodeMap::erase(), gum::DiGraph::eraseNode(), gum::VariableNodeMap::exists(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), and gum::InfluenceDiagram< GUM_SCALAR >::variable().

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

                                                         {
    if (__variableMap.exists(varId)) {
      // Reduce the variable child's CPT or Utility Table if necessary
      for (const auto chi : _dag.children(varId))
        if (isChanceNode(chi))
          __potentialMap[chi]->erase(variable(varId));
        else if (isUtilityNode(chi))
          __utilityMap[chi]->erase(variable(varId));

      if (isChanceNode(varId)) {
        delete __potentialMap[varId];
        __potentialMap.erase(varId);
      } else if (isUtilityNode(varId)) {
        delete __utilityMap[varId];
        __utilityMap.erase(varId);
      }

      __variableMap.erase(varId);
      _dag.eraseNode(varId);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

erase() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::InfluenceDiagram< GUM_SCALAR >::erase

(

const DiscreteVariable &

var

)

Erase a Variable from the network and remove the variable from all his childs.

If no variable matches, then nothing is done.

Parameters

var	The reference on the variable to remove.

Definition at line 518 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, gum::InfluenceDiagram< GUM_SCALAR >::erase(), and gum::VariableNodeMap::get().

                                                                               {
    erase(__variableMap.get(var));
  }

Here is the call graph for this function:

eraseArc() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::InfluenceDiagram< GUM_SCALAR >::eraseArc

(

const Arc &

arc

)

Removes an arc in the ID, and update diagram's potential nodes cpt if necessary.

If (tail, head) doesn't exist, the nothing happens.

Parameters

arc	The arc removed.

Definition at line 558 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::DAGmodel::_dag, gum::ArcGraphPart::eraseArc(), gum::ArcGraphPart::existsArc(), gum::Arc::head(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), gum::Arc::tail(), and gum::InfluenceDiagram< GUM_SCALAR >::variable().

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

                                                                     {
    if (_dag.existsArc(arc)) {
      NodeId head = arc.head(), tail = arc.tail();
      _dag.eraseArc(arc);

      if (isChanceNode(head))
        // Removes parent in the child's CPT
        (*(__potentialMap[head])) >> variable(tail);
      else if (isUtilityNode(head))
        // Removes parent in the child's UT
        (*(__utilityMap[head])) >> variable(tail);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

eraseArc() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::InfluenceDiagram< GUM_SCALAR >::eraseArc	(	NodeId	tail,
		NodeId	head
	)

RRemoves an arc in the ID, and update diagram's potential nodes cpt if necessary.

If (tail, head) doesn't exist, the nothing happens.

Parameters

head	and
tail	as NodeId

Definition at line 578 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::eraseArc().

                                                                               {
    eraseArc(Arc(tail, head));
  }

Here is the call graph for this function:

existsPathBetween()

template<typename GUM_SCALAR >

bool gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween	(	NodeId	src,
		NodeId	dest
	)		const

Returns true if a path exists between two nodes.

Definition at line 641 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::ArcGraphPart::children(), gum::List< Val, Alloc >::empty(), gum::List< Val, Alloc >::front(), gum::NodeGraphPart::nodesProperty(), gum::List< Val, Alloc >::popFront(), and gum::List< Val, Alloc >::pushBack().

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

                                                                            {
    List< NodeId > nodeFIFO;
    // mark[node] contains 0 if not visited
    // mark[node] = predecessor if visited
    NodeProperty< int > mark = _dag.nodesProperty((int)-1);
    NodeId              current;

    mark[src] = (int)src;
    nodeFIFO.pushBack(src);

    while (!nodeFIFO.empty()) {
      current = nodeFIFO.front();
      nodeFIFO.popFront();

      for (const auto new_one : _dag.children(current)) {
        if (mark[new_one] != -1)
          continue;   // if this node is already marked, continue

        mark[new_one] = (int)current;

        if (new_one == dest) break;   // if we reach *orderIter, stop.

        nodeFIFO.pushBack(new_one);
      }
    }

    if (mark[dest] == -1) return false;

    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getDecisionGraph()

template<typename GUM_SCALAR >

gum::DAG * gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph

(

)

const

Returns the temporal Graph.

Definition at line 677 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision(), gum::DAG::addArc(), gum::NodeGraphPart::addNodeWithId(), gum::NodeGraphPart::existsNode(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::NodeGraphPart::nodes().

                                                                 {
    gum::DAG* temporalGraph = new gum::DAG();

    for (const auto node : _dag.nodes()) {
      if (isDecisionNode(node)) {
        if (!temporalGraph->existsNode(node)) temporalGraph->addNodeWithId(node);

        for (const auto chi : _getChildrenDecision(node)) {
          if (!temporalGraph->existsNode(chi)) temporalGraph->addNodeWithId(chi);

          temporalGraph->addArc(node, chi);
        }
      }
    }

    return temporalGraph;
  }

Here is the call graph for this function:

getDecisionOrder()

template<typename GUM_SCALAR >

std::vector< NodeId > * gum::InfluenceDiagram< GUM_SCALAR >::getDecisionOrder

(

)

const

Returns the sequence of decision nodes in the directed path.

Exceptions

NotFound

if such a path does not exist

Definition at line 738 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists(), GUM_ERROR, gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::DAGmodel::topologicalOrder().

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

                                                                              {
    if (!decisionOrderExists()) { GUM_ERROR(NotFound, "No decision path exists"); }

    std::vector< NodeId >* decisionSequence = new std::vector< NodeId >();

    for (const auto elt : topologicalOrder(false))
      if (isDecisionNode(elt)) decisionSequence->push_back(elt);

    return decisionSequence;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getPartialTemporalOrder()

template<typename GUM_SCALAR >

const List< NodeSet > & gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder

(

bool

clear = true

)

const

Returns partial temporal ordering.

Exceptions

NotFound

if such a sequence does not exist

Definition at line 755 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__temporalOrder, gum::DAGmodel::_dag, gum::NodeGraphPart::asNodeSet(), gum::Set< Key, Alloc >::contains(), gum::Set< Key, Alloc >::empty(), gum::Set< Key, Alloc >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionOrder(), gum::Set< Key, Alloc >::insert(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), and gum::ArcGraphPart::parents().

                                                                             {
    if (clear) {
      __temporalOrder.clear();

      std::vector< NodeId >* decisionOrder = getDecisionOrder();
      NodeSet                nodeList = _dag.asNodeSet();

      for (Idx i = 0; i < decisionOrder->size(); i++) {
        NodeSet partialOrderedSet;

        for (const auto par : _dag.parents(decisionOrder->at(i))) {
          if (nodeList.contains(par) && isChanceNode(par)) {
            partialOrderedSet.insert(par);
            nodeList.erase(par);
          }
        }

        if (!partialOrderedSet.empty())
          __temporalOrder.pushFront(partialOrderedSet);

        NodeSet decisionSet;

        decisionSet.insert(decisionOrder->at(i));

        __temporalOrder.pushFront(decisionSet);
      }

      NodeSet lastSet;   //= new gum::NodeSet();

      for (const auto node : nodeList)
        if (isChanceNode(node)) lastSet.insert(node);

      if (!lastSet.empty()) __temporalOrder.pushFront(lastSet);
    }

    return __temporalOrder;
  }

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 121 of file DAGmodel.cpp.

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

Referenced by gum::DAGmodel::children().

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

Here is the call graph for this function:

Here is the caller graph for this function:

idFromName()

template<typename GUM_SCALAR >

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

virtual

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implements gum::DAGmodel.

Definition at line 342 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, and gum::VariableNodeMap::idFromName().

                                                                               {
    return __variableMap.idFromName(name);
  }

Here is the call graph for this function:

isChanceNode()

template<typename GUM_SCALAR >

INLINE bool gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode

(

NodeId

varId

)

const

Returns true if node is a chance one.

Definition at line 283 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::InfluenceDiagram< GUM_SCALAR >::toDot().

                                                                             {
    return __potentialMap.exists(varId);
  }

Here is the caller graph for this function:

isDecisionNode()

template<typename GUM_SCALAR >

INLINE bool gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode

(

NodeId

varId

)

const

Returns true if node is a decision one.

Definition at line 271 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), and gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode().

Referenced by gum::InfluenceDiagramGenerator< GUM_SCALAR >::__checkTemporalOrder(), gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision(), gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), and gum::InfluenceDiagram< GUM_SCALAR >::getDecisionOrder().

                                                                               {
    bool ret = true;

    if (isUtilityNode(varId) || isChanceNode(varId)) ret = false;

    return ret;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isUtilityNode()

template<typename GUM_SCALAR >

INLINE bool gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode

(

NodeId

varId

)

const

Returns true if node is a utility one.

Definition at line 263 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::InfluenceDiagram< GUM_SCALAR >::toDot().

                                                                              {
    return __utilityMap.exists(varId);
  }

Here is the caller graph for this function:

log10DomainSize()

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

inherited

Returns

Returns the log10 domain size of the joint probabilty for the Directed Graphical Model

Definition at line 75 of file DAGmodel_inl.h.

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

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

                                         {
    double dSize = 0.0;

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

    return dSize;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

moralGraph()

const UndiGraph & gum::DAGmodel::moralGraph ( bool  clear = true ) const

inherited

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

Parameters

clear

If false returns the previously created moral graph.

Definition at line 101 of file DAGmodel.cpp.

References gum::DAGmodel::__moralGraph(), gum::DAGmodel::__mutableMoralGraph, and gum::UndiGraph::clear().

Referenced by gum::prm::SVED< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodes(), gum::prm::SVED< GUM_SCALAR >::__eliminateNodesWithEvidence(), gum::prm::SVE< GUM_SCALAR >::__eliminateNodesWithEvidence(), gum::prm::SVED< GUM_SCALAR >::__initLiftedNodes(), gum::prm::SVE< GUM_SCALAR >::__initLiftedNodes(), and gum::DAGmodel::children().

                                                        {
    if (clear
        || (__mutableMoralGraph == nullptr)) {   // we have to call _moralGraph
      if (__mutableMoralGraph == nullptr) {
        __mutableMoralGraph = new UndiGraph();
      } else {
        // clear is True ,__mutableMoralGraph exists
        __mutableMoralGraph->clear();
      }

      __moralGraph();
    }

    return *__mutableMoralGraph;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

nodeId()

template<typename GUM_SCALAR >

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

virtual

Return id node from discrete var pointer.

Exceptions

NotFound

If no variable matches var.

Implements gum::DAGmodel.

Definition at line 335 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, and gum::VariableNodeMap::get().

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

                                                                                 {
    return __variableMap.get(var);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

nodes()

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

inherited

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

Definition at line 115 of file DAGmodel_inl.h.

References gum::DAGmodel::_dag.

Referenced by gum::credal::CredalNet< GUM_SCALAR >::__bnCopy(), gum::EssentialGraph::__buildEssentialGraph(), gum::MarkovBlanket::__buildMarkovBlanket(), gum::DAGmodel::__moralGraph(), gum::credal::CredalNet< GUM_SCALAR >::__sort_varType(), gum::credal::CNMonteCarloSampling< GUM_SCALAR, BNInferenceEngine >::__verticesSampling(), gum::ImportanceSampling< GUM_SCALAR >::_unsharpenBN(), gum::BayesNetFactory< GUM_SCALAR >::BayesNetFactory(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::learning::DAG2BNLearner< ALLOC >::createBN(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::disturbBN(), gum::Estimator< GUM_SCALAR >::Estimator(), gum::getMaxModality(), gum::DAGmodel::hasSameStructure(), gum::DAGmodel::log10DomainSize(), gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities(), gum::prm::ClassBayesNet< GUM_SCALAR >::modalities(), gum::Estimator< GUM_SCALAR >::setFromBN(), gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot(), gum::prm::ClassBayesNet< GUM_SCALAR >::toDot(), gum::credal::CredalNet< GUM_SCALAR >::toString(), and gum::BayesNetFragment< GUM_SCALAR >::~BayesNetFragment().

                                                    {
    return (NodeGraphPart&)_dag;
  }

Here is the caller graph for this function:

operator=()

template<typename GUM_SCALAR >

InfluenceDiagram< GUM_SCALAR > & gum::InfluenceDiagram< GUM_SCALAR >::operator=

(

const InfluenceDiagram< GUM_SCALAR > &

source

)

Copy Operator.

Definition at line 74 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap, gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap, gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), and gum::DAGmodel::operator=().

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

                                                                                          {
    if (this != &source) {
      DAGmodel::operator=(source);
      // Removing previous potentials
      _removeTables();
      __potentialMap.clear();
      __utilityMap.clear();

      __variableMap = source.__variableMap;

      // Copying tables
      _copyTables(source);
    }

    return *this;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

parents() [1/2]

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 arcs returned may be empty if no arc within the ArcGraphPart is ingoing into the given node.

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 106 of file DAGmodel_inl.h.

References gum::DAGmodel::_dag, and gum::ArcGraphPart::parents().

Referenced by gum::MarkovBlanket::__buildMarkovBlanket(), gum::DAGmodel::__moralGraph(), gum::BayesNetFragment< GUM_SCALAR >::_installCPT(), gum::BayesNetFragment< GUM_SCALAR >::checkConsistency(), gum::DAGmodel::children(), gum::BayesNetFragment< GUM_SCALAR >::installCPT(), gum::DAGmodel::parents(), gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot(), and gum::prm::ClassBayesNet< GUM_SCALAR >::toDot().

                                                               {
    return _dag.parents(id);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

parents() [2/2]

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

inlineinherited

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

Note that the set of arcs returned may be empty if no arc within the ArcGraphPart is ingoing into the given node.

Parameters

id	the node toward which the arcs returned are pointing

Definition at line 156 of file DAGmodel.h.

References gum::DAGmodel::children(), gum::DAGmodel::idFromName(), and gum::DAGmodel::parents().

                                                        {
      return parents(idFromName(name));
    };

Here is the call graph for this function:

property()

INLINE const std::string & gum::DAGmodel::property ( const std::string &  name ) const

inherited

Return the value of the property name of this DAGModel.

Exceptions

NotFound

Raised if no name property is found.

Definition at line 37 of file DAGmodel_inl.h.

References gum::DAGmodel::__properties(), and GUM_ERROR.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

propertyWithDefault()

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

inherited

Return the value of the property name of this DAGModel.

return byDefault if the property name is not found

Definition at line 48 of file DAGmodel_inl.h.

References gum::DAGmodel::__properties().

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

Here is the call graph for this function:

setProperty()

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

inherited

Add or change a property of this DAGModel.

Definition at line 56 of file DAGmodel_inl.h.

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

Referenced by gum::BayesNet< double >::fastPrototype().

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

Here is the call graph for this function:

Here is the caller graph for this function:

size()

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

inherited

Returns the number of variables in this Directed Graphical Model.

Definition at line 96 of file DAGmodel_inl.h.

References gum::DAGmodel::dag(), and gum::NodeGraphPart::size().

Referenced by gum::credal::CredalNet< GUM_SCALAR >::__initCNNets(), gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize(), gum::DAGmodel::empty(), gum::MarkovBlanket::hasSameStructure(), gum::DAGmodel::hasSameStructure(), gum::IBayesNet< double >::operator==(), gum::prm::InstanceBayesNet< GUM_SCALAR >::toDot(), and gum::prm::ClassBayesNet< GUM_SCALAR >::toDot().

{ return dag().size(); }

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

References gum::DAGmodel::_dag, and gum::ArcGraphPart::sizeArcs().

Referenced by gum::MarkovBlanket::hasSameStructure(), gum::DAGmodel::hasSameStructure(), and gum::IBayesNet< double >::operator==().

{ return _dag.sizeArcs(); }

Here is the call graph for this function:

Here is the caller graph for this function:

toDot()

template<typename GUM_SCALAR >

std::string gum::InfluenceDiagram< GUM_SCALAR >::toDot

(

)

const

Returns

Returns a dot representation of this Influence Diagram.

Definition at line 167 of file influenceDiagram_tpl.h.

References gum::DAGmodel::_dag, gum::ArcGraphPart::children(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), gum::Variable::name(), gum::NodeGraphPart::nodes(), gum::DAGmodel::property(), gum::Set< Key, Alloc >::size(), and gum::InfluenceDiagram< GUM_SCALAR >::variable().

                                                        {
    std::stringstream output;
    std::stringstream decisionNode;
    std::stringstream utilityNode;
    std::stringstream chanceNode;
    std::stringstream arcstream;
    output << "digraph \"";

    try {
      output << this->property("name") << "\" {" << std::endl;
    } catch (NotFound&) { output << "no_name\" {" << std::endl; }

    output << "  node [bgcolor=\"#AAAAAA\", style=filled];" << std::endl;

    decisionNode << "node [shape = box];" << std::endl;

    utilityNode << "node [shape = diamond];" << std::endl;
    chanceNode << "node [shape = ellipse];" << std::endl;
    std::string tab = "  ";

    for (const auto node : _dag.nodes()) {
      if (isChanceNode(node))
        chanceNode << tab << "\"" << variable(node).name() << "\""
                   << ";";
      else if (isUtilityNode(node))
        utilityNode << tab << "\"" << variable(node).name() << "\""
                    << ";";
      else
        decisionNode << tab << "\"" << variable(node).name() << "\""
                     << ";";

      if (_dag.children(node).size() > 0)
        for (const auto chi : _dag.children(node))
          arcstream << tab << "\"" << variable(node).name() << "\""
                    << " -> "
                    << "\"" << variable(chi).name() << "\""
                    << ";" << std::endl;
    }

    output << decisionNode.str() << std::endl
           << utilityNode.str() << std::endl
           << chanceNode.str() << std::endl
           << arcstream.str() << std::endl
           << "}" << std::endl;

    return output.str();
  }

Here is the call graph for this function:

topologicalOrder()

const Sequence< NodeId > & gum::DAGmodel::topologicalOrder ( bool  clear = true ) 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 117 of file DAGmodel.cpp.

References gum::DAGmodel::dag(), and gum::DiGraph::topologicalOrder().

Referenced by gum::EssentialGraph::__buildEssentialGraph(), gum::InfluenceDiagramGenerator< GUM_SCALAR >::__checkTemporalOrder(), gum::DAGmodel::children(), gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists(), and gum::InfluenceDiagram< GUM_SCALAR >::getDecisionOrder().

                                                                       {
    return this->dag().topologicalOrder(clear);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

template<typename GUM_SCALAR >

std::string gum::InfluenceDiagram< GUM_SCALAR >::toString

(

)

const

Returns

Returns a string representation of this Influence Diagram.

Definition at line 216 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::chanceNodeSize(), gum::DAGmodel::dag(), gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize(), gum::DAGmodel::log10DomainSize(), gum::ArcGraphPart::sizeArcs(), and gum::InfluenceDiagram< GUM_SCALAR >::utilityNodeSize().

                                                           {
    std::stringstream output;

    output << "Influence Diagram{" << std::endl;
    output << "  chance: " << chanceNodeSize() << "," << std::endl;
    output << "  utility: " << utilityNodeSize() << "," << std::endl;
    output << "  decision: " << decisionNodeSize() << "," << std::endl;
    output << "  arcs: " << dag().sizeArcs() << "," << std::endl;

    double dSize = log10DomainSize();

    if (dSize > 6)
      output << "  domainSize: 10^" << dSize;
    else
      output << "  domainSize: " << std::round(std::pow(10.0, dSize));

    output << std::endl << "}";

    return output.str();
  }

Here is the call graph for this function:

utility()

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::InfluenceDiagram< GUM_SCALAR >::utility ( NodeId  varId ) const

virtual

Returns the utility table of a utility node.

Exceptions

NotFound

If no variable's id matches varId.

Definition at line 255 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), and gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID().

                                                                         {
    return *(__utilityMap[varId]);
  }

Here is the caller graph for this function:

utilityNodeSize()

template<typename GUM_SCALAR >

INLINE Size gum::InfluenceDiagram< GUM_SCALAR >::utilityNodeSize

(

)

const

Returns the number of utility nodes.

Definition at line 291 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap.

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

                                                                    {
    return __utilityMap.size();
  }

Here is the caller graph for this function:

variable()

template<typename GUM_SCALAR >

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

virtual

Returns a constant reference over a variabe given it's node id.

Exceptions

NotFound

If no variable's id matches varId.

Implements gum::DAGmodel.

Definition at line 326 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::addUtilityNode(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID(), and gum::InfluenceDiagram< GUM_SCALAR >::toDot().

                                                                       {
    return __variableMap[id];
  }

Here is the caller graph for this function:

variableFromName()

template<typename GUM_SCALAR >

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

virtual

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implements gum::DAGmodel.

Definition at line 348 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap, and gum::VariableNodeMap::variableFromName().

                                  {
    return __variableMap.variableFromName(name);
  }

Here is the call graph for this function:

variableNodeMap()

template<typename GUM_SCALAR >

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

virtual

Returns a constant reference to the VariableNodeMap of this Influence Diagram.

Implements gum::DAGmodel.

Definition at line 317 of file influenceDiagram_tpl.h.

References gum::InfluenceDiagram< GUM_SCALAR >::__variableMap.

                                                                     {
    return __variableMap;
  }

Member Data Documentation

__potentialMap

template<typename GUM_SCALAR>

NodeProperty< Potential< GUM_SCALAR >* > gum::InfluenceDiagram< GUM_SCALAR >::__potentialMap

private

Mapping between potential variable's id and their CPT.

Definition at line 387 of file influenceDiagram.h.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::addChanceNode(), gum::InfluenceDiagram< GUM_SCALAR >::chanceNodeSize(), gum::InfluenceDiagram< GUM_SCALAR >::cpt(), gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::isChanceNode(), and gum::InfluenceDiagram< GUM_SCALAR >::operator=().

__temporalOrder

template<typename GUM_SCALAR>

List< NodeSet > gum::InfluenceDiagram< GUM_SCALAR >::__temporalOrder

mutableprivate

The temporal order.

Definition at line 392 of file influenceDiagram.h.

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

__utilityMap

template<typename GUM_SCALAR>

NodeProperty< Potential< GUM_SCALAR >* > gum::InfluenceDiagram< GUM_SCALAR >::__utilityMap

private

Mapping between utility variable's id and their utility table.

Definition at line 389 of file influenceDiagram.h.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::InfluenceDiagram< GUM_SCALAR >::addUtilityNode(), gum::InfluenceDiagram< GUM_SCALAR >::decisionNodeSize(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::isUtilityNode(), gum::InfluenceDiagram< GUM_SCALAR >::operator=(), gum::InfluenceDiagram< GUM_SCALAR >::utility(), and gum::InfluenceDiagram< GUM_SCALAR >::utilityNodeSize().

__variableMap

template<typename GUM_SCALAR>

VariableNodeMap gum::InfluenceDiagram< GUM_SCALAR >::__variableMap

private

Mapping between id and variable.

Definition at line 384 of file influenceDiagram.h.

Referenced by gum::InfluenceDiagram< GUM_SCALAR >::_addNode(), gum::InfluenceDiagram< GUM_SCALAR >::changeVariableName(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::idFromName(), gum::InfluenceDiagram< GUM_SCALAR >::nodeId(), gum::InfluenceDiagram< GUM_SCALAR >::operator=(), gum::InfluenceDiagram< GUM_SCALAR >::variable(), gum::InfluenceDiagram< GUM_SCALAR >::variableFromName(), and gum::InfluenceDiagram< GUM_SCALAR >::variableNodeMap().

_dag

DAG gum::DAGmodel::_dag

protectedinherited

The DAG of this Directed Graphical Model.

Definition at line 203 of file DAGmodel.h.

Referenced by gum::prm::ClassBayesNet< GUM_SCALAR >::__get(), gum::InfluenceDiagram< GUM_SCALAR >::_addNode(), gum::InfluenceDiagram< GUM_SCALAR >::_copyTables(), gum::InfluenceDiagram< GUM_SCALAR >::_getChildrenDecision(), gum::BayesNetFragment< GUM_SCALAR >::_installArc(), gum::InfluenceDiagram< GUM_SCALAR >::_moralGraph(), gum::InfluenceDiagram< GUM_SCALAR >::_removeTables(), gum::BayesNetFragment< GUM_SCALAR >::_uninstallArc(), gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::DAGmodel::arcs(), gum::DAGmodel::children(), gum::DAGmodel::dag(), gum::InfluenceDiagram< GUM_SCALAR >::erase(), gum::InfluenceDiagram< GUM_SCALAR >::eraseArc(), gum::InfluenceDiagram< GUM_SCALAR >::existsPathBetween(), gum::InfluenceDiagram< GUM_SCALAR >::getDecisionGraph(), gum::InfluenceDiagram< GUM_SCALAR >::getPartialTemporalOrder(), gum::BayesNetFragment< GUM_SCALAR >::installNode(), gum::DAGmodel::nodes(), gum::DAGmodel::operator=(), gum::DAGmodel::parents(), gum::DAGmodel::sizeArcs(), gum::InfluenceDiagram< GUM_SCALAR >::toDot(), and gum::BayesNetFragment< GUM_SCALAR >::uninstallNode().

---

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

• agrum/ID/influenceDiagram.h
• agrum/ID/influenceDiagram_tpl.h