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

This abstract class is used as base class for all inference class on PRM<GUM_SCALAR>. More...

#include <agrum/PRM/PRMInference.h>

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

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

Public Member Functions
Constructor & destructor.
	PRMInference (const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
	Default constructor. More...
	PRMInference (const PRMInference &source)
	Copy constructor. More...
virtual	~PRMInference ()
	Destructor. More...
PRMInference &	operator= (const PRMInference &source)
	Copy operator. More...
Getters & setters.
virtual std::string	name () const =0
	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 std::pair< const PRMInstance< GUM_SCALAR > *, const PRMAttribute< GUM_SCALAR > *>	Chain
	Code alias. More...
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 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...
virtual void	_evidenceAdded (const Chain &chain)=0
	This method is called whenever an evidence is added, but AFTER any processing made by PRMInference. More...
virtual void	_evidenceRemoved (const Chain &chain)=0
	This method is called whenever an evidence is removed, but BEFORE any processing made by PRMInference. More...
virtual void	_marginal (const Chain &chain, Potential< GUM_SCALAR > &m)=0
	Generic method to compute the marginal of given element. More...
virtual void	_joint (const std::vector< Chain > &queries, Potential< GUM_SCALAR > &j)=0
	Generic method to compute the marginal of given element. More...

Private evidence handling methods and members.
typedef HashTable< const PRMInstance< GUM_SCALAR > *, EMap *>::iterator_safe	EvidenceIterator
	Code alias. More...
typedef HashTable< const PRMInstance< GUM_SCALAR > *, EMap *>::const_iterator_safe	EvidenceConstIterator
	Code alias. More...
HashTable< const PRMInstance< GUM_SCALAR > *, EMap *>	__evidences
	Mapping of evidence over PRMInstance<GUM_SCALAR>'s nodes. More...
EMap &	__EMap (const PRMInstance< GUM_SCALAR > *i)
	Private getter over __evidences, if necessary creates an EMap for i. More...

Detailed Description

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

This abstract class is used as base class for all inference class on PRM<GUM_SCALAR>.

The main purpose of this class is to give a common interface between all inference algorithms and to handle evidences.

Definition at line 49 of file PRMInference.h.

Member Typedef Documentation

Chain

template<typename GUM_SCALAR>

typedef std::pair< const PRMInstance< GUM_SCALAR >*, const PRMAttribute< GUM_SCALAR >* > gum::prm::PRMInference< GUM_SCALAR >::Chain

Code alias.

Definition at line 54 of file PRMInference.h.

EMap

template<typename GUM_SCALAR>

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

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

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

Code alias.

Definition at line 62 of file PRMInference.h.

EvidenceConstIterator

template<typename GUM_SCALAR>

typedef HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::const_iterator_safe gum::prm::PRMInference< GUM_SCALAR >::EvidenceConstIterator

private

Code alias.

Definition at line 229 of file PRMInference.h.

EvidenceIterator

template<typename GUM_SCALAR>

typedef HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::iterator_safe gum::prm::PRMInference< GUM_SCALAR >::EvidenceIterator

private

Code alias.

Definition at line 225 of file PRMInference.h.

Constructor & Destructor Documentation

PRMInference() [1/2]

template<typename GUM_SCALAR>

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

Default constructor.

Definition at line 138 of file PRMInference_tpl.h.

                                                                            :
        _prm(&prm),
        _sys(&system) {
      GUM_CONSTRUCTOR(PRMInference);
    }

PRMInference() [2/2]

template<typename GUM_SCALAR>

gum::prm::PRMInference< GUM_SCALAR >::PRMInference

(

const PRMInference< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 45 of file PRMInference_tpl.h.

                                                 :
        _prm(source._prm),
        _sys(source._sys) {
      GUM_CONS_CPY(PRMInference);

      for (const auto& elt : source.__evidences) {
        __evidences.insert(elt.first, new PRMInference< GUM_SCALAR >::EMap());

        for (const auto& elt2 : *elt.second) {
          Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
          e->add(*(elt2.second->variablesSequence().front()));
          Instantiation i(*e);

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

          __evidences[elt.first]->insert(elt2.first, e);
        }
      }
    }

~PRMInference()

template<typename GUM_SCALAR >

INLINE gum::prm::PRMInference< GUM_SCALAR >::~PRMInference ( )

virtual

Destructor.

Definition at line 146 of file PRMInference_tpl.h.

                                                     {
      GUM_DESTRUCTOR(PRMInference);
      clearEvidence();
    }

Member Function Documentation

__EMap()

template<typename GUM_SCALAR>

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

private

Private getter over __evidences, if necessary creates an EMap for i.

Definition at line 95 of file PRMInference_tpl.h.

                                                                            {
      if (__evidences.exists(i)) {
        return *(__evidences[i]);
      } else {
        __evidences.insert(i, new PRMInference< GUM_SCALAR >::EMap());
        return *(__evidences[i]);
      }
    }

_evidenceAdded()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMInference< GUM_SCALAR >::_evidenceAdded ( const Chain &  chain )

protectedpure virtual

This method is called whenever an evidence is added, but AFTER any processing made by PRMInference.

Implemented in gum::prm::SVE< GUM_SCALAR >, and gum::prm::SVED< GUM_SCALAR >.

_evidenceRemoved()

template<typename GUM_SCALAR>

virtual void gum::prm::PRMInference< GUM_SCALAR >::_evidenceRemoved ( const Chain &  chain )

protectedpure virtual

This method is called whenever an evidence is removed, but BEFORE any processing made by PRMInference.

Implemented in gum::prm::SVE< GUM_SCALAR >, and gum::prm::SVED< GUM_SCALAR >.

_joint()

template<typename GUM_SCALAR>

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

protectedpure virtual

Generic method to compute the marginal of given element.

Parameters

queries	Set of pairs of PRMInstance<GUM_SCALAR> and PRMAttribute<GUM_SCALAR>.
j	CPF filled with the joint probability of queries. It is initialized properly.

Implemented in gum::prm::SVE< GUM_SCALAR >, and gum::prm::SVED< GUM_SCALAR >.

_marginal()

template<typename GUM_SCALAR>

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

protectedpure virtual

Generic method to compute the marginal of given element.

Parameters

chain
m	CPF filled with the marginal of elt. It is initialized properly.

Implemented in gum::prm::SVE< GUM_SCALAR >, and gum::prm::SVED< GUM_SCALAR >.

addEvidence()

template<typename GUM_SCALAR>

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

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

(

)

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

)

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

)

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

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

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

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

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

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

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
	)

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
	)

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>

virtual std::string gum::prm::PRMInference< GUM_SCALAR >::name ( ) const

pure virtual

Returns the name of the current inference algorithm.

Implemented in gum::prm::StructuredInference< GUM_SCALAR >, gum::prm::GroundedInference< GUM_SCALAR >, gum::prm::SVE< GUM_SCALAR >, and gum::prm::SVED< GUM_SCALAR >.

Referenced by gum::prm::GroundedInference< GUM_SCALAR >::_evidenceAdded(), gum::prm::GroundedInference< GUM_SCALAR >::_evidenceRemoved(), and gum::prm::GroundedInference< GUM_SCALAR >::_marginal().

Here is the caller graph for this function:

operator=()

template<typename GUM_SCALAR >

PRMInference< GUM_SCALAR > & gum::prm::PRMInference< GUM_SCALAR >::operator=

(

const PRMInference< GUM_SCALAR > &

source

)

Copy operator.

Definition at line 69 of file PRMInference_tpl.h.

                                                                                    {
      clearEvidence();
      _prm = source._prm;
      _sys = source._sys;

      for (const auto& elt : source.__evidences) {
        __evidences.insert(elt.first, new PRMInference< GUM_SCALAR >::EMap());

        for (const auto& elt2 : *elt.second) {
          Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
          e->add(*(elt2.second->variablesSequence().front()));
          Instantiation i(*e);

          for (i.setFirst(); !i.end(); i.inc()) {
            e->set(i, elt2.second->get(i));
          }

          __evidences[elt.first]->insert(elt2.first, e);
        }
      }

      return *this;
    }

removeEvidence()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMInference< GUM_SCALAR >::removeEvidence

(

const Chain &

chain

)

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

__evidences

template<typename GUM_SCALAR>

HashTable< const PRMInstance< GUM_SCALAR >*, EMap* > gum::prm::PRMInference< GUM_SCALAR >::__evidences

private

Mapping of evidence over PRMInstance<GUM_SCALAR>'s nodes.

Definition at line 232 of file PRMInference.h.

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

_prm

template<typename GUM_SCALAR>

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

protected

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

protected

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/PRMInference.h
• agrum/PRM/inference/PRMInference_tpl.h