gum::MarkovBlanket Class Reference

Class building the markov Blanket from a BN and a nodeName. More...

#include <agrum/BN/algorithms/MarkovBlanket.h>

Collaboration diagram for gum::MarkovBlanket:

Public Member Functions
	MarkovBlanket (const DAGmodel &m, NodeId n, int level=1)
	MarkovBlanket (const DAGmodel &m, std::string_view name, int level=1)
	~MarkovBlanket ()
DAG	dag () const
std::string	toDot () const
const NodeSet &	parents (NodeId id) const
	wrapping DAG::parents(id)
const NodeSet &	children (NodeId id) const
	wrapping DAG::children(id)
NodeSet	parents (const NodeSet &ids) const
	wrapping DAG::parents(ids)
NodeSet	children (const NodeSet &ids) const
	wrapping DAG::children(ids)
NodeSet	descendants (NodeId id) const
	wrapping DAG::descendants(id)
NodeSet	ancestors (NodeId id) const
	wrapping DAG::ancestors(id)
Size	sizeArcs () const
	wrapping DAG::sizeArcs()
const ArcSet &	arcs () const
	wrapping DAG::arcs()
Size	sizeNodes () const
	wrapping DAG::sizeNodes()
Size	size () const
	wrapping DAG::size()
const NodeGraphPart &	nodes () const
	wrapping DAG::nodes()
bool	hasSameStructure (const DAGmodel &other) const

Private Attributes
const DAGmodel &	_model_
DAG	_mb_
const NodeId	_node_
ArcSet	_specialArcs_

Detailed Description

Class building the markov Blanket from a BN and a nodeName.

The main goal of this class is to build and to encapsulate the DiGraph which represents the Markov Blanket.

Definition at line 67 of file MarkovBlanket.h.

Constructor & Destructor Documentation

MarkovBlanket() [1/2]

gum::MarkovBlanket::MarkovBlanket	(	const DAGmodel &	m,
		NodeId	n,
		int	level = 1 )

Definition at line 56 of file MarkovBlanket.cpp.

                                                                      : _model_(m), _node_(id) {
    if (level < 1) GUM_ERROR(InvalidArgument, "Argument level(=" << level << ") must be >0.")
 
    _mb_ = graph::markovBlanket(m.internalDag(), id, level);
 
    // Add arcs that exist in the model between MB nodes but are not part of
    // the canonical MB definition (e.g. arc between a parent and a co-parent).
    for (const auto node: _mb_.nodes()) {
      for (const auto child: _model_.children(node)) {
        if (_mb_.existsNode(child) && !_mb_.existsArc(Arc(node, child))) {
          _mb_.addArc(node, child);
          _specialArcs_.insert(Arc(node, child));
        }
      }
    }
 
    for (auto node: _mb_)
      _mb_.setName(node, _model_.variable(node).name());
  }

References _mb_, _model_, _node_, GUM_ERROR, gum::DAGmodel::internalDag(), gum::graph::markovBlanket(), and gum::NodeGraphPart::nodes().

Referenced by MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

MarkovBlanket() [2/2]

gum::MarkovBlanket::MarkovBlanket	(	const DAGmodel &	m,
		std::string_view	name,
		int	level = 1 )

Definition at line 76 of file MarkovBlanket.cpp.

                                                                                :
      MarkovBlanket(m, m.idFromName(name), level) {}

References MarkovBlanket().

Here is the call graph for this function:

~MarkovBlanket()

gum::MarkovBlanket::~MarkovBlanket ( )

default

References ancestors(), arcs(), children(), dag(), descendants(), hasSameStructure(), nodes(), parents(), size(), sizeArcs(), sizeNodes(), and toDot().

Here is the call graph for this function:

Member Function Documentation

ancestors()

INLINE NodeSet gum::MarkovBlanket::ancestors

(

NodeId

id

)

const

wrapping DAG::ancestors(id)

Definition at line 68 of file MarkovBlanket_inl.h.

{ return _mb_.ancestors(id); }

References _mb_, and gum::DiGraph::ancestors().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

arcs()

INLINE const ArcSet & gum::MarkovBlanket::arcs

(

)

const

wrapping DAG::arcs()

Definition at line 72 of file MarkovBlanket_inl.h.

{ return _mb_.arcs(); }

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

Referenced by ~MarkovBlanket(), and hasSameStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

children() [1/2]

INLINE NodeSet gum::MarkovBlanket::children

(

const NodeSet &

ids

)

const

wrapping DAG::children(ids)

Definition at line 64 of file MarkovBlanket_inl.h.

{ return _mb_.children(ids); }

References _mb_, and gum::ArcGraphPart::children().

Here is the call graph for this function:

children() [2/2]

INLINE const NodeSet & gum::MarkovBlanket::children

(

NodeId

id

)

const

wrapping DAG::children(id)

Definition at line 60 of file MarkovBlanket_inl.h.

{ return _mb_.children(id); }

References _mb_, and gum::ArcGraphPart::children().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

dag()

INLINE DAG gum::MarkovBlanket::dag

(

)

const

Returns

a copy of the graph

Definition at line 56 of file MarkovBlanket_inl.h.

{ return _mb_; }

References _mb_.

Referenced by ~MarkovBlanket().

Here is the caller graph for this function:

descendants()

INLINE NodeSet gum::MarkovBlanket::descendants

(

NodeId

id

)

const

wrapping DAG::descendants(id)

Definition at line 66 of file MarkovBlanket_inl.h.

{ return _mb_.descendants(id); }

References _mb_, and gum::DiGraph::descendants().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

hasSameStructure()

bool gum::MarkovBlanket::hasSameStructure

(

const DAGmodel &

other

)

const

Returns

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

Definition at line 81 of file MarkovBlanket.cpp.

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

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

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

nodes()

INLINE const NodeGraphPart & gum::MarkovBlanket::nodes

(

)

const

wrapping DAG::nodes()

Definition at line 78 of file MarkovBlanket_inl.h.

{ return _mb_.nodes(); }

References _mb_, and gum::NodeGraphPart::nodes().

Referenced by ~MarkovBlanket(), and hasSameStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

parents() [1/2]

INLINE NodeSet gum::MarkovBlanket::parents

(

const NodeSet &

ids

)

const

wrapping DAG::parents(ids)

Definition at line 62 of file MarkovBlanket_inl.h.

{ return _mb_.parents(ids); }

References _mb_, and gum::ArcGraphPart::parents().

Here is the call graph for this function:

parents() [2/2]

INLINE const NodeSet & gum::MarkovBlanket::parents

(

NodeId

id

)

const

wrapping DAG::parents(id)

Definition at line 58 of file MarkovBlanket_inl.h.

{ return _mb_.parents(id); }

References _mb_, and gum::ArcGraphPart::parents().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

size()

INLINE Size gum::MarkovBlanket::size

(

)

const

wrapping DAG::size()

Definition at line 76 of file MarkovBlanket_inl.h.

{ return _mb_.size(); }

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

Referenced by ~MarkovBlanket(), and hasSameStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

sizeArcs()

INLINE Size gum::MarkovBlanket::sizeArcs

(

)

const

wrapping DAG::sizeArcs()

Definition at line 70 of file MarkovBlanket_inl.h.

{ return _mb_.sizeArcs(); }

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

Referenced by ~MarkovBlanket(), and hasSameStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

sizeNodes()

INLINE Size gum::MarkovBlanket::sizeNodes

(

)

const

wrapping DAG::sizeNodes()

Definition at line 74 of file MarkovBlanket_inl.h.

{ return _mb_.sizeNodes(); }

References _mb_, and gum::NodeGraphPart::sizeNodes().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

toDot()

std::string gum::MarkovBlanket::toDot

(

)

const

Definition at line 99 of file MarkovBlanket.cpp.

                                       {
    std::string    output;
    std::string    nodeStream;
    std::string    arcStream;
    List< NodeId > treatedNodes;
    output          = "digraph \"no_name\" {\n";
    nodeStream      = "node [shape = ellipse];\n";
    std::string tab = "  ";
 
    for (const auto node: _mb_.nodes()) {
      nodeStream += std::format("{}{}[label=\"{}\"", tab, node, _model_.variable(node).name());
      if (node == _node_) { nodeStream += ", color=red"; }
      nodeStream += "];\n";
 
      for (const auto chi: _mb_.children(node)) {
        arcStream += std::format("{}{} -> {}", tab, node, chi);
        if (_specialArcs_.exists(Arc(node, chi))) { arcStream += " [color=grey]"; }
        arcStream += ";\n";
      }
    }
 
    output += nodeStream + '\n' + arcStream + "\n}\n";
 
    return output;
  }

References _mb_, _model_, _node_, _specialArcs_, gum::ArcGraphPart::children(), gum::Set< Key >::exists(), gum::Variable::name(), gum::NodeGraphPart::nodes(), and gum::DiscreteGraphicalModel::variable().

Referenced by ~MarkovBlanket().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_mb_

DAG gum::MarkovBlanket::_mb_

private

Definition at line 122 of file MarkovBlanket.h.

Referenced by MarkovBlanket(), ancestors(), arcs(), children(), children(), dag(), descendants(), nodes(), parents(), parents(), size(), sizeArcs(), sizeNodes(), and toDot().

_model_

const DAGmodel& gum::MarkovBlanket::_model_

private

Definition at line 121 of file MarkovBlanket.h.

Referenced by MarkovBlanket(), hasSameStructure(), and toDot().

_node_

const NodeId gum::MarkovBlanket::_node_

private

Definition at line 123 of file MarkovBlanket.h.

Referenced by MarkovBlanket(), and toDot().

_specialArcs_

ArcSet gum::MarkovBlanket::_specialArcs_

private

Definition at line 124 of file MarkovBlanket.h.

Referenced by toDot().

---

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

• agrum/BN/algorithms/MarkovBlanket.h
• agrum/BN/algorithms/MarkovBlanket.cpp
• agrum/BN/algorithms/MarkovBlanket_inl.h