gum::DAGmodel Class Reference

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

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

Inheritance diagram for gum::DAGmodel:

Collaboration diagram for gum::DAGmodel:

Public Member Functions
bool	hasSameStructure (const DAGmodel &other)
double	log10DomainSize () const
Constructors / Destructors
	DAGmodel ()
	Default constructor. More...
virtual	~DAGmodel ()
	Destructor. More...
	DAGmodel (const DAGmodel &source)
	Copy constructor. More...
Variable manipulation methods.
const DAG &	dag () const
	Returns a constant reference to the dag of this Bayes Net. More...
virtual Size	size () const final
	Returns the number of variables in this Directed Graphical Model. More...
Size	sizeArcs () const
	Returns the number of arcs in this Directed Graphical Model. More...
const NodeGraphPart &	nodes () const final
	Returns a constant reference to the dag of this Bayes Net. More...
bool	exists (NodeId node) const final
	Return true if this node exists in this graphical model. More...
Arc manipulation methods.
const ArcSet &	arcs () const
	return true if the arc tail->head exists in the DAGmodel More...
bool	existsArc (const NodeId tail, const NodeId head) const
	return true if the arc tail->head exists in the DAGmodel More...
bool	existsArc (const std::string &nametail, const std::string &namehead) const
	return true if the arc tail->head exists in the DAGmodel 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
	return true if the arc tail->head exists in the DAGmodel More...
NodeSet	parents (const NodeSet &ids) const
	returns the parents of a set of nodes More...
NodeSet	parents (const std::vector< std::string > &names) const
	return true if the arc tail->head exists in the DAGmodel More...
NodeSet	family (const NodeId id) const
	returns the parents of a node and the node More...
NodeSet	family (const std::string &name) const
	return true if the arc tail->head exists in the DAGmodel 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
	return true if the arc tail->head exists in the DAGmodel More...
NodeSet	children (const NodeSet &ids) const
	returns the children of a set of nodes More...
NodeSet	children (const std::vector< std::string > &names) const
	return true if the arc tail->head exists in the DAGmodel More...
NodeSet	descendants (const NodeId id) const
	returns the set of nodes with directed path outgoing from a given node More...
NodeSet	descendants (const std::string &name) const
	return true if the arc tail->head exists in the DAGmodel More...
NodeSet	ancestors (const NodeId id) const
	returns the set of nodes with directed path ingoing to a given node More...
NodeSet	ancestors (const std::string &name) const
	return true if the arc tail->head exists in the DAGmodel More...
Graphical methods
UndiGraph	moralizedAncestralGraph (const NodeSet &nodes) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes More...
UndiGraph	moralizedAncestralGraph (const std::vector< std::string > &nodenames) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes More...
bool	isIndependent (NodeId X, NodeId Y, const NodeSet &Z) const final
	check if node X and node Y are independent given nodes Z More...
bool	isIndependent (const NodeSet &X, const NodeSet &Y, const NodeSet &Z) const final
	check if nodes X and nodes Y are independent given nodes Z More...
bool	isIndependent (const std::string &Xname, const std::string &Yname, const std::vector< std::string > &Znames) const
	build a UndiGraph by moralizing the Ancestral Graph of a set of Nodes More...
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 More...
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...
Getter and setters
const std::string &	property (const std::string &name) const
	Return the value of the property name of this GraphicalModel. More...
const std::string &	propertyWithDefault (const std::string &name, const std::string &byDefault) const
	Return the value of the property name of this GraphicalModel. More...
void	setProperty (const std::string &name, const std::string &value)
	Add or change a property of this GraphicalModel. More...
Variable manipulation methods.
virtual const VariableNodeMap &	variableNodeMap () const =0
	Returns a constant reference to the VariableNodeMap of this Graphical Model. More...
virtual bool	empty () const
	Return true if this graphical model is empty. More...
bool	exists (const std::string &name) const
	Return true if this graphical model is empty. More...
std::vector< std::string >	names (const std::vector< NodeId > &ids) const
	transform a vector of NodeId in a vector of names More...
std::vector< std::string >	names (const NodeSet &ids) const
	transform a NodeSet in a vector of names More...
std::vector< NodeId >	ids (const std::vector< std::string > &names) const
	transform a vector of names into a vector of nodeId More...
NodeSet	nodeset (const std::vector< std::string > &names) const
	transform a vector of names into a NodeSet More...
Instantiation	completeInstantiation () const
	Get an instantiation over all the variables of the model. More...
virtual const DiscreteVariable &	variable (NodeId id) const =0
	Returns a constant reference over a variable given it's node id. More...
virtual NodeId	nodeId (const DiscreteVariable &var) const =0
	Return id node src discrete var pointer. More...
virtual NodeId	idFromName (const std::string &name) const =0
	Getter by name. More...
virtual const DiscreteVariable &	variableFromName (const std::string &name) const =0
	Getter by name. More...

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

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

Detailed Description

Virtual base class for PGMs using a DAG.

Definition at line 47 of file DAGmodel.h.

Constructor & Destructor Documentation

DAGmodel() [1/2]

gum::DAGmodel::DAGmodel

(

)

Default constructor.

Definition at line 29 of file DAGmodel.cpp.

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

                     : mutableMoralGraph__(nullptr) {
    GUM_CONSTRUCTOR(DAGmodel);
  }

Here is the call graph for this function:

~DAGmodel()

gum::DAGmodel::~DAGmodel ( )

virtual

Destructor.

Definition at line 38 of file DAGmodel.cpp.

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

                      {
    GUM_DESTRUCTOR(DAGmodel);
    if (mutableMoralGraph__ != nullptr) { delete mutableMoralGraph__; }
  }

Here is the call graph for this function:

DAGmodel() [2/2]

gum::DAGmodel::DAGmodel

(

const DAGmodel &

source

)

Copy constructor.

Do nothing.

Definition at line 33 of file DAGmodel.cpp.

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

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

Here is the call graph for this function:

Member Function Documentation

ancestors() [1/2]

INLINE NodeSet gum::DAGmodel::ancestors

(

const NodeId

id

)

const

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

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

Parameters

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

Definition at line 112 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

ancestors() [2/2]

INLINE NodeSet gum::DAGmodel::ancestors

(

const std::string &

name

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 116 of file DAGmodel_inl.h.

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

                                                                {
    return ancestors(idFromName(name));
  }

Here is the call graph for this function:

arcs()

INLINE const ArcSet & gum::DAGmodel::arcs

(

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 43 of file DAGmodel_inl.h.

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

{ return dag_.arcs(); }

Here is the call graph for this function:

children() [1/4]

INLINE const NodeSet & gum::DAGmodel::children

(

const NodeId

id

)

const

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

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

Parameters

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

Definition at line 70 of file DAGmodel_inl.h.

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

                                                                {
    return dag_.children(id);
  }

Here is the call graph for this function:

children() [2/4]

INLINE const NodeSet & gum::DAGmodel::children

(

const std::string &

name

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 73 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

children() [3/4]

INLINE NodeSet gum::DAGmodel::children

(

const NodeSet &

ids

)

const

returns the children of a set of nodes

Definition at line 77 of file DAGmodel_inl.h.

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

                                                            {
    return dag_.children(ids);
  }

Here is the call graph for this function:

children() [4/4]

INLINE NodeSet gum::DAGmodel::children

(

const std::vector< std::string > &

names

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 82 of file DAGmodel_inl.h.

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

                                                                 {
    return children(nodeset(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 86 of file graphicalModel_inl.h.

                                                            {
    Instantiation I;

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

    return I;
  }

dag()

INLINE const DAG & gum::DAGmodel::dag

(

)

const

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

Definition at line 35 of file DAGmodel_inl.h.

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

{ return dag_; }

Here is the call graph for this function:

descendants() [1/2]

INLINE NodeSet gum::DAGmodel::descendants

(

const NodeId

id

)

const

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

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

Parameters

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

Definition at line 104 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

descendants() [2/2]

INLINE NodeSet gum::DAGmodel::descendants

(

const std::string &

name

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 108 of file DAGmodel_inl.h.

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

                                                                  {
    return descendants(idFromName(name));
  }

Here is the call graph for this function:

empty()

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

virtualinherited

Return true if this graphical model is empty.

Definition at line 96 of file graphicalModel_inl.h.

{ return size() == 0; }

exists() [1/2]

INLINE bool gum::DAGmodel::exists ( NodeId  node ) const

finalvirtual

Return true if this node exists in this graphical model.

Implements gum::GraphicalModel.

Definition at line 94 of file DAGmodel_inl.h.

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

{ return dag_.exists(node); }

Here is the call graph for this function:

exists() [2/2]

bool gum::GraphicalModel::exists ( const std::string &  name ) const

inlineinherited

Return true if this graphical model is empty.

Definition at line 112 of file graphicalModel.h.

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

existsArc() [1/2]

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

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

Parameters

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

Returns

true if the arc exists

Definition at line 45 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

existsArc() [2/2]

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

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

Parameters

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

Returns

true if the arc exists

Definition at line 49 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

family() [1/2]

INLINE NodeSet gum::DAGmodel::family

(

const NodeId

id

)

const

returns the parents of a node and the 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 62 of file DAGmodel_inl.h.

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

                                                       {
    return dag_.family(id);
  }

Here is the call graph for this function:

family() [2/2]

INLINE NodeSet gum::DAGmodel::family

(

const std::string &

name

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 66 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

hasSameStructure()

bool gum::DAGmodel::hasSameStructure

(

const DAGmodel &

other

)

Returns

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

Definition at line 74 of file DAGmodel.cpp.

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

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

idFromName()

virtual NodeId gum::GraphicalModel::idFromName ( const std::string &  name ) const

pure virtualinherited

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

ids()

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

inherited

transform a vector of names into a vector of nodeId

Returns

the vector of names

Definition at line 122 of file graphicalModel_inl.h.

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

isIndependent() [1/4]

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 131 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

isIndependent() [2/4]

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 135 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

isIndependent() [3/4]

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

inline

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

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

isIndependent() [4/4]

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

inline

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

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

log10DomainSize()

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

inherited

Definition at line 75 of file graphicalModel_inl.h.

                                               {
    double dSize = 0.0;

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

    return dSize;
  }

moralGraph()

const UndiGraph & gum::DAGmodel::moralGraph

(

bool

clear = true

)

const

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

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

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

    return *mutableMoralGraph__;
  }

Here is the call graph for this function:

moralGraph__()

void gum::DAGmodel::moralGraph__ ( ) const

private

Returns the moral graph of this DAGModel.

Warning

mutableMoralGraph__ is assumed to be valid and empty

moralizedAncestralGraph() [1/2]

INLINE UndiGraph gum::DAGmodel::moralizedAncestralGraph

(

const NodeSet &

nodes

)

const

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

Parameters

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

Returns

the moralized ancestral graph

Definition at line 127 of file DAGmodel_inl.h.

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

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

Here is the call graph for this function:

moralizedAncestralGraph() [2/2]

INLINE UndiGraph gum::DAGmodel::moralizedAncestralGraph

(

const std::vector< std::string > &

nodenames

)

const

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

Parameters

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

Returns

the moralized ancestral graph

Definition at line 121 of file DAGmodel_inl.h.

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

                                                    {
    return moralizedAncestralGraph(nodeset(nodenames));
  }

Here is the call graph for this function:

names() [1/2]

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

inherited

transform a vector of NodeId in a vector of names

Returns

the vector of names

Definition at line 100 of file graphicalModel_inl.h.

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

names() [2/2]

INLINE std::vector< std::string > gum::GraphicalModel::names ( const NodeSet &  ids ) const

inherited

transform a NodeSet in a vector of names

Returns

the vector of names

Definition at line 111 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;
  }

nodeId()

virtual NodeId gum::GraphicalModel::nodeId ( const DiscreteVariable &  var ) const

pure virtualinherited

Return id node src discrete var pointer.

Exceptions

NotFound

If no variable matches var.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

nodes()

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

finalvirtual

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

Implements gum::GraphicalModel.

Definition at line 96 of file DAGmodel_inl.h.

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

                                                    {
    return (NodeGraphPart&)dag_;
  }

Here is the call graph for this function:

nodeset()

NodeSet gum::GraphicalModel::nodeset ( const std::vector< std::string > &  names ) const

inherited

transform a vector of names into a NodeSet

Returns

NodeSet

Definition at line 63 of file graphicalModel.cpp.

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

                                                                           {
    NodeSet res;
    for (const auto& name: names) {
      res.insert(idFromName(name));
    }
    return res;
  }

Here is the call graph for this function:

operator=()

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

protected

Private copy operator.

Definition at line 44 of file DAGmodel.cpp.

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

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

      if (mutableMoralGraph__) {
        delete mutableMoralGraph__;
        mutableMoralGraph__ = nullptr;
      }
      dag_ = source.dag_;
    }

    return *this;
  }

Here is the call graph for this function:

parents() [1/4]

INLINE const NodeSet & gum::DAGmodel::parents

(

const NodeId

id

)

const

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

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

Parameters

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

Definition at line 54 of file DAGmodel_inl.h.

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

                                                               {
    return dag_.parents(id);
  }

Here is the call graph for this function:

parents() [2/4]

INLINE const NodeSet & gum::DAGmodel::parents

(

const std::string &

name

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 58 of file DAGmodel_inl.h.

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

                                                                     {
    return parents(idFromName(name));
  }

Here is the call graph for this function:

parents() [3/4]

INLINE NodeSet gum::DAGmodel::parents

(

const NodeSet &

ids

)

const

returns the parents of a set of nodes

Definition at line 86 of file DAGmodel_inl.h.

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

                                                           {
    return dag_.children(ids);
  }

Here is the call graph for this function:

parents() [4/4]

INLINE NodeSet gum::DAGmodel::parents

(

const std::vector< std::string > &

names

)

const

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

Parameters

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

Returns

true if the arc exists

Definition at line 90 of file DAGmodel_inl.h.

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

                                                                            {
    return parents(nodeset(names));
  }

Here is the call graph for this function:

property()

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

inherited

Return the value of the property name of this GraphicalModel.

Exceptions

NotFound

Raised if no name property is found.

Definition at line 38 of file graphicalModel_inl.h.

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

propertyWithDefault()

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

inherited

Return the value of the property name of this GraphicalModel.

return byDefault if the property name is not found

Definition at line 58 of file graphicalModel_inl.h.

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

setProperty()

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

inherited

Add or change a property of this GraphicalModel.

Definition at line 66 of file graphicalModel_inl.h.

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

size()

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

finalvirtual

Returns the number of variables in this Directed Graphical Model.

Implements gum::GraphicalModel.

Definition at line 38 of file DAGmodel_inl.h.

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

{ return dag().size(); }

Here is the call graph for this function:

sizeArcs()

INLINE Size gum::DAGmodel::sizeArcs

(

)

const

Returns the number of arcs in this Directed Graphical Model.

Definition at line 41 of file DAGmodel_inl.h.

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

{ return dag_.sizeArcs(); }

Here is the call graph for this function:

topologicalOrder()

INLINE const Sequence< NodeId > & gum::DAGmodel::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.

Parameters

clear

If false returns the previously created topology.

Definition at line 100 of file DAGmodel_inl.h.

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

                                                                              {
    return dag().topologicalOrder(clear);
  }

Here is the call graph for this function:

variable()

virtual const DiscreteVariable& gum::GraphicalModel::variable ( NodeId  id ) const

pure virtualinherited

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

Exceptions

NotFound

If no variable's id matches varId.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

variableFromName()

virtual const DiscreteVariable& gum::GraphicalModel::variableFromName ( const std::string &  name ) const

pure virtualinherited

Getter by name.

Exceptions

NotFound

if no such name exists in the graph.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

variableNodeMap()

virtual const VariableNodeMap& gum::GraphicalModel::variableNodeMap ( ) const

pure virtualinherited

Returns a constant reference to the VariableNodeMap of this Graphical Model.

Implemented in gum::BayesNet< GUM_SCALAR >, gum::BayesNet< double >, gum::InfluenceDiagram< GUM_SCALAR >, gum::BayesNetFragment< GUM_SCALAR >, gum::IMarkovNet< GUM_SCALAR >, gum::IBayesNet< GUM_SCALAR >, gum::IBayesNet< double >, gum::prm::ClassBayesNet< GUM_SCALAR >, and gum::prm::InstanceBayesNet< GUM_SCALAR >.

Member Data Documentation

dag_

DAG gum::DAGmodel::dag_

protected

The DAG of this Directed Graphical Model.

Definition at line 225 of file DAGmodel.h.

mutableMoralGraph__

UndiGraph* gum::DAGmodel::mutableMoralGraph__

mutableprivate

The moral graph of this Directed Graphical Model.

Definition at line 233 of file DAGmodel.h.

---

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

• agrum/tools/graphicalModels/DAGmodel.h
• agrum/tools/graphicalModels/DAGmodel.cpp
• agrum/tools/graphicalModels/DAGmodel_inl.h