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

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

#include <agrum/PRM/SVE.h>

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

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

Public Member Functions
Constructors & destructor.
	SVE (const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
	Default Constructor. More...
	~SVE ()
	Destructor. More...
Getters & setters.
virtual std::string	name () const
	Returns the name of the current inference algorithm. More...
Query methods.
void	marginal (const Chain &chain, Potential< GUM_SCALAR > &m)
	Compute the marginal 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<GUM_SCALAR>::_evidenceAdded(). More...
virtual void	_evidenceRemoved (const Chain &chain)
	See PRMInference<GUM_SCALAR>::_evidenceRemoved(). More...
virtual void	_marginal (const Chain &chain, Potential< GUM_SCALAR > &m)
	See PRMInference<GUM_SCALAR>::_marginal(). More...
virtual void	_joint (const std::vector< Chain > &queries, Potential< GUM_SCALAR > &j)
	See PRMInference<GUM_SCALAR>::_joint(). More...

Detailed Description

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

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

Definition at line 63 of file SVE.h.

Member Typedef Documentation

ArraySetIterator

template<typename GUM_SCALAR >

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

private

Code alias.

Definition at line 118 of file SVE.h.

BucketSet

template<typename GUM_SCALAR >

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

private

Code alias.

Definition at line 111 of file SVE.h.

BucketSetIterator

template<typename GUM_SCALAR >

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

private

Code alias.

Definition at line 114 of file SVE.h.

Chain

template<typename GUM_SCALAR >

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

protected

Code alias.

Definition at line 93 of file SVE.h.

EMap

template<typename GUM_SCALAR>

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

inherited

Code alias.

Definition at line 57 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 66 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 62 of file PRMInference.h.

Constructor & Destructor Documentation

SVE()

template<typename GUM_SCALAR >

INLINE gum::prm::SVE< GUM_SCALAR >::SVE	(	const PRM< GUM_SCALAR > &	prm,
		const PRMSystem< GUM_SCALAR > &	system
	)

Default Constructor.

Definition at line 617 of file SVE_tpl.h.

                                                                         :
        PRMInference< GUM_SCALAR >(prm, system),
        __class_elim_order(0) {
      GUM_CONSTRUCTOR(SVE);
    }

~SVE()

template<typename GUM_SCALAR >

gum::prm::SVE< GUM_SCALAR >::~SVE

(

)

Destructor.

Definition at line 105 of file SVE_tpl.h.

                            {
      GUM_DESTRUCTOR(SVE);

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

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

      if (__class_elim_order != nullptr) delete __class_elim_order;

      for (const auto trash : __lifted_trash)
        delete trash;

      for (auto set : __delayedVariables)
        delete set.second;
    }

Member Function Documentation

__addDelayedVariable()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable ( const PRMInstance< GUM_SCALAR > *  i, const PRMInstance< GUM_SCALAR > *  j, NodeId  id  )

private

When there is a loop in the references some variable elimination must be delayed, this methods add such variable to __delayedVariables to keep track of them.

Parameters

i	An PRMInstance<GUM_SCALAR> with a child of j->get(id).
j	The PRMInstance<GUM_SCALAR> with the delayed variable.
id	The NodeId of the delayed variable.

Definition at line 675 of file SVE_tpl.h.

References gum::prm::SVE< GUM_SCALAR >::__delayedVariables, gum::prm::SVE< GUM_SCALAR >::__delayedVariablesCounters, gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::PRMObject::name().

                                                          {
      try {
        __delayedVariables[i]->insert(&(j->get(id).type().variable()));
      } catch (NotFound&) {
        __delayedVariables.insert(i, new Set< const DiscreteVariable* >());
        __delayedVariables[i]->insert(&(j->get(id).type().variable()));
      } catch (DuplicateElement&) {
        // happends if j->get(id) is parent of more than one variable in i
      }

      static std::string dot = ".";

      try {
        __delayedVariablesCounters[j->name() + dot + j->get(id).safeName()] += 1;
      } catch (NotFound&) {
        __delayedVariablesCounters.insert(j->name() + dot + j->get(id).safeName(),
                                          1);
      }
    }

Here is the call graph for this function:

__checkElimOrder()

template<typename GUM_SCALAR >

INLINE bool gum::prm::SVE< 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 646 of file SVE_tpl.h.

References gum::prm::SVE< GUM_SCALAR >::__class_elim_order, gum::prm::SVE< GUM_SCALAR >::__initElimOrder(), gum::prm::SVE< GUM_SCALAR >::__trim(), gum::SequenceImplementation< Key, Alloc, Gen >::pos(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

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

__eliminateDelayedVariables()

template<typename GUM_SCALAR >

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

private

Returns true if second can be eliminated before first.

Definition at line 207 of file SVE_tpl.h.

References gum::MultiDimBucket< GUM_SCALAR >::add(), gum::MultiDimBucket< GUM_SCALAR >::allVariables(), and gum::Set< Key, Alloc >::insert().

                                                                              {
      Set< Potential< GUM_SCALAR >* > toRemove;

      for (const auto var : *__delayedVariables[i]) {
        MultiDimBucket< GUM_SCALAR >* bucket = new MultiDimBucket< GUM_SCALAR >();

        for (const auto pot : pool)
          if (pot->contains(*var)) {
            bucket->add(*pot);
            toRemove.insert(pot);
          }

        for (const auto pot : toRemove)
          pool.erase(pot);

        for (const auto other : bucket->allVariables())
          if (other != var) bucket->add(*other);

        Potential< GUM_SCALAR >* bucket_pot = new Potential< GUM_SCALAR >(bucket);
        trash.insert(bucket_pot);
        pool.insert(bucket_pot);
      }
    }

Here is the call graph for this function:

__eliminateNodes()

template<typename GUM_SCALAR >

void gum::prm::SVE< 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 125 of file SVE_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::begin(), gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef(), gum::prm::eliminateNodes(), gum::StaticTriangulation::eliminationOrder(), gum::List< Val, Alloc >::empty(), gum::prm::PRMInstance< GUM_SCALAR >::end(), gum::prm::PRMInstance< GUM_SCALAR >::endInvRef(), gum::Set< Key, Alloc >::exists(), gum::List< Val, Alloc >::front(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), gum::Set< Key, Alloc >::insert(), gum::List< Val, Alloc >::insert(), gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities(), gum::DAGmodel::moralGraph(), gum::List< Val, Alloc >::popFront(), gum::prm::PRMInstance< GUM_SCALAR >::type(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::variable().

                                                             {
      Set< const PRMInstance< GUM_SCALAR >* > ignore, eliminated;
      Set< NodeId >                           delayedVars;
      // Downward elimination
      List< const PRMInstance< GUM_SCALAR >* > elim_list;
      ignore.insert(query);

      for (auto iter = query->beginInvRef(); iter != query->endInvRef(); ++iter) {
        for (auto child = (*(iter.val())).begin(); child != (*(iter.val())).end();
             ++child) {
          if (!ignore.exists(child->first)) {
            __eliminateNodesDownward(
               query, child->first, pool, trash, elim_list, ignore, eliminated);
          } else if (!eliminated.exists(child->first)) {
            __addDelayedVariable(child->first, query, iter.key());
            delayedVars.insert(iter.key());
          }
        }
      }

      // 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 (auto attr = query->begin(); attr != query->end(); ++attr) {
        pool.insert(
           &(const_cast< Potential< GUM_SCALAR >& >((*(attr.val())).cpf())));
      }

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

      eliminateNodes(elim_order, pool, trash);

      // Eliminating delayed variables, if any
      if (__delayedVariables.exists(query)) {
        __eliminateDelayedVariables(query, pool, trash);
      }

      eliminated.insert(query);
      // Eliminating instance in elim_list
      List< const PRMInstance< GUM_SCALAR >* > tmp_list;

      while (!elim_list.empty()) {
        if (__checkElimOrder(query, elim_list.front())) {
          if (!ignore.exists(elim_list.front())) {
            __eliminateNodesDownward(query,
                                     elim_list.front(),
                                     pool,
                                     trash,
                                     elim_list,
                                     ignore,
                                     eliminated);
          }
        } else {
          tmp_list.insert(elim_list.front());
        }

        elim_list.popFront();
      }

      // Upward elimination
      for (const auto chain : query->type().slotChains())
        for (const auto parent : query->getInstances(chain->id()))
          if (!ignore.exists(parent))
            __eliminateNodesUpward(
               parent, pool, trash, tmp_list, ignore, eliminated);
    }

Here is the call graph for this function:

__eliminateNodesDownward()

template<typename GUM_SCALAR >

void gum::prm::SVE< 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, Set< const PRMInstance< GUM_SCALAR > * > &  eliminated  )

private

Returns true if second can be eliminated before first.

Definition at line 233 of file SVE_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef(), gum::Set< Key, Alloc >::empty(), gum::prm::PRMInstance< GUM_SCALAR >::endInvRef(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), gum::Set< Key, Alloc >::insert(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                             {
      Set< NodeId > delayedVars;
      ignore.insert(i);
      // Calling elimination over child instance
      List< const PRMInstance< GUM_SCALAR >* > my_list;

      for (auto iter = i->beginInvRef(); iter != i->endInvRef(); ++iter) {
        for (auto child = (*(iter.val())).begin(); child != (*(iter.val())).end();
             ++child) {
          if (!ignore.exists(child->first)) {
            __eliminateNodesDownward(
               i, child->first, pool, trash, my_list, ignore, eliminated);
          } else if (!eliminated.exists(child->first)) {
            __addDelayedVariable(child->first, i, iter.key());
            delayedVars.insert(iter.key());
          }
        }
      }

      // Eliminating all nodes in current instance
      __variableElimination(
         i, pool, trash, (delayedVars.empty() ? 0 : &delayedVars));
      eliminated.insert(i);

      // Calling elimination over child's parents
      for (const auto node : my_list) {
        if (__checkElimOrder(i, node) && (node != from)) {
          if (!ignore.exists(node)) {
            __eliminateNodesDownward(
               i, node, pool, trash, elim_list, ignore, eliminated);
          }
        } else if (node != from) {
          elim_list.insert(node);
        }
      }

      // Adding parents instance to elim_list
      for (const auto chain : i->type().slotChains()) {
        for (const auto inst : i->getInstances(chain->id())) {
          if (inst != from) { elim_list.insert(inst); }
        }
      }
    }

Here is the call graph for this function:

__eliminateNodesUpward()

template<typename GUM_SCALAR >

void gum::prm::SVE< 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, Set< const PRMInstance< GUM_SCALAR > * > &  eliminated  )

private

Returns true if second can be eliminated before first.

Definition at line 328 of file SVE_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef(), gum::prm::PRMInstance< GUM_SCALAR >::endInvRef(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), gum::List< Val, Alloc >::insert(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

                                                             {
      // Downward elimination
      ignore.insert(i);

      for (auto iter = i->beginInvRef(); iter != i->endInvRef(); ++iter) {
        for (auto child = (*(iter.val())).begin(); child != (*(iter.val())).end();
             ++child) {
          if (!ignore.exists(child->first)) {
            __eliminateNodesDownward(
               i, child->first, pool, trash, elim_list, ignore, eliminated);
          }
        }
      }

      // Eliminating all nodes in i instance
      __variableElimination(i, pool, trash);
      eliminated.insert(i);
      // 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())) {
            __eliminateNodesDownward(
               i, elim_list.front(), pool, trash, elim_list, ignore, eliminated);
          }
        } else {
          tmp_list.insert(elim_list.front());
        }

        elim_list.popFront();
      }

      // Upward elimination
      for (const auto chain : i->type().slotChains()) {
        for (const auto parent : i->getInstances(chain->id())) {
          if (!ignore.exists(parent)) {
            __eliminateNodesUpward(
               parent, pool, trash, tmp_list, ignore, eliminated);
          }
        }
      }
    }

Here is the call graph for this function:

__eliminateNodesWithEvidence()

template<typename GUM_SCALAR >

void gum::prm::SVE< GUM_SCALAR >::__eliminateNodesWithEvidence ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash, Set< NodeId > *  delayedVars = 0  )

private

Returns true if second can be eliminated before first.

Definition at line 379 of file SVE_tpl.h.

References gum::prm::eliminateNodes(), gum::StaticTriangulation::eliminationOrder(), gum::Set< Key, Alloc >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::get(), GUM_ERROR, gum::Set< Key, Alloc >::insert(), gum::prm::InstanceBayesNet< GUM_SCALAR >::modalities(), gum::DAGmodel::moralGraph(), gum::prm::PRMInstance< GUM_SCALAR >::type(), and gum::prm::InstanceBayesNet< GUM_SCALAR >::variable().

                                                     {
      // First we check if evidences are on inner nodes
      bool inner = false;

      for (const auto& elt : this->evidence(i)) {
        inner = i->type().isInputNode(i->get(elt.first))
                || i->type().isInnerNode(i->get(elt.first));

        if (inner) { break; }
      }

      // Evidence on inner nodes
      if (inner) {
        BucketSet tmp_pool;
        __insertEvidence(i, tmp_pool);

        // We need a local to not eliminate queried inner nodes of the same
        // class
        for (const auto& elt : *i) {
          tmp_pool.insert(
             &(const_cast< Potential< GUM_SCALAR >& >(elt.second->cpf())));
        }

        InstanceBayesNet< GUM_SCALAR > bn(*i);
        DefaultTriangulation           t(&(bn.moralGraph()), &(bn.modalities()));
        const std::vector< NodeId >&   full_elim_order = t.eliminationOrder();
        // Removing Output nodes of elimination order
        std::vector< const DiscreteVariable* > inner_elim_order;
        std::vector< const DiscreteVariable* > output_elim_order;

        for (size_t idx = 0; idx < full_elim_order.size(); ++idx) {
          auto        var_id = full_elim_order[idx];
          const auto& var = bn.variable(var_id);

          if (!i->type().isOutputNode(i->get(full_elim_order[idx]))) {
            inner_elim_order.push_back(&var);
          } else if (delayedVars != nullptr) {
            if (!delayedVars->exists(full_elim_order[idx])) {
              output_elim_order.push_back(&var);
            }
          } else {
            output_elim_order.push_back(&var);
          }
        }

        eliminateNodes(inner_elim_order, tmp_pool, trash);

        // Now we add the new potentials in pool and eliminate output nodes
        for (const auto pot : tmp_pool)
          pool.insert(pot);

        if (!output_elim_order.empty())
          eliminateNodes(output_elim_order, pool, trash);

      } else {
        InstanceBayesNet< GUM_SCALAR > bn(*i);
        __insertEvidence(i, pool);
        __insertLiftedNodes(i, pool, trash);

        for (const auto agg : i->type().aggregates())
          pool.insert(__getAggPotential(i, agg));

        try {
          std::vector< const DiscreteVariable* > elim;

          for (auto iter = __getElimOrder(i->type()).begin();
               iter != __getElimOrder(i->type()).end();
               ++iter) {
            const auto& var = bn.variable(*iter);
            if (delayedVars != nullptr) {
              if (!delayedVars->exists(*iter)) { elim.push_back(&var); }
            } else {
              elim.push_back(&var);
            }
          }

          eliminateNodes(elim, pool, trash);
        } catch (NotFound&) {
          GUM_ERROR(FatalError, "there should be at least one node here.");
        }
      }
    }

Here is the call graph for this function:

__getAggPotential()

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > * gum::prm::SVE< 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 658 of file SVE_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::get(), and gum::prm::PRMClassElement< GUM_SCALAR >::id().

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

Here is the call graph for this function:

__getElimOrder()

template<typename GUM_SCALAR >

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

private

Returns true if second can be eliminated before first.

Definition at line 634 of file SVE_tpl.h.

References gum::prm::SVE< GUM_SCALAR >::__elim_orders.

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

__initElimOrder()

template<typename GUM_SCALAR >

void gum::prm::SVE< GUM_SCALAR >::__initElimOrder ( )

private

Returns true if second can be eliminated before first.

Definition at line 541 of file SVE_tpl.h.

References gum::Set< Key, Alloc >::contains(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::dag(), gum::SequenceImplementation< Key, Alloc, std::is_scalar< Key >::value >::exists(), gum::prm::ClassDependencyGraph< GUM_SCALAR >::get(), gum::Set< Key, Alloc >::insert(), gum::SequenceImplementation< Key, Alloc, Gen >::insert(), and gum::SequenceImplementation< Key, Alloc, std::is_scalar< Key >::value >::insert().

Referenced by gum::prm::SVE< GUM_SCALAR >::__checkElimOrder().

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

Here is the caller graph for this function:

__initLiftedNodes()

template<typename GUM_SCALAR >

void gum::prm::SVE< GUM_SCALAR >::__initLiftedNodes ( const PRMClass< GUM_SCALAR > &  c )

private

Returns true if second can be eliminated before first.

Definition at line 487 of file SVE_tpl.h.

References gum::prm::PRMClassElementContainer< GUM_SCALAR >::containerDag(), gum::prm::eliminateNode(), gum::StaticTriangulation::eliminationOrder(), gum::Set< Key, Alloc >::erase(), gum::Set< Key, Alloc >::exists(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::Set< Key, Alloc >::insert(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInnerNode(), gum::prm::PRMClass< GUM_SCALAR >::isOutputNode(), gum::prm::ClassBayesNet< GUM_SCALAR >::modalities(), gum::DAGmodel::moralGraph(), gum::List< Val, Alloc >::push_back(), and gum::Set< Key, Alloc >::size().

                                                                             {
      BucketSet* lifted_pool = new BucketSet();
      __lifted_pools.insert(&c, lifted_pool);
      NodeSet inners, outers;

      for (const auto node : c.containerDag().nodes())
        if (PRMClassElement< GUM_SCALAR >::isAttribute(c.get(node))) {
          if (c.isOutputNode(c.get(node)))
            outers.insert(node);
          else if (!outers.exists(node))
            inners.insert(node);

          lifted_pool->insert(
             const_cast< Potential< GUM_SCALAR >* >(&(c.get(node).cpf())));
        } else if (PRMClassElement< GUM_SCALAR >::isAggregate(c.get(node))) {
          outers.insert(node);

          // We need to put in the output_elim_order aggregator's parents which
          // are
          // innner nodes
          for (const auto par : c.containerDag().parents(node))
            if (PRMClassElement< GUM_SCALAR >::isAttribute(c.get(par))
                && c.isInnerNode(c.get(par))) {
              inners.erase(par);
              outers.insert(par);
            }
        }

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

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

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

      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,
                      __lifted_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:

__insertEvidence()

template<typename GUM_SCALAR >

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

private

Returns true if second can be eliminated before first.

Definition at line 626 of file SVE_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::evidence(), and gum::Set< Key, Alloc >::insert().

                                                                                  {
      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::SVE< 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 467 of file SVE_tpl.h.

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

                                                                  {
      SVE< GUM_SCALAR >::BucketSet* lifted_pool = 0;

      try {
        lifted_pool = __lifted_pools[&(i->type())];
      } catch (NotFound&) {
        __initLiftedNodes(i->type());
        lifted_pool = __lifted_pools[&(i->type())];
      }

      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:

__trim()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::SVE< GUM_SCALAR >::__trim ( const std::string &  s )

private

Returns true if second can be eliminated before first.

Definition at line 639 of file SVE_tpl.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__checkElimOrder().

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

Here is the caller graph for this function:

__variableElimination()

template<typename GUM_SCALAR >

void gum::prm::SVE< GUM_SCALAR >::__variableElimination ( const PRMInstance< GUM_SCALAR > *  i, BucketSet &  pool, BucketSet &  trash, Set< NodeId > *  delayedVars = 0  )

private

Returns true if second can be eliminated before first.

Definition at line 286 of file SVE_tpl.h.

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

                                                                            {
      if (this->hasEvidence(i)) {
        __eliminateNodesWithEvidence(i, pool, trash, delayedVars);
      } else {
        __insertLiftedNodes(i, pool, trash);

        for (const auto agg : i->type().aggregates())
          pool.insert(__getAggPotential(i, agg));

        try {
          InstanceBayesNet< GUM_SCALAR > bn(*i);

          std::vector< const DiscreteVariable* > elim;

          for (const auto node : __getElimOrder(i->type())) {
            const auto& var = bn.variable(node);
            if (delayedVars != nullptr) {
              if (!delayedVars->exists(node)) {
                const auto& var = bn.variable(node);
                elim.push_back(&var);
              }
            } else {
              elim.push_back(&var);
            }
          }

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

      // Eliminating delayed variables, if any
      if (__delayedVariables.exists(i)) {
        __eliminateDelayedVariables(i, pool, trash);
      }
    }

Here is the call graph for this function:

_evidenceAdded()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVE< GUM_SCALAR >::_evidenceAdded ( const Chain &  chain )

protectedvirtual

See PRMInference<GUM_SCALAR>::_evidenceAdded().

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

Definition at line 664 of file SVE_tpl.h.

                                                                    {
      // Do nothing
    }

_evidenceRemoved()

template<typename GUM_SCALAR >

INLINE void gum::prm::SVE< GUM_SCALAR >::_evidenceRemoved ( const Chain &  chain )

protectedvirtual

See PRMInference<GUM_SCALAR>::_evidenceRemoved().

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

Definition at line 669 of file SVE_tpl.h.

                                                                      {
      // Do nothing
    }

_joint()

template<typename GUM_SCALAR >

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

protectedvirtual

See PRMInference<GUM_SCALAR>::_joint().

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

Definition at line 611 of file SVE_tpl.h.

References GUM_ERROR.

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

_marginal()

template<typename GUM_SCALAR >

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

protectedvirtual

See PRMInference<GUM_SCALAR>::_marginal().

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

Definition at line 578 of file SVE_tpl.h.

References gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::Set< Key, Alloc >::insert(), gum::Potential< GUM_SCALAR >::normalize(), gum::prm::PRMAttribute< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

                                                                  {
      const PRMInstance< GUM_SCALAR >*  i = chain.first;
      const PRMAttribute< GUM_SCALAR >* elt = chain.second;
      SVE< GUM_SCALAR >::BucketSet      pool, trash;

      __eliminateNodes(i, elt->id(), pool, trash);

      std::vector< Potential< GUM_SCALAR >* > result;

      for (const auto pot : pool) {
        if (pot->contains(elt->type().variable())) { result.push_back(pot); }
      }

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

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

      for (const auto pot : trash) {
        delete pot;
      }
    }

Here is the call graph for this function:

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 106 of file PRMInference_tpl.h.

Referenced by gum::prm::o3prmr::O3prmrInterpreter::observe().

                                                                                 {
      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>.");
      }
    }

Here is the caller graph for this function:

clearEvidence()

template<typename GUM_SCALAR >

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

inherited

Remove all evidences.

Definition at line 33 of file PRMInference_tpl.h.

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

        delete elt.second;
      }

      __evidences.clear();
    }

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 153 of file PRMInference_tpl.h.

Referenced by gum::prm::SVED< GUM_SCALAR >::__insertEvidence(), gum::prm::SVE< GUM_SCALAR >::__insertEvidence(), gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), and gum::prm::StructuredInference< GUM_SCALAR >::_marginal().

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

Here is the caller graph for this function:

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 174 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 163 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 184 of file PRMInference_tpl.h.

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

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 194 of file PRMInference_tpl.h.

Referenced by gum::prm::o3prmr::O3prmrInterpreter::observe(), and gum::prm::o3prmr::O3prmrInterpreter::unobserve().

                                                 {
      return __evidences.exists(&i);
    }

Here is the caller graph for this function:

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 200 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 206 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 213 of file PRMInference_tpl.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__insertNodeInElimLists(), gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), and gum::prm::StructuredInference< GUM_SCALAR >::_marginal().

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

Here is the caller 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 260 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);
    }

marginal()

template<typename GUM_SCALAR>

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

inherited

Compute the marginal 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 marginal of chain.

Exceptions

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

Definition at line 231 of file PRMInference_tpl.h.

Referenced by gum::prm::o3prmr::O3prmrInterpreter::query().

                                                            {
      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());
          _marginal(good_chain, m);
        } else {
          m.add(chain.second->type().variable());
          _marginal(chain, m);
        }
      }
    }

Here is the caller graph for this function:

name()

template<typename GUM_SCALAR >

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

virtual

Returns the name of the current inference algorithm.

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

Definition at line 698 of file SVE_tpl.h.

                                                   {
      return "SVE";
    }

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.
WrongType	Raised if the elt is not an PRMAttribute<GUM_SCALAR>.

Definition at line 218 of file PRMInference_tpl.h.

Referenced by gum::prm::o3prmr::O3prmrInterpreter::unobserve().

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

Here is the caller graph for this function:

Member Data Documentation

__class_elim_order

template<typename GUM_SCALAR >

Sequence< std::string >* gum::prm::SVE< GUM_SCALAR >::__class_elim_order

private

Definition at line 125 of file SVE.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__checkElimOrder().

__delayedVariables

template<typename GUM_SCALAR >

HashTable< const PRMInstance< GUM_SCALAR >*, Set< const DiscreteVariable* >* > gum::prm::SVE< GUM_SCALAR >::__delayedVariables

private

Definition at line 129 of file SVE.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable().

__delayedVariablesCounters

template<typename GUM_SCALAR >

HashTable< std::string, Size > gum::prm::SVE< GUM_SCALAR >::__delayedVariablesCounters

private

Some variable must be delayed for more than one PRMInstance<GUM_SCALAR>, when the delayed variable counter reach 0 it can be eliminated.

Definition at line 136 of file SVE.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable().

__elim_orders

template<typename GUM_SCALAR >

HashTable< const PRMClass< GUM_SCALAR >*, std::vector< NodeId >* > gum::prm::SVE< GUM_SCALAR >::__elim_orders

private

Definition at line 121 of file SVE.h.

Referenced by gum::prm::SVE< GUM_SCALAR >::__getElimOrder().

__lifted_pools

template<typename GUM_SCALAR >

HashTable< const PRMClass< GUM_SCALAR >*, BucketSet* > gum::prm::SVE< GUM_SCALAR >::__lifted_pools

private

Definition at line 123 of file SVE.h.

__lifted_trash

template<typename GUM_SCALAR >

BucketSet gum::prm::SVE< GUM_SCALAR >::__lifted_trash

private

Definition at line 138 of file SVE.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 210 of file PRMInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::operator=(), gum::prm::PRMInference< double >::operator=(), and gum::prm::StructuredInference< GUM_SCALAR >::StructuredInference().

_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 213 of file PRMInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__reduceAloneInstances(), gum::prm::StructuredInference< GUM_SCALAR >::operator=(), gum::prm::PRMInference< double >::operator=(), gum::prm::StructuredInference< GUM_SCALAR >::searchPatterns(), and gum::prm::StructuredInference< GUM_SCALAR >::StructuredInference().

---

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

• agrum/PRM/inference/SVE.h
• agrum/PRM/inference/SVE_tpl.h