gum::MarkovBlanket Class Reference

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

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

Collaboration diagram for gum::MarkovBlanket:

Public Member Functions
	MarkovBlanket (const DAGmodel &m, NodeId n)
	MarkovBlanket (const DAGmodel &m, const std::string &name)
	~MarkovBlanket ()
DiGraph	mb ()
std::string	toDot () const
const NodeSet &	parents (const NodeId id) const
	wrapping DiGraph::parents(id) More...
const NodeSet &	children (const NodeId id) const
	wrapping DiGraph::parents(id) More...
Size	sizeArcs () const
	wrapping DiGraph::sizeArcs() More...
const ArcSet &	arcs () const
	wrapping DiGraph::arcs() More...
Size	sizeNodes () const
	wrapping DiGraph::sizeNodes() More...
Size	size () const
	wrapping DiGraph::size() More...
const NodeGraphPart &	nodes () const
	wrapping DiGraph::nodes() More...
bool	hasSameStructure (const DAGmodel &other)

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 47 of file MarkovBlanket.h.

Constructor & Destructor Documentation

MarkovBlanket() [1/2]

gum::MarkovBlanket::MarkovBlanket	(	const DAGmodel &	m,
		NodeId	n
	)

Definition at line 34 of file MarkovBlanket.cpp.

References __buildMarkovBlanket().

                                                           :
      __model(m), __node(id) {
    __buildMarkovBlanket();
  }

Here is the call graph for this function:

MarkovBlanket() [2/2]

gum::MarkovBlanket::MarkovBlanket	(	const DAGmodel &	m,
		const std::string &	name
	)

Definition at line 39 of file MarkovBlanket.cpp.

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

~MarkovBlanket()

gum::MarkovBlanket::~MarkovBlanket

(

)

Definition at line 42 of file MarkovBlanket.cpp.

{}

Member Function Documentation

__buildMarkovBlanket()

void gum::MarkovBlanket::__buildMarkovBlanket ( )

private

Definition at line 44 of file MarkovBlanket.cpp.

References __mb, __model, __node, __specialArcs, gum::DiGraph::addArc(), gum::NodeGraphPart::addNodeWithId(), gum::DAGmodel::children(), gum::NodeGraphPart::exists(), gum::ArcGraphPart::existsArc(), gum::NodeGraphPart::existsNode(), GUM_ERROR, gum::Set< Key, Alloc >::insert(), gum::DAGmodel::nodes(), gum::NodeGraphPart::nodes(), and gum::DAGmodel::parents().

Referenced by MarkovBlanket().

                                           {
    if (!__model.nodes().exists(__node))
      GUM_ERROR(InvalidArgument, "Node " << __node << " does not exist.");

    __mb.addNodeWithId(__node);
    for (const auto& parent : __model.parents(__node)) {
      __mb.addNodeWithId(parent);
      __mb.addArc(parent, __node);
    }

    for (const auto& child : __model.children(__node)) {
      if (!__mb.nodes().exists(child)) __mb.addNodeWithId(child);
      __mb.addArc(__node, child);
      for (const auto& opar : __model.parents(child)) {
        if (opar != __node) {
          if (!__mb.nodes().exists(opar)) __mb.addNodeWithId(opar);
          __mb.addArc(opar, child);
        }
      }
    }

    // we add now some arcs that are between the nodes in __mb but are not part of
    // the last ones.
    // For instance, an arc between a parent and a parent of children
    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));
        }
      }
    }
  }

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 DiGraph::arcs()

Definition at line 44 of file MarkovBlanket_inl.h.

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

Referenced by hasSameStructure().

{ return __mb.arcs(); }

Here is the call graph for this function:

Here is the caller graph for this function:

children()

INLINE const NodeSet & gum::MarkovBlanket::children

(

const NodeId

id

)

const

wrapping DiGraph::parents(id)

Definition at line 38 of file MarkovBlanket_inl.h.

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

                                                                     {
    return __mb.children(id);
  }

Here is the call graph for this function:

hasSameStructure()

bool gum::MarkovBlanket::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 78 of file MarkovBlanket.cpp.

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

                                                            {
    if (size() != other.size()) return false;

    if (sizeArcs() != other.sizeArcs()) return false;

    for (const auto& nid : nodes()) {
      try {
        other.idFromName(__model.variable(nid).name());
      } catch (NotFound) { 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;
  }

Here is the call graph for this function:

mb()

INLINE DiGraph gum::MarkovBlanket::mb

(

)

Returns

a copy of the mixed graph

Definition at line 32 of file MarkovBlanket_inl.h.

References __mb.

{ return __mb; }

nodes()

INLINE const NodeGraphPart & gum::MarkovBlanket::nodes

(

)

const

wrapping DiGraph::nodes()

Definition at line 50 of file MarkovBlanket_inl.h.

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

Referenced by hasSameStructure().

{ return __mb.nodes(); }

Here is the call graph for this function:

Here is the caller graph for this function:

parents()

INLINE const NodeSet & gum::MarkovBlanket::parents

(

const NodeId

id

)

const

wrapping DiGraph::parents(id)

Definition at line 34 of file MarkovBlanket_inl.h.

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

                                                                    {
    return __mb.parents(id);
  }

Here is the call graph for this function:

size()

INLINE Size gum::MarkovBlanket::size

(

)

const

wrapping DiGraph::size()

Definition at line 48 of file MarkovBlanket_inl.h.

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

Referenced by hasSameStructure().

{ return __mb.size(); }

Here is the call graph for this function:

Here is the caller graph for this function:

sizeArcs()

INLINE Size gum::MarkovBlanket::sizeArcs

(

)

const

wrapping DiGraph::sizeArcs()

Definition at line 42 of file MarkovBlanket_inl.h.

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

Referenced by hasSameStructure().

{ return __mb.sizeArcs(); }

Here is the call graph for this function:

Here is the caller graph for this function:

sizeNodes()

INLINE Size gum::MarkovBlanket::sizeNodes

(

)

const

wrapping DiGraph::sizeNodes()

Definition at line 46 of file MarkovBlanket_inl.h.

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

{ return __mb.sizeNodes(); }

Here is the call graph for this function:

toDot()

std::string gum::MarkovBlanket::toDot

(

)

const

Definition at line 99 of file MarkovBlanket.cpp.

References __mb, __model, __node, __specialArcs, gum::ArcGraphPart::children(), gum::Set< Key, Alloc >::exists(), gum::Variable::name(), gum::NodeGraphPart::nodes(), and gum::DAGmodel::variable().

                                       {
    std::stringstream output;
    std::stringstream nodeStream;
    std::stringstream arcStream;
    List< NodeId >    treatedNodes;
    output << "digraph \""
           << "no_name\" {" << std::endl;
    nodeStream << "node [shape = ellipse];" << std::endl;
    std::string tab = "  ";

    for (const auto node : __mb.nodes()) {
      nodeStream << tab << node << "[label=\"" << __model.variable(node).name()
                 << "\"";
      if (node == __node) { nodeStream << ", color=red"; }
      nodeStream << "];" << std::endl;

      for (const auto chi : __mb.children(node)) {
        arcStream << tab << node << " -> " << chi;
        if (__specialArcs.exists(Arc(node, chi))) { arcStream << " [color=grey]"; }
        arcStream << ";" << std::endl;
      }
    }

    output << nodeStream.str() << std::endl
           << arcStream.str() << std::endl
           << "}" << std::endl;

    return output.str();
  }

Here is the call graph for this function:

Member Data Documentation

__mb

DiGraph gum::MarkovBlanket::__mb

private

Definition at line 92 of file MarkovBlanket.h.

Referenced by __buildMarkovBlanket(), arcs(), children(), mb(), nodes(), parents(), size(), sizeArcs(), sizeNodes(), and toDot().

__model

const DAGmodel& gum::MarkovBlanket::__model

private

Definition at line 91 of file MarkovBlanket.h.

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

__node

const NodeId gum::MarkovBlanket::__node

private

Definition at line 93 of file MarkovBlanket.h.

Referenced by __buildMarkovBlanket(), and toDot().

__specialArcs

ArcSet gum::MarkovBlanket::__specialArcs

private

Definition at line 94 of file MarkovBlanket.h.

Referenced by __buildMarkovBlanket(), and 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