gum::prm::StructuredBayesBall< GUM_SCALAR > Class Template Reference

<agrum/PRM/structuredBayesBall.h> More...

#include <structuredBayesBall.h>

Collaboration diagram for gum::prm::StructuredBayesBall< GUM_SCALAR >:

Public Member Functions
void	compute (const PRMInstance< GUM_SCALAR > *i, NodeId n)
	Compute the set or requisite nodes for each required instance given the current set of observations. Discard previous computations. More...
void	compute (const PRMInstance< GUM_SCALAR > &i, NodeId n)
	Compute the set or requisite nodes for each required instance given the current set of observations. Discard previous computations. More...
bool	__isHardEvidence (const PRMInstance< GUM_SCALAR > *i, NodeId n)
	Returns true if there is a hard evidence on i->get(n). More...
Constructors & destructor.
	StructuredBayesBall (const PRMInference< GUM_SCALAR > &inference)
	Default Constructor. More...
	~StructuredBayesBall ()
	Destructor. More...
Getters and Setters.
const std::string &	key (const PRMInstance< GUM_SCALAR > *i) const
	Returns a unique key w.r.t. d-separation for i. More...
const std::string &	key (const PRMInstance< GUM_SCALAR > &i) const
	Returns a unique key w.r.t. d-separation for i. More...
const Set< NodeId > &	requisiteNodes (const PRMInstance< GUM_SCALAR > *i) const
	Returns the set of requisite nodes w.r.t. d-separation for i. More...
const Set< NodeId > &	requisiteNodes (const PRMInstance< GUM_SCALAR > &i) const
	Returns the set of requisite nodes w.r.t. d-separation for i. More...
Size	occurrence (const std::string &key) const
	Returns the number of occurrence of the given key, which is the number of PRMInstance<GUM_SCALAR> sharing the same set of requisite nodes. More...
float	liftRatio () const
	Returns the ratio between the total number of instances and the number of instances with the same configuration. More...
bool	exists (const PRMInstance< GUM_SCALAR > *i) const
	Returns true if i has requisite nodes. More...
bool	exists (const PRMInstance< GUM_SCALAR > &i) const
	Returns true if i has requisite nodes. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::StructuredBayesBall< GUM_SCALAR >

<agrum/PRM/structuredBayesBall.h>

This class represent the BayesBall algorithm applied on PRMs.

Definition at line 48 of file structuredBayesBall.h.

Member Typedef Documentation

InstanceMap

template<typename GUM_SCALAR>

typedef HashTable< const PRMInstance< GUM_SCALAR >*, MarkMap* > gum::prm::StructuredBayesBall< GUM_SCALAR >::InstanceMap

private

Code alias.

Definition at line 120 of file structuredBayesBall.h.

MarkMap

template<typename GUM_SCALAR>

typedef HashTable< NodeId, std::pair< bool, bool > > gum::prm::StructuredBayesBall< GUM_SCALAR >::MarkMap

private

Code alias.

Definition at line 118 of file structuredBayesBall.h.

Constructor & Destructor Documentation

StructuredBayesBall() [1/2]

template<typename GUM_SCALAR >

INLINE gum::prm::StructuredBayesBall< GUM_SCALAR >::StructuredBayesBall

(

const PRMInference< GUM_SCALAR > &

inference

)

Default Constructor.

Definition at line 257 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__inf, GUM_ERROR, and gum::prm::StructuredBayesBall< GUM_SCALAR >::operator=().

                                                    :
        __inf(&inference) {
      GUM_CONSTRUCTOR(StructuredBayesBall);
    }

Here is the call graph for this function:

~StructuredBayesBall()

template<typename GUM_SCALAR >

gum::prm::StructuredBayesBall< GUM_SCALAR >::~StructuredBayesBall

(

)

Destructor.

Definition at line 33 of file structuredBayesBall_tpl.h.

                                                            {
      GUM_DESTRUCTOR(StructuredBayesBall);

      for (const auto& elt : __reqMap)
        delete elt.second.first;
    }

StructuredBayesBall() [2/2]

template<typename GUM_SCALAR>

gum::prm::StructuredBayesBall< GUM_SCALAR >::StructuredBayesBall ( const StructuredBayesBall< GUM_SCALAR > &  source )

private

Copy constructor.

Member Function Documentation

__buildHashKey()

template<typename GUM_SCALAR >

std::string gum::prm::StructuredBayesBall< GUM_SCALAR >::__buildHashKey ( const PRMInstance< GUM_SCALAR > *  i, Set< NodeId > &  req_nodes  )

private

Builds the HashKey for the given instance and requisite nodes set.

Definition at line 245 of file structuredBayesBall_tpl.h.

References gum::Set< Key, Alloc >::exists(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                                     {
      std::stringstream sBuff;
      sBuff << i->type().name();

      for (const auto node : i->type().containerDag().nodes())
        if (req_nodes.exists(node)) sBuff << "-" << node;

      return sBuff.str();
    }

Here is the call graph for this function:

__clean()

template<typename GUM_SCALAR >

void gum::prm::StructuredBayesBall< GUM_SCALAR >::__clean ( )

private

Cleans this before a new computation.

Definition at line 41 of file structuredBayesBall_tpl.h.

                                                    {
      for (const auto& elt : __reqMap)
        delete elt.second.first;

      __keyMap.clear();
      __reqMap.clear();
    }

__compute()

template<typename GUM_SCALAR >

void gum::prm::StructuredBayesBall< GUM_SCALAR >::__compute ( const PRMInstance< GUM_SCALAR > *  i, NodeId  n  )

private

The real compute method.

Definition at line 76 of file structuredBayesBall_tpl.h.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::compute().

                                                     {
      __clean();
      StructuredBayesBall< GUM_SCALAR >::InstanceMap marks;
      __fromChild(i, n, marks);
      __fillMaps(marks);

      for (const auto& elt : marks)
        delete elt.second;
    }

Here is the caller graph for this function:

__fillMaps()

template<typename GUM_SCALAR >

void gum::prm::StructuredBayesBall< GUM_SCALAR >::__fillMaps ( InstanceMap &  marks )

private

Fill __keyMap and __reqMap.

Definition at line 201 of file structuredBayesBall_tpl.h.

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

                                                                         {
      // First find for each instance it's requisite nodes
      HashTable< const PRMInstance< GUM_SCALAR >*, Set< NodeId >* > req_map;

      for (const auto& elt : marks) {
        Set< NodeId >* req_set = new Set< NodeId >();

        for (const auto& elt2 : *elt.second)
          if (elt2.second.first) req_set->insert(elt2.first);

        req_map.insert(elt.first, req_set);
      }

      // Remove all instances with 0 requisite nodes
      Set< const PRMInstance< GUM_SCALAR >* > to_remove;

      for (const auto& elt : req_map)
        if (elt.second->size() == 0) to_remove.insert(elt.first);

      for (const auto remo : to_remove) {
        delete req_map[remo];
        req_map.erase(remo);
      }

      // Fill __reqMap and __keyMap
      for (const auto& elt : req_map) {
        std::string key = __buildHashKey(elt.first, *elt.second);

        if (__reqMap.exists(key)) {
          __keyMap.insert(
             elt.first,
             std::pair< std::string, Set< NodeId >* >(key, __reqMap[key].first));
          __reqMap[key].second += 1;
          delete elt.second;
          req_map[elt.first] = 0;
        } else {
          __reqMap.insert(key, std::pair< Set< NodeId >*, Size >(elt.second, 1));
          __keyMap.insert(
             elt.first, std::pair< std::string, Set< NodeId >* >(key, elt.second));
        }
      }
    }

Here is the call graph for this function:

__fromChild()

template<typename GUM_SCALAR >

void gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromChild ( const PRMInstance< GUM_SCALAR > *  i, NodeId  n, InstanceMap &  marks  )

private

When the ball is received on i->get(n) from a child.

Definition at line 90 of file structuredBayesBall_tpl.h.

References gum::HashTable< Key, Val, Alloc >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr(), GUM_ERROR, gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                                         {
      if (!marks.exists(i)) {
        marks.insert(i, new StructuredBayesBall< GUM_SCALAR >::MarkMap());
      }

      if (!marks[i]->exists(n)) {
        marks[i]->insert(n, std::pair< bool, bool >(false, false));
      }

      // Sending message to parents
      switch (i->type().get(n).elt_type()) {
        case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
          if (!__getMark(marks, i, n).first) {
            __getMark(marks, i, n).first = true;

            for (const auto inst : i->getInstances(n))
              __fromChild(
                 inst, inst->get(__getSC(i, n).lastElt().safeName()).id(), marks);
          }

          if (!__getMark(marks, i, n).second) {
            __getMark(marks, i, n).second = true;

            for (const auto chi : i->type().containerDag().children(n))
              __fromParent(i, chi, marks);
          }

          break;
        }

        case PRMClassElement< GUM_SCALAR >::prm_aggregate:
        case PRMClassElement< GUM_SCALAR >::prm_attribute: {
          if (!__getMark(marks, i, n).first) {
            __getMark(marks, i, n).first = true;

            if (!__isHardEvidence(i, n))
              for (const auto par : i->type().containerDag().parents(n))
                __fromChild(i, par, marks);
          }

          if (!__getMark(marks, i, n).second) {
            __getMark(marks, i, n).second = true;

            // In i.
            for (const auto chi : i->type().containerDag().children(n))
              __fromParent(i, chi, marks);

            // Out of i.
            try {
              const auto& refs = i->getRefAttr(n);

              for (auto iter = refs.begin(); iter != refs.end(); ++iter)
                __fromParent(
                   iter->first, iter->first->type().get(iter->second).id(), marks);
            } catch (NotFound&) {
              // Not an inverse sc
            }
          }

          break;
        }

        default: {
          // We shouldn't reach any other PRMClassElement<GUM_DATA> than
          // PRMAttribute
          // or
          // PRMSlotChain<GUM_SCALAR>.
          GUM_ERROR(FatalError, "This case is impossible.");
        }
      }
    }

Here is the call graph for this function:

__fromParent()

template<typename GUM_SCALAR >

void gum::prm::StructuredBayesBall< GUM_SCALAR >::__fromParent ( const PRMInstance< GUM_SCALAR > *  i, NodeId  n, InstanceMap &  marks  )

private

When the ball is receive on i->get(n) from a parent.

Definition at line 164 of file structuredBayesBall_tpl.h.

References gum::HashTable< Key, Val, Alloc >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr(), gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                                         {
      if (!marks.exists(i)) {
        marks.insert(i, new StructuredBayesBall< GUM_SCALAR >::MarkMap());
      }

      if (!marks[i]->exists(n)) {
        marks[i]->insert(n, std::pair< bool, bool >(false, false));
      }

      // Concerns only PRMAttribute (because of the hard evidence)
      if ((__isHardEvidence(i, n)) && (!__getMark(marks, i, n).first)) {
        __getMark(marks, i, n).first = true;

        for (const auto par : i->type().containerDag().parents(n))
          __fromChild(i, par, marks);
      } else if (!__getMark(marks, i, n).second) {
        __getMark(marks, i, n).second = true;

        // In i.
        for (const auto chi : i->type().containerDag().children(n))
          __fromParent(i, chi, marks);

        // Out of i.
        try {
          for (auto iter = i->getRefAttr(n).begin();
               iter != i->getRefAttr(n).end();
               ++iter)
            __fromParent(
               iter->first, iter->first->type().get(iter->second).id(), marks);
        } catch (NotFound&) {
          // Not an inverse sc
        }
      }
    }

Here is the call graph for this function:

__getMark()

template<typename GUM_SCALAR >

INLINE std::pair< bool, bool > & gum::prm::StructuredBayesBall< GUM_SCALAR >::__getMark ( InstanceMap &  marks, const PRMInstance< GUM_SCALAR > *  i, NodeId  n  )

private

Code alias.

Definition at line 344 of file structuredBayesBall_tpl.h.

                                                                         {
      return (*(marks[i]))[n];
    }

__getSC()

template<typename GUM_SCALAR >

INLINE const PRMSlotChain< GUM_SCALAR > & gum::prm::StructuredBayesBall< GUM_SCALAR >::__getSC ( const PRMInstance< GUM_SCALAR > *  i, NodeId  n  )

private

Code alias.

Definition at line 338 of file structuredBayesBall_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                        {
      return static_cast< const PRMSlotChain< GUM_SCALAR >& >(i->type().get(n));
    }

Here is the call graph for this function:

__isHardEvidence()

template<typename GUM_SCALAR >

bool gum::prm::StructuredBayesBall< GUM_SCALAR >::__isHardEvidence	(	const PRMInstance< GUM_SCALAR > *	i,
		NodeId	n
	)

Returns true if there is a hard evidence on i->get(n).

Definition at line 50 of file structuredBayesBall_tpl.h.

References gum::Instantiation::end(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::MultiDimDecorator< GUM_SCALAR >::get(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

                                                     {
      try {
        typename PRMInference< GUM_SCALAR >::Chain chain =
           std::make_pair(i, &(i->get(n)));

        if (__inf->hasEvidence(chain)) {
          const Potential< GUM_SCALAR >* e = __inf->evidence(i)[n];
          Instantiation                  inst(e);
          Size                           count = 0;

          for (inst.setFirst(); !inst.end(); inst.inc()) {
            if ((e->get(inst) == (GUM_SCALAR)1.0))
              ++count;
            else if (e->get(inst) != (GUM_SCALAR)0.0)
              return false;
          }

          return (count == 1);
        }

        return false;
      } catch (NotFound&) { return false; }
    }

Here is the call graph for this function:

compute() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::StructuredBayesBall< GUM_SCALAR >::compute	(	const PRMInstance< GUM_SCALAR > *	i,
		NodeId	n
	)

Compute the set or requisite nodes for each required instance given the current set of observations. Discard previous computations.

Definition at line 325 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__compute().

                                                     {
      __compute(i, n);
    }

Here is the call graph for this function:

compute() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::StructuredBayesBall< GUM_SCALAR >::compute	(	const PRMInstance< GUM_SCALAR > &	i,
		NodeId	n
	)

Compute the set or requisite nodes for each required instance given the current set of observations. Discard previous computations.

Definition at line 331 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__compute().

                                                     {
      __compute(&i, n);
    }

Here is the call graph for this function:

exists() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::StructuredBayesBall< GUM_SCALAR >::exists

(

const PRMInstance< GUM_SCALAR > *

i

)

const

Returns true if i has requisite nodes.

Definition at line 313 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

                                                 {
      return __keyMap.exists(i);
    }

exists() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::prm::StructuredBayesBall< GUM_SCALAR >::exists

(

const PRMInstance< GUM_SCALAR > &

i

)

const

Returns true if i has requisite nodes.

Definition at line 319 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

                                                 {
      return __keyMap.exists(&i);
    }

key() [1/2]

template<typename GUM_SCALAR >

INLINE const std::string & gum::prm::StructuredBayesBall< GUM_SCALAR >::key

(

const PRMInstance< GUM_SCALAR > *

i

)

const

Returns a unique key w.r.t. d-separation for i.

Definition at line 278 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::occurrence().

                                                 {
      return __keyMap[i].first;
    }

Here is the caller graph for this function:

key() [2/2]

template<typename GUM_SCALAR >

INLINE const std::string & gum::prm::StructuredBayesBall< GUM_SCALAR >::key

(

const PRMInstance< GUM_SCALAR > &

i

)

const

Returns a unique key w.r.t. d-separation for i.

Definition at line 284 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

                                                 {
      return __keyMap[&i].first;
    }

liftRatio()

template<typename GUM_SCALAR >

INLINE float gum::prm::StructuredBayesBall< GUM_SCALAR >::liftRatio

(

)

const

Returns the ratio between the total number of instances and the number of instances with the same configuration.

Definition at line 308 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap, and gum::prm::StructuredBayesBall< GUM_SCALAR >::__reqMap.

                                                                    {
      return ((float)__reqMap.size()) / ((float)__keyMap.size());
    }

occurrence()

template<typename GUM_SCALAR >

INLINE Size gum::prm::StructuredBayesBall< GUM_SCALAR >::occurrence

(

const std::string &

key

)

const

Returns the number of occurrence of the given key, which is the number of PRMInstance<GUM_SCALAR> sharing the same set of requisite nodes.

Definition at line 302 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__reqMap, and gum::prm::StructuredBayesBall< GUM_SCALAR >::key().

                                   {
      return __reqMap[key].second;
    }

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR>

INLINE StructuredBayesBall< GUM_SCALAR > & gum::prm::StructuredBayesBall< GUM_SCALAR >::operator= ( const StructuredBayesBall< GUM_SCALAR > &  source )

private

Copy operator.

Definition at line 273 of file structuredBayesBall_tpl.h.

References GUM_ERROR.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::StructuredBayesBall().

                                                                                                         {
      GUM_ERROR(FatalError, "Not allowed.");
    }

Here is the caller graph for this function:

requisiteNodes() [1/2]

template<typename GUM_SCALAR >

INLINE const Set< NodeId > & gum::prm::StructuredBayesBall< GUM_SCALAR >::requisiteNodes

(

const PRMInstance< GUM_SCALAR > *

i

)

const

Returns the set of requisite nodes w.r.t. d-separation for i.

Definition at line 290 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

                                                 {
      return *(__keyMap[i].second);
    }

requisiteNodes() [2/2]

template<typename GUM_SCALAR >

INLINE const Set< NodeId > & gum::prm::StructuredBayesBall< GUM_SCALAR >::requisiteNodes

(

const PRMInstance< GUM_SCALAR > &

i

)

const

Returns the set of requisite nodes w.r.t. d-separation for i.

Definition at line 296 of file structuredBayesBall_tpl.h.

References gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap.

                                                 {
      return *(__keyMap[&i].second);
    }

Member Data Documentation

__inf

template<typename GUM_SCALAR>

const PRMInference< GUM_SCALAR >* gum::prm::StructuredBayesBall< GUM_SCALAR >::__inf

private

The PRM at which __model belongs.

Definition at line 153 of file structuredBayesBall.h.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::StructuredBayesBall().

__keyMap

template<typename GUM_SCALAR>

HashTable< const PRMInstance< GUM_SCALAR >*, std::pair< std::string, Set< NodeId >* > > gum::prm::StructuredBayesBall< GUM_SCALAR >::__keyMap

private

Associate an PRMInstance<GUM_SCALAR> with a unique key w.r.t. d-separation and the set of requisite nodes deduced from d-separation analysis.

Definition at line 161 of file structuredBayesBall.h.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::exists(), gum::prm::StructuredBayesBall< GUM_SCALAR >::key(), gum::prm::StructuredBayesBall< GUM_SCALAR >::liftRatio(), and gum::prm::StructuredBayesBall< GUM_SCALAR >::requisiteNodes().

__reqMap

template<typename GUM_SCALAR>

HashTable< std::string, std::pair< Set< NodeId >*, Size > > gum::prm::StructuredBayesBall< GUM_SCALAR >::__reqMap

private

Associate a Key with the set of requisite nodes associated with it. The Size value is the number of instance with the same key.

Definition at line 165 of file structuredBayesBall.h.

Referenced by gum::prm::StructuredBayesBall< GUM_SCALAR >::liftRatio(), and gum::prm::StructuredBayesBall< GUM_SCALAR >::occurrence().

---

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

• agrum/PRM/inference/structuredBayesBall.h
• agrum/PRM/inference/structuredBayesBall_tpl.h