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

This class is an implementation of the Structured Value Elimination algorithm on PRM<GUM_SCALAR>. More...

#include <agrum/PRM/SVED.h>

Inheritance diagram for gum::prm::SVED< GUM_SCALAR >:

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

Public Member Functions
Constructors & destructor.
	SVED (const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &model)
	Default Constructor. More...
	~SVED ()
	Destructor. More...
Getters & setters.
virtual std::string	name () const
	Returns the name of the current inference algorithm. More...
Query methods.
void	posterior (const Chain &chain, Potential< GUM_SCALAR > &m)
	Compute the posterior of the formal attribute pointed by chain and stores it in m. More...
void	joint (const std::vector< Chain > &chains, Potential< GUM_SCALAR > &j)
	Compute the joint probability of the formals attributes pointed by chains and stores it in m. More...
Evidence handling.
EMap &	evidence (const PRMInstance< GUM_SCALAR > &i)
	Returns EMap of evidences over i. More...
EMap &	evidence (const PRMInstance< GUM_SCALAR > *i)
	Returns EMap of evidences over i. More...
const EMap &	evidence (const PRMInstance< GUM_SCALAR > &i) const
	Returns EMap of evidences over i. More...
const EMap &	evidence (const PRMInstance< GUM_SCALAR > *i) const
	Returns EMap of evidences over i. More...
bool	hasEvidence (const PRMInstance< GUM_SCALAR > &i) const
	Returns true if i has evidence. More...
bool	hasEvidence (const PRMInstance< GUM_SCALAR > *i) const
	Returns EMap of evidences over i. More...
bool	hasEvidence (const Chain &chain) const
	Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a. More...
bool	hasEvidence () const
	Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a. More...
void	addEvidence (const Chain &chain, const Potential< GUM_SCALAR > &p)
	Add an evidence to the given instance's elt. More...
void	removeEvidence (const Chain &chain)
	Remove evidence on the given instance's elt. More...
void	clearEvidence ()
	Remove all evidences. More...

Public Types
typedef NodeProperty< const Potential< GUM_SCALAR > *>	EMap
	Code alias. More...
typedef NodeProperty< const Potential< GUM_SCALAR > *>::iterator_safe	EMapIterator
	Code alias. More...
typedef NodeProperty< const Potential< GUM_SCALAR > *>::const_iterator_safe	EMapConstIterator
	Code alias. More...

Protected Attributes
Protected members.
PRM< GUM_SCALAR > const *	prm_
	The PRM<GUM_SCALAR> on which inference is done. More...
PRMSystem< GUM_SCALAR > const *	sys_
	The Model on which inference is done. More...

Query methods.
typedef PRMInference< GUM_SCALAR >::Chain	Chain
	Code alias. More...
virtual void	evidenceAdded_ (const Chain &chain)
	See PRMInference::evidenceAdded_(). More...
virtual void	evidenceRemoved_ (const Chain &chain)
	See PRMInference::evidenceRemoved_(). More...
virtual void	posterior_ (const Chain &chain, Potential< GUM_SCALAR > &m)
	See PRMInference::posterior_(). More...
virtual void	joint_ (const std::vector< Chain > &queries, Potential< GUM_SCALAR > &j)
	See PRMInference::joint_(). More...

Detailed Description

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

This class is an implementation of the Structured Value Elimination algorithm on PRM<GUM_SCALAR>.

Definition at line 62 of file SVED.h.

Member Typedef Documentation

ArraySetIterator

template<typename GUM_SCALAR >

typedef Set< MultiDimArray< GUM_SCALAR >* >::iterator_safe gum::prm::SVED< GUM_SCALAR >::ArraySetIterator

private

Code alias.

Definition at line 117 of file SVED.h.

BucketSet

template<typename GUM_SCALAR >

typedef Set< Potential< GUM_SCALAR >* > gum::prm::SVED< GUM_SCALAR >::BucketSet

private

Code alias.

Definition at line 110 of file SVED.h.

BucketSetIterator

template<typename GUM_SCALAR >

typedef Set< Potential< GUM_SCALAR >* >::iterator_safe gum::prm::SVED< GUM_SCALAR >::BucketSetIterator

private

Code alias.

Definition at line 113 of file SVED.h.

Chain

template<typename GUM_SCALAR >

typedef PRMInference< GUM_SCALAR >::Chain gum::prm::SVED< GUM_SCALAR >::Chain

protected

Code alias.

Definition at line 92 of file SVED.h.

EMap

template<typename GUM_SCALAR>

typedef NodeProperty< const Potential< GUM_SCALAR >* > gum::prm::PRMInference< GUM_SCALAR >::EMap

inherited

Code alias.

Definition at line 59 of file PRMInference.h.

EMapConstIterator

template<typename GUM_SCALAR>

typedef NodeProperty< const Potential< GUM_SCALAR >* >::const_iterator_safe gum::prm::PRMInference< GUM_SCALAR >::EMapConstIterator

inherited

Code alias.

Definition at line 68 of file PRMInference.h.

EMapIterator

template<typename GUM_SCALAR>

typedef NodeProperty< const Potential< GUM_SCALAR >* >::iterator_safe gum::prm::PRMInference< GUM_SCALAR >::EMapIterator

inherited

Code alias.

Definition at line 64 of file PRMInference.h.

Constructor & Destructor Documentation

SVED()

template<typename GUM_SCALAR >

INLINE gum::prm::SVED< GUM_SCALAR >::SVED	(	const PRM< GUM_SCALAR > &	prm,
		const PRMSystem< GUM_SCALAR > &	model
	)

Default Constructor.

Definition at line 525 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                          :
        PRMInference< GUM_SCALAR >(prm, model),
        class_elim_order__(0), bb__(*this) {
      GUM_CONSTRUCTOR(SVED);
    }

Here is the call graph for this function:

~SVED()

template<typename GUM_SCALAR >

gum::prm::SVED< GUM_SCALAR >::~SVED

(

)

Destructor.

Definition at line 34 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                              {
      GUM_DESTRUCTOR(SVED);

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

      if (class_elim_order__ != nullptr) delete class_elim_order__;
    }

Here is the call graph for this function:

Member Function Documentation

addEvidence()

template<typename GUM_SCALAR>

void gum::prm::PRMInference< GUM_SCALAR >::addEvidence ( const Chain &  chain, const Potential< GUM_SCALAR > &  p  )

inherited

Add an evidence to the given instance's elt.

Parameters

chain	The variable being observed.
p	The Potential added (by copy) as evidence.

Exceptions

NotFound	Raised if elt does not belong to i.
OperationNotAllowed	Raised if p is inconsistent with elt.

Definition at line 108 of file PRMInference_tpl.h.

                                                                                 {
      if (chain.first->exists(chain.second->id())) {
        if ((p.nbrDim() != 1) || (!p.contains(chain.second->type().variable())))
          GUM_ERROR(OperationNotAllowed,
                    "illegal evidence for the given PRMAttribute.");

        Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
        e->add(chain.second->type().variable());
        Instantiation i(*e);

        for (i.setFirst(); !i.end(); i.inc())
          e->set(i, p.get(i));

        PRMInference< GUM_SCALAR >::EMap& emap = EMap__(chain.first);

        if (emap.exists(chain.second->id())) {
          delete emap[chain.second->id()];
          emap[chain.second->id()] = e;
        } else {
          emap.insert(chain.second->id(), e);
        }

        evidenceAdded_(chain);
      } else {
        GUM_ERROR(NotFound,
                  "the given PRMAttribute does not belong to this "
                  "Instance<GUM_SCALAR>.");
      }
    }

checkElimOrder__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::SVED< GUM_SCALAR >::checkElimOrder__ ( const PRMInstance< GUM_SCALAR > *  first, const PRMInstance< GUM_SCALAR > *  second  )

private

Returns true if second can be eliminated before first.

Definition at line 555 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                {
      if (class_elim_order__ == 0) { initElimOrder__(); }

      auto first_name  = trim__(first->type().name());
      auto second_name = trim__(second->type().name());
      return (class_elim_order__->pos(first_name)
              <= class_elim_order__->pos(second_name));
    }

Here is the call graph for this function:

clearEvidence()

template<typename GUM_SCALAR >

void gum::prm::PRMInference< GUM_SCALAR >::clearEvidence ( )

inherited

Remove all evidences.

Definition at line 35 of file PRMInference_tpl.h.

                                                   {
      for (const auto& elt: evidences__) {
        for (const auto& elt2: *elt.second)
          delete elt2.second;

        delete elt.second;
      }

      evidences__.clear();
    }

eliminateNodes__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::eliminateNodes__ ( const PRMInstance< GUM_SCALAR > *  query, NodeId  id, BucketSet &  pool, BucketSet &  trash  )

private

Returns true if second can be eliminated before first.

Definition at line 45 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                              {
      Set< const PRMInstance< GUM_SCALAR >* > ignore;
      ignore.insert(query);
      // Extracting required attributes and slotchains
      Set< NodeId >& attr_set = getAttrSet__(query);
      Set< NodeId >& sc_set   = getSCSet__(query);
      // Downward elimination
      List< const PRMInstance< GUM_SCALAR >* > elim_list;

      for (const auto attr: attr_set) {
        try {
          for (auto iter = query->getRefAttr(attr).begin();
               iter != query->getRefAttr(attr).end();
               ++iter)
            if ((!ignore.exists(iter->first)) && (bb__.exists(iter->first)))
              eliminateNodesDownward__(query,
                                       iter->first,
                                       pool,
                                       trash,
                                       elim_list,
                                       ignore);
        } catch (NotFound&) {
          // Ok
        }
      }

      // Eliminating all nodes in query instance, except query
      InstanceBayesNet< GUM_SCALAR > bn(*query);
      DefaultTriangulation           t(&(bn.moralGraph()), &(bn.modalities()));
      std::vector< const DiscreteVariable* > elim_order;

      if (this->hasEvidence(query)) insertEvidence__(query, pool);

      for (const auto attr: attr_set)
        pool.insert(
           &(const_cast< Potential< GUM_SCALAR >& >(query->get(attr).cpf())));

      for (size_t idx = 0; idx < t.eliminationOrder().size(); ++idx) {
        if (t.eliminationOrder()[idx] != node) {
          auto        var_id = t.eliminationOrder()[idx];
          const auto& var    = bn.variable(var_id);
          elim_order.push_back(&var);
        }
      }

      eliminateNodes(elim_order, pool, trash);
      // Eliminating instance in elim_list
      List< const PRMInstance< GUM_SCALAR >* > tmp_list;
      reduceElimList__(query, elim_list, tmp_list, ignore, pool, trash);

      while (!elim_list.empty()) {
        if (checkElimOrder__(query, elim_list.front())) {
          if ((!ignore.exists(elim_list.front()))
              && (bb__.exists(elim_list.front())))
            eliminateNodesDownward__(query,
                                     elim_list.front(),
                                     pool,
                                     trash,
                                     elim_list,
                                     ignore);
        } else if (bb__.exists(elim_list.front())) {
          tmp_list.insert(elim_list.front());
        }

        elim_list.popFront();
      }

      // Upward elimination
      for (const auto chain: sc_set)
        for (const auto parent: query->getInstances(chain))
          if ((!ignore.exists(parent)) && (bb__.exists(*parent)))
            eliminateNodesUpward__(parent, pool, trash, tmp_list, ignore);
    }

Here is the call graph for this function:

eliminateNodesDownward__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::eliminateNodesDownward__ ( const PRMInstance< GUM_SCALAR > *  from, const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash, List< const PRMInstance< GUM_SCALAR > * > &  elim_list, Set< const PRMInstance< GUM_SCALAR > * > &  ignore  )

private

Returns true if second can be eliminated before first.

Definition at line 123 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                         {
      ignore.insert(i);
      // Extracting required attributes and slotchains
      Set< NodeId >& attr_set = getAttrSet__(i);
      Set< NodeId >& sc_set   = getSCSet__(i);
      // Calling elimination over child instance
      List< const PRMInstance< GUM_SCALAR >* > my_list;

      for (const auto attr: attr_set) {
        try {
          for (auto iter = i->getRefAttr(attr).begin();
               iter != i->getRefAttr(attr).end();
               ++iter)
            if ((!ignore.exists(iter->first)) && (bb__.exists(iter->first)))
              eliminateNodesDownward__(i,
                                       iter->first,
                                       pool,
                                       trash,
                                       my_list,
                                       ignore);
        } catch (NotFound&) {
          // Ok
        }
      }

      // Eliminating all nodes in current instance
      if (this->hasEvidence(i)) {
        eliminateNodesWithEvidence__(i, pool, trash);
      } else {
        insertLiftedNodes__(i, pool, trash);

        for (const auto agg: i->type().aggregates())
          if (bb__.requisiteNodes(i).exists(agg->id()))
            pool.insert(getAggPotential__(i, agg));

        try {
          InstanceBayesNet< GUM_SCALAR >         bn(*i);
          std::vector< const DiscreteVariable* > elim_order;

          for (auto node: getElimOrder__(i->type())) {
            const auto& var = bn.variable(node);
            elim_order.push_back(&var);
          }

          eliminateNodes(elim_order, pool, trash);
        } catch (NotFound&) {
          // Raised if there is no inner nodes to eliminate
        }
      }

      // Calling elimination over child's parents
      while (!my_list.empty()) {
        if (checkElimOrder__(i, my_list.front())) {
          if ((!ignore.exists(my_list.front())) && (bb__.exists(my_list.front())))
            eliminateNodesDownward__(i,
                                     my_list.front(),
                                     pool,
                                     trash,
                                     my_list,
                                     ignore);
        } else if (bb__.exists(my_list.front())) {
          elim_list.insert(my_list.front());
        }

        my_list.popFront();
      }

      // Adding parents instance to elim_list
      for (const auto chain: sc_set)
        for (const auto parent: i->getInstances(chain))
          if ((!ignore.exists(parent)) && bb__.exists(parent) && (parent != from))
            elim_list.insert(parent);
    }

Here is the call graph for this function:

eliminateNodesUpward__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::eliminateNodesUpward__ ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash, List< const PRMInstance< GUM_SCALAR > * > &  elim_list, Set< const PRMInstance< GUM_SCALAR > * > &  ignore  )

private

Returns true if second can be eliminated before first.

Definition at line 204 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                         {
      ignore.insert(i);
      // Extracting required attributes and slotchains
      Set< NodeId >& attr_set = getAttrSet__(i);
      Set< NodeId >& sc_set   = getSCSet__(i);

      // Downward elimination
      for (const auto attr: attr_set) {
        try {
          for (auto iter = i->getRefAttr(attr).begin();
               iter != i->getRefAttr(attr).end();
               ++iter)
            if ((!ignore.exists(iter->first)) && (bb__.exists(iter->first)))
              eliminateNodesDownward__(i,
                                       iter->first,
                                       pool,
                                       trash,
                                       elim_list,
                                       ignore);
        } catch (NotFound&) {
          // Ok
        }
      }

      // Eliminating all nodes in i instance
      if (this->hasEvidence(i)) {
        eliminateNodesWithEvidence__(i, pool, trash);
      } else {
        insertLiftedNodes__(i, pool, trash);

        for (const auto agg: i->type().aggregates())
          if (bb__.requisiteNodes(i).exists(agg->id()))
            pool.insert(getAggPotential__(i, agg));

        try {
          InstanceBayesNet< GUM_SCALAR >         bn(*i);
          std::vector< const DiscreteVariable* > elim_order;

          for (auto node: getElimOrder__(i->type())) {
            const auto& var = bn.variable(node);
            elim_order.push_back(&var);
          }
          eliminateNodes(elim_order, pool, trash);
        } catch (NotFound&) {
          // Raised if there is no inner nodes to eliminate
        }
      }

      // Eliminating instance in elim_list
      List< const PRMInstance< GUM_SCALAR >* > tmp_list;

      while (!elim_list.empty()) {
        if (checkElimOrder__(i, elim_list.front())) {
          if ((!ignore.exists(elim_list.front()))
              && (bb__.exists(elim_list.front())))
            eliminateNodesDownward__(i,
                                     elim_list.front(),
                                     pool,
                                     trash,
                                     elim_list,
                                     ignore);
        } else if (bb__.exists(elim_list.front())) {
          ignore.insert(elim_list.front());
        }

        elim_list.popFront();
      }

      // Upward elimination
      for (const auto chain: sc_set)
        for (const auto parent: i->getInstances(chain))
          if ((!ignore.exists(parent)) && (bb__.exists(parent)))
            eliminateNodesUpward__(parent, pool, trash, tmp_list, ignore);
    }

Here is the call graph for this function:

eliminateNodesWithEvidence__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::eliminateNodesWithEvidence__ ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash  )

private

Returns true if second can be eliminated before first.

Definition at line 285 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                               {
      // Adding required evidences
      for (const auto& elt: this->evidence(i))
        if (bb__.requisiteNodes(i).exists(elt.first))
          pool.insert(const_cast< Potential< GUM_SCALAR >* >(elt.second));

      // Adding potentials and eliminating the remaining nodes
      for (const auto& a: *i)
        if (bb__.requisiteNodes(i).exists(a.first))
          pool.insert(&(const_cast< Potential< GUM_SCALAR >& >(a.second->cpf())));

      InstanceBayesNet< GUM_SCALAR > bn(*i);
      DefaultTriangulation           t(&(bn.moralGraph()), &(bn.modalities()));
      const std::vector< NodeId >&   full_elim_order = t.eliminationOrder();

      for (auto var = full_elim_order.begin(); var != full_elim_order.end(); ++var)
        eliminateNode(&(i->get(*var).type().variable()), pool, trash);
    }

Here is the call graph for this function:

evidence() [1/4]

template<typename GUM_SCALAR>

INLINE PRMInference< GUM_SCALAR >::EMap & gum::prm::PRMInference< GUM_SCALAR >::evidence ( const PRMInstance< GUM_SCALAR > &  i )

inherited

Returns EMap of evidences over i.

Exceptions

NotFound

if i has no evidence.

Definition at line 156 of file PRMInference_tpl.h.

                                                                              {
      try {
        return *(evidences__[&i]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this instance has no evidence.");
      }
    }

evidence() [2/4]

template<typename GUM_SCALAR>

INLINE PRMInference< GUM_SCALAR >::EMap & gum::prm::PRMInference< GUM_SCALAR >::evidence ( const PRMInstance< GUM_SCALAR > *  i )

inherited

Returns EMap of evidences over i.

Exceptions

NotFound

if i has no evidence.

Definition at line 177 of file PRMInference_tpl.h.

                                                                              {
      try {
        return *(evidences__[i]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this instance has no evidence.");
      }
    }

evidence() [3/4]

template<typename GUM_SCALAR>

INLINE const PRMInference< GUM_SCALAR >::EMap & gum::prm::PRMInference< GUM_SCALAR >::evidence ( const PRMInstance< GUM_SCALAR > &  i ) const

inherited

Returns EMap of evidences over i.

Exceptions

NotFound

if i has no evidence.

Definition at line 166 of file PRMInference_tpl.h.

                                                    {
      try {
        return *(evidences__[&i]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this instance has no evidence.");
      }
    }

evidence() [4/4]

template<typename GUM_SCALAR>

INLINE const PRMInference< GUM_SCALAR >::EMap & gum::prm::PRMInference< GUM_SCALAR >::evidence ( const PRMInstance< GUM_SCALAR > *  i ) const

inherited

Returns EMap of evidences over i.

Exceptions

NotFound

if i has no evidence.

Definition at line 187 of file PRMInference_tpl.h.

                                                    {
      try {
        return *(evidences__[i]);
      } catch (NotFound&) {
        GUM_ERROR(NotFound, "this instance has no evidence.");
      }
    }

evidenceAdded_()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVED< GUM_SCALAR >::evidenceAdded_ ( const Chain &  chain )

protectedvirtual

See PRMInference::evidenceAdded_().

Implements gum::prm::PRMInference< GUM_SCALAR >.

Definition at line 575 of file SVED_tpl.h.

                                                      {
      // Do nothing
    }

evidenceRemoved_()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVED< GUM_SCALAR >::evidenceRemoved_ ( const Chain &  chain )

protectedvirtual

See PRMInference::evidenceRemoved_().

Implements gum::prm::PRMInference< GUM_SCALAR >.

Definition at line 581 of file SVED_tpl.h.

                                                      {
      // Do nothing
    }

getAggPotential__()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > * gum::prm::SVED< GUM_SCALAR >::getAggPotential__ ( const PRMInstance< GUM_SCALAR > *  i, const PRMAggregate< GUM_SCALAR > *  agg  )

private

Returns true if second can be eliminated before first.

Definition at line 567 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                              {
      return &(
         const_cast< Potential< GUM_SCALAR >& >(i->get(agg->safeName()).cpf()));
    }

Here is the call graph for this function:

getAttrSet__()

template<typename GUM_SCALAR >

INLINE Set< NodeId > & gum::prm::SVED< GUM_SCALAR >::getAttrSet__ ( const PRMInstance< GUM_SCALAR > *  i )

private

Returns true if second can be eliminated before first.

Definition at line 588 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                              {
      try {
        return *(req_set__[&(bb__.requisiteNodes(i))].first);
      } catch (NotFound&) {
        initReqSets__(i);
        return *(req_set__[&(bb__.requisiteNodes(i))].first);
      }
    }

Here is the call graph for this function:

getElimOrder__()

template<typename GUM_SCALAR >

INLINE std::vector< NodeId > & gum::prm::SVED< GUM_SCALAR >::getElimOrder__ ( const PRMClass< GUM_SCALAR > &  c )

private

Returns true if second can be eliminated before first.

Definition at line 543 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                             {
      return *(elim_orders__[&c]);
    }

Here is the call graph for this function:

getSCSet__()

template<typename GUM_SCALAR >

INLINE Set< NodeId > & gum::prm::SVED< GUM_SCALAR >::getSCSet__ ( const PRMInstance< GUM_SCALAR > *  i )

private

Returns true if second can be eliminated before first.

Definition at line 599 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                            {
      try {
        return *(req_set__[&(bb__.requisiteNodes(i))].second);
      } catch (NotFound&) {
        initReqSets__(i);
        return *(req_set__[&(bb__.requisiteNodes(i))].second);
      }
    }

Here is the call graph for this function:

hasEvidence() [1/4]

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMInference< GUM_SCALAR >::hasEvidence ( const PRMInstance< GUM_SCALAR > &  i ) const

inherited

Returns true if i has evidence.

Definition at line 197 of file PRMInference_tpl.h.

                                                 {
      return evidences__.exists(&i);
    }

hasEvidence() [2/4]

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMInference< GUM_SCALAR >::hasEvidence ( const PRMInstance< GUM_SCALAR > *  i ) const

inherited

Returns EMap of evidences over i.

Definition at line 203 of file PRMInference_tpl.h.

                                                 {
      return evidences__.exists(i);
    }

hasEvidence() [3/4]

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMInference< GUM_SCALAR >::hasEvidence ( const Chain &  chain ) const

inherited

Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.

Definition at line 209 of file PRMInference_tpl.h.

                                                                                {
      return (hasEvidence(chain.first))
              ? evidence(chain.first).exists(chain.second->id())
              : false;
    }

hasEvidence() [4/4]

template<typename GUM_SCALAR>

INLINE bool gum::prm::PRMInference< GUM_SCALAR >::hasEvidence ( ) const

inherited

Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.

Definition at line 216 of file PRMInference_tpl.h.

                                                              {
      return (evidences__.size() != (Size)0);
    }

initElimOrder__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::initElimOrder__ ( )

private

Returns true if second can be eliminated before first.

Definition at line 399 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                             {
      ClassDependencyGraph< GUM_SCALAR >                        cdg(*(this->prm_));
      Sequence< const PRMClassElementContainer< GUM_SCALAR >* > class_elim_order;
      std::list< NodeId >                                       l;

      for (const auto node: cdg.dag().nodes()) {
        if (cdg.dag().parents(node).empty()) { l.push_back(node); }
      }

      Set< NodeId > visited_node;

      while (!l.empty()) {
        visited_node.insert(l.front());

        if (!class_elim_order.exists(cdg.get(l.front()).first)) {
          class_elim_order.insert(cdg.get(l.front()).first);
        }

        for (const auto child: cdg.dag().children(l.front())) {
          if (!visited_node.contains(child)) { l.push_back(child); }
        }

        l.pop_front();
      }

      class_elim_order__ = new Sequence< std::string >();
      for (auto c: class_elim_order) {
        std::string name = c->name();
        auto        pos  = name.find_first_of("<");
        if (pos != std::string::npos) { name = name.substr(0, pos); }
        try {
          class_elim_order__->insert(name);
        } catch (DuplicateElement&) {}
      }
    }

Here is the call graph for this function:

initLiftedNodes__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::initLiftedNodes__ ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  trash  )

private

Returns true if second can be eliminated before first.

Definition at line 329 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                 {
      PRMClass< GUM_SCALAR >& c = const_cast< PRMClass< GUM_SCALAR >& >(i->type());
      BucketSet*              lifted_pool = new BucketSet();
      lifted_pools__.insert(&(bb__.requisiteNodes(i)), lifted_pool);

      for (const auto node: bb__.requisiteNodes(i))
        if (PRMClassElement< GUM_SCALAR >::isAttribute(c.get(node)))
          lifted_pool->insert(
             const_cast< Potential< GUM_SCALAR >* >(&(c.get(node).cpf())));

      NodeSet inners, outers, ignore;

      for (const auto& elt: *i) {
        if (bb__.requisiteNodes(*i).exists(elt.first)) {
          if (PRMClassElement< GUM_SCALAR >::isAttribute(c.get(elt.first))) {
            if (c.isOutputNode(c.get(elt.first)))
              outers.insert(elt.first);
            else if (!outers.exists(elt.first))
              inners.insert(elt.first);
          } else if (PRMClassElement< GUM_SCALAR >::isAggregate(
                        c.get(elt.first))) {
            outers.insert(elt.first);

            // We need to put in the output_elim_order aggregator's parents
            // which are
            // innner nodes
            for (const auto par: c.containerDag().parents(elt.first))
              if (PRMClassElement< GUM_SCALAR >::isAttribute(i->type().get(par))
                  && i->type().isInnerNode(i->type().get(par))
                  && bb__.requisiteNodes(i).exists(par)) {
                inners.erase(par);
                outers.insert(par);
              }
          }
        } else {
          ignore.insert(elt.first);
        }
      }

      // Now we proceed with the elimination of inner attributes
      ClassBayesNet< GUM_SCALAR > bn(c);
      List< NodeSet >             partial_ordering;

      if (inners.size()) partial_ordering.pushBack(inners);

      if (outers.size()) partial_ordering.pushBack(outers);

      if (ignore.size()) partial_ordering.pushBack(ignore);

      GUM_ASSERT(inners.size() || outers.size());
      PartialOrderedTriangulation t(&(bn.moralGraph()),
                                    &(bn.modalities()),
                                    &partial_ordering);

      for (size_t idx = 0; idx < inners.size(); ++idx)
        eliminateNode(&(c.get(t.eliminationOrder()[idx]).type().variable()),
                      *lifted_pool,
                      trash);

      // If there is not only inner and input Attributes
      if (outers.size()) {
        elim_orders__.insert(
           &c,
           new std::vector< NodeId >(t.eliminationOrder().begin() + inners.size(),
                                     t.eliminationOrder().end()));
      }
    }

Here is the call graph for this function:

initReqSets__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::initReqSets__ ( const PRMInstance< GUM_SCALAR > *  i )

private

Returns true if second can be eliminated before first.

Definition at line 494 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                             {
      Set< NodeId >* attr_set = new Set< NodeId >();
      Set< NodeId >* sc_set   = new Set< NodeId >();

      for (const auto node: bb__.requisiteNodes(i)) {
        switch (i->type().get(node).elt_type()) {
          case PRMClassElement< GUM_SCALAR >::prm_aggregate:
          case PRMClassElement< GUM_SCALAR >::prm_attribute: {
            attr_set->insert(node);
            break;
          }

          case PRMClassElement< GUM_SCALAR >::prm_slotchain: {
            sc_set->insert(node);
            break;
          }

          default: {
            GUM_ERROR(FatalError,
                      "There should not be elements other"
                      " than PRMAttribute<GUM_SCALAR> and SlotChain.");
          }
        }
      }

      req_set__.insert(
         &(bb__.requisiteNodes(i)),
         std::pair< Set< NodeId >*, Set< NodeId >* >(attr_set, sc_set));
    }

Here is the call graph for this function:

insertEvidence__()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVED< GUM_SCALAR >::insertEvidence__ ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool  )

private

Returns true if second can be eliminated before first.

Definition at line 535 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                             {
      for (const auto& elt: this->evidence(i))
        pool.insert(const_cast< Potential< GUM_SCALAR >* >(elt.second));
    }

Here is the call graph for this function:

insertLiftedNodes__()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::insertLiftedNodes__ ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash  )

private

Returns true if second can be eliminated before first.

Definition at line 309 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                 {
      BucketSet* lifted_pool = nullptr;

      try {
        lifted_pool = lifted_pools__[&(bb__.requisiteNodes(i))];
      } catch (NotFound&) {
        initLiftedNodes__(i, trash);
        lifted_pool = lifted_pools__[&(bb__.requisiteNodes(i))];
      }

      for (const auto lifted_pot: *lifted_pool) {
        Potential< GUM_SCALAR >* pot = copyPotential(i->bijection(), *lifted_pot);
        pool.insert(pot);
        trash.insert(pot);
      }
    }

Here is the call graph for this function:

joint()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMInference< GUM_SCALAR >::joint ( const std::vector< Chain > &  chains, Potential< GUM_SCALAR > &  j  )

inherited

Compute the joint probability of the formals attributes pointed by chains and stores it in m.

Parameters

chains	A Set of strings of the form instance.attribute.
j	An empty CPF which will be filed by the joint probability over chains.

Exceptions

NotFound	Raised if some chain in chains does not point to a formal attribute.
OperationNotAllowed	Raise if m is not empty.

Definition at line 264 of file PRMInference_tpl.h.

                                                                           {
      if (j.nbrDim() > 0) {
        GUM_ERROR(OperationNotAllowed, "the given Potential is not empty.");
      }

      for (auto chain = chains.begin(); chain != chains.end(); ++chain) {
        j.add(chain->second->type().variable());
      }

      joint_(chains, j);
    }

joint_()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::joint_ ( const std::vector< Chain > &  queries, Potential< GUM_SCALAR > &  j  )

protectedvirtual

See PRMInference::joint_().

Implements gum::prm::PRMInference< GUM_SCALAR >.

Definition at line 488 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

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

Here is the call graph for this function:

name()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::SVED< GUM_SCALAR >::name ( ) const

virtual

Returns the name of the current inference algorithm.

Implements gum::prm::PRMInference< GUM_SCALAR >.

Definition at line 636 of file SVED_tpl.h.

                                                    {
      return "SVED";
    }

posterior()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMInference< GUM_SCALAR >::posterior ( const Chain &  chain, Potential< GUM_SCALAR > &  m  )

inherited

Compute the posterior of the formal attribute pointed by chain and stores it in m.

Parameters

chain	A string of the form instance.attribute.
m	An empty CPF which will be filed by the posterior of chain.

Exceptions

NotFound	Raised if chain is invalid.
TypeError	Raised if chain does not point to an PRMAttribute<GUM_SCALAR>.
OperationNotAllowed	Raise if m is not empty.

Definition at line 234 of file PRMInference_tpl.h.

                                                            {
      if (m.nbrDim() > 0) {
        GUM_ERROR(OperationNotAllowed, "the given Potential is not empty.");
      }

      if (hasEvidence(chain)) {
        m.add(chain.second->type().variable());
        const Potential< GUM_SCALAR >& e
           = *(evidence(chain.first)[chain.second->id()]);
        Instantiation i(m), j(e);

        for (i.setFirst(), j.setFirst(); !i.end(); i.inc(), j.inc())
          m.set(i, e.get(j));
      } else {
        if (chain.second != &(chain.first->get(chain.second->safeName()))) {
          typename PRMInference< GUM_SCALAR >::Chain good_chain
             = std::make_pair(chain.first,
                              &(chain.first->get(chain.second->safeName())));
          m.add(good_chain.second->type().variable());
          posterior_(good_chain, m);
        } else {
          m.add(chain.second->type().variable());
          posterior_(chain, m);
        }
      }
    }

posterior_()

template<typename GUM_SCALAR >

void gum::prm::SVED< GUM_SCALAR >::posterior_ ( const Chain &  chain, Potential< GUM_SCALAR > &  m  )

protectedvirtual

See PRMInference::posterior_().

Implements gum::prm::PRMInference< GUM_SCALAR >.

Definition at line 436 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                    {
      const PRMInstance< GUM_SCALAR >*  i   = chain.first;
      const PRMAttribute< GUM_SCALAR >* elt = chain.second;
      SVED< GUM_SCALAR >::BucketSet     pool, trash;
      bb__.compute(i, elt->id());
      eliminateNodes__(i, elt->id(), pool, trash);

      std::vector< const Potential< GUM_SCALAR >* > result;
      for (auto pot: pool) {
        if (pot->contains(*(m.variablesSequence().atPos(0))))
          result.push_back(pot);
      }

      while (result.size() > 1) {
        const auto& p1 = *(result.back());
        result.pop_back();
        const auto& p2 = *(result.back());
        result.pop_back();
        auto mult = new Potential< GUM_SCALAR >(p1 * p2);
        result.push_back(mult);
        trash.insert(mult);
      }

      m = *(result.back());
      m.normalize();

      GUM_ASSERT(m.nbrDim() == (Size)1);

      // cleaning up the mess
      for (const auto pot: trash)
        delete pot;

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

      lifted_pools__.clear();

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

      req_set__.clear();

      for (const auto elt: elim_orders__)
        delete elt.second;

      elim_orders__.clear();
    }

Here is the call graph for this function:

reduceElimList__()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVED< GUM_SCALAR >::reduceElimList__ ( const PRMInstance< GUM_SCALAR > *  i, List< const PRMInstance< GUM_SCALAR > * > &  elim_list, List< const PRMInstance< GUM_SCALAR > * > &  reduced_list, Set< const PRMInstance< GUM_SCALAR > * > &  ignore, BucketSet &  pool, BucketSet &  trash  )

private

Returns true if second can be eliminated before first.

Definition at line 609 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                        {
      while (!elim_list.empty()) {
        if (checkElimOrder__(i, elim_list.front())) {
          if ((!ignore.exists(elim_list.front()))
              && (bb__.exists(elim_list.front()))) {
            eliminateNodesDownward__(i,
                                     elim_list.front(),
                                     pool,
                                     trash,
                                     elim_list,
                                     ignore);
          }
        } else if (bb__.exists(elim_list.front())) {
          reduced_list.insert(elim_list.front());
        }

        elim_list.popFront();
      }
    }

Here is the call graph for this function:

removeEvidence()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInference< GUM_SCALAR >::removeEvidence ( const Chain &  chain )

inherited

Remove evidence on the given instance's elt.

Parameters

chain

The variable being observed.

Exceptions

NotFound	Raised if the given names are not found.
TypeError	Raised if the elt is not an PRMAttribute<GUM_SCALAR>.

Definition at line 221 of file PRMInference_tpl.h.

                                                                             {
      try {
        if (EMap__(chain.first).exists(chain.second->id())) {
          evidenceRemoved_(chain);
          delete EMap__(chain.first)[chain.second->id()];
          EMap__(chain.first).erase(chain.second->id());
        }
      } catch (NotFound&) {
        // Ok, we are only removing
      }
    }

trim__()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::SVED< GUM_SCALAR >::trim__ ( const std::string &  s )

private

Returns true if second can be eliminated before first.

Definition at line 548 of file SVED_tpl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                  {
      auto pos = s.find_first_of("<");
      if (pos != std::string::npos) { return s.substr(0, pos); }
      return s;
    }

Here is the call graph for this function:

Member Data Documentation

bb__

template<typename GUM_SCALAR >

StructuredBayesBall< GUM_SCALAR > gum::prm::SVED< GUM_SCALAR >::bb__

private

Definition at line 131 of file SVED.h.

class_elim_order__

template<typename GUM_SCALAR >

Sequence< std::string >* gum::prm::SVED< GUM_SCALAR >::class_elim_order__

private

Definition at line 129 of file SVED.h.

elim_orders__

template<typename GUM_SCALAR >

HashTable< const PRMClass< GUM_SCALAR >*, std::vector< NodeId >* > gum::prm::SVED< GUM_SCALAR >::elim_orders__

private

Definition at line 120 of file SVED.h.

lifted_pools__

template<typename GUM_SCALAR >

HashTable< const Set< NodeId >*, BucketSet* > gum::prm::SVED< GUM_SCALAR >::lifted_pools__

private

The Set<NodeId> returned by StructuredBayesBall<GUM_SCALAR> is unique for each family of instances with the same requisite set (thus the same lifted potentials).

Definition at line 127 of file SVED.h.

prm_

template<typename GUM_SCALAR>

PRM< GUM_SCALAR > const* gum::prm::PRMInference< GUM_SCALAR >::prm_

protectedinherited

The PRM<GUM_SCALAR> on which inference is done.

Definition at line 213 of file PRMInference.h.

req_set__

template<typename GUM_SCALAR >

HashTable< const Set< NodeId >*, std::pair< Set< NodeId >*, Set< NodeId >* > > gum::prm::SVED< GUM_SCALAR >::req_set__

private

First pair -> requisite Attributes Second pair -> requisite SlotChains.

Definition at line 137 of file SVED.h.

sys_

template<typename GUM_SCALAR>

PRMSystem< GUM_SCALAR > const* gum::prm::PRMInference< GUM_SCALAR >::sys_

protectedinherited

The Model on which inference is done.

Definition at line 216 of file PRMInference.h.

---

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

• agrum/PRM/inference/SVED.h
• agrum/PRM/inference/SVED_tpl.h