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, const std::string &name, int level=1)
	~MarkovBlanket ()
DAG	dag ()
std::string	toDot () const
const NodeSet &	parents (NodeId id) const
	wrapping DAG::parents(id) More...
const NodeSet &	children (NodeId id) const
	wrapping DAG::children(id) More...
NodeSet	parents (const NodeSet &ids) const
	wrapping DAG::parents(ids) More...
NodeSet	children (const NodeSet &ids) const
	wrapping DAG::children(ids) More...
Size	sizeArcs () const
	wrapping DAG::sizeArcs() More...
const ArcSet &	arcs () const
	wrapping DAG::arcs() More...
Size	sizeNodes () const
	wrapping DAG::sizeNodes() More...
Size	size () const
	wrapping DAG::size() More...
const NodeGraphPart &	nodes () const
	wrapping DAG::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 48 of file MarkovBlanket.h.

Constructor & Destructor Documentation

MarkovBlanket() [1/2]

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

Definition at line 36 of file MarkovBlanket.cpp.

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

                                                                      :
      model__(m), node__(id) {
    if (level < 1)
      GUM_ERROR(InvalidArgument, "Argument level(=" << level << ") must be >0.")

    NodeSet done;
    buildMarkovBlanket__(node__);
    done.insert(node__);

    while (level > 1) {
      level--;
      auto todo        = mb__.nodes().asNodeSet() - done;
      bool anythingnew = false;
      for (NodeId n: todo) {
        done.insert(n);
        if (buildMarkovBlanket__(n)) anythingnew = true;
      }
      if (!anythingnew) break;
    }

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

MarkovBlanket() [2/2]

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

Definition at line 69 of file MarkovBlanket.cpp.

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

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

Here is the call graph for this function:

~MarkovBlanket()

gum::MarkovBlanket::~MarkovBlanket

(

)

Definition at line 74 of file MarkovBlanket.cpp.

{}

Member Function Documentation

arcs()

INLINE const ArcSet & gum::MarkovBlanket::arcs

(

)

const

wrapping DAG::arcs()

Definition at line 54 of file MarkovBlanket_inl.h.

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

{ return mb__.arcs(); }

Here is the call graph for this function:

buildMarkovBlanket__()

bool gum::MarkovBlanket::buildMarkovBlanket__ ( const NodeId  id )

private

Definition at line 76 of file MarkovBlanket.cpp.

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

                                                            {
    bool change = false;
    if (!model__.nodes().exists(node))
      GUM_ERROR(InvalidArgument, "Node " << node << " does not exist.");

    if (!mb__.nodes().exists(node)) {
      mb__.addNodeWithId(node);
      change = true;
    }

    for (const auto& parent: model__.parents(node)) {
      if (!mb__.nodes().exists(parent)) {
        mb__.addNodeWithId(parent);
        change = true;
      }
      mb__.addArc(parent, node);
    }

    for (const auto& child: model__.children(node)) {
      if (!mb__.nodes().exists(child)) {
        mb__.addNodeWithId(child);
        change = true;
      }
      mb__.addArc(node, child);
      for (const auto& opar: model__.parents(child)) {
        if (opar != node) {
          if (!mb__.nodes().exists(opar)) {
            mb__.addNodeWithId(opar);
            change = true;
          }
          mb__.addArc(opar, child);
        }
      }
    }

    return change;
  }

Here is the call graph for this function:

children() [1/2]

INLINE const NodeSet & gum::MarkovBlanket::children

(

NodeId

id

)

const

wrapping DAG::children(id)

Definition at line 40 of file MarkovBlanket_inl.h.

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

                                                               {
    return mb__.children(id);
  }

Here is the call graph for this function:

children() [2/2]

INLINE NodeSet gum::MarkovBlanket::children

(

const NodeSet &

ids

)

const

wrapping DAG::children(ids)

Definition at line 48 of file MarkovBlanket_inl.h.

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

                                                                 {
    return mb__.children(ids);
  }

Here is the call graph for this function:

dag()

INLINE DAG gum::MarkovBlanket::dag

(

)

Returns

a copy of the graph

Definition at line 34 of file MarkovBlanket_inl.h.

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

{ return mb__; }

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 114 of file MarkovBlanket.cpp.

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

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

nodes()

INLINE const NodeGraphPart & gum::MarkovBlanket::nodes

(

)

const

wrapping DAG::nodes()

Definition at line 60 of file MarkovBlanket_inl.h.

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

{ return mb__.nodes(); }

Here is the call graph for this function:

parents() [1/2]

INLINE const NodeSet & gum::MarkovBlanket::parents

(

NodeId

id

)

const

wrapping DAG::parents(id)

Definition at line 36 of file MarkovBlanket_inl.h.

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

                                                              {
    return mb__.parents(id);
  }

Here is the call graph for this function:

parents() [2/2]

INLINE NodeSet gum::MarkovBlanket::parents

(

const NodeSet &

ids

)

const

wrapping DAG::parents(ids)

Definition at line 44 of file MarkovBlanket_inl.h.

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

                                                                {
    return mb__.parents(ids);
  }

Here is the call graph for this function:

size()

INLINE Size gum::MarkovBlanket::size

(

)

const

wrapping DAG::size()

Definition at line 58 of file MarkovBlanket_inl.h.

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

{ return mb__.size(); }

Here is the call graph for this function:

sizeArcs()

INLINE Size gum::MarkovBlanket::sizeArcs

(

)

const

wrapping DAG::sizeArcs()

Definition at line 52 of file MarkovBlanket_inl.h.

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

{ return mb__.sizeArcs(); }

Here is the call graph for this function:

sizeNodes()

INLINE Size gum::MarkovBlanket::sizeNodes

(

)

const

wrapping DAG::sizeNodes()

Definition at line 56 of file MarkovBlanket_inl.h.

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

{ return mb__.sizeNodes(); }

Here is the call graph for this function:

toDot()

std::string gum::MarkovBlanket::toDot

(

)

const

Definition at line 135 of file MarkovBlanket.cpp.

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

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

DAG gum::MarkovBlanket::mb__

private

Definition at line 99 of file MarkovBlanket.h.

model__

const DAGmodel& gum::MarkovBlanket::model__

private

Definition at line 98 of file MarkovBlanket.h.

node__

const NodeId gum::MarkovBlanket::node__

private

Definition at line 100 of file MarkovBlanket.h.

specialArcs__

ArcSet gum::MarkovBlanket::specialArcs__

private

Definition at line 101 of file MarkovBlanket.h.

---

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