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

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

#include <groundedInference.h>

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

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

Public Types
using	Chain = std::pair< const PRMInstance< GUM_SCALAR >*, const PRMAttribute< GUM_SCALAR >* >
	Code alias.
using	EMap = NodeProperty< const Tensor< GUM_SCALAR >* >
	Code alias.
using	EMapIterator = typename NodeProperty< const Tensor< GUM_SCALAR >* >::iterator_safe
	Code alias.
using	EMapConstIterator
	Code alias.

Public Member Functions
Constructor & destructor.
	GroundedInference (const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
	Default constructor.
	~GroundedInference () override
	Destructor.
Getters & setters.
MarginalTargetedInference< GUM_SCALAR > &	getBNInference ()
	Returns the bayesnet inference engine used by this class.
void	setBNInference (MarginalTargetedInference< GUM_SCALAR > *bn_inf)
	Defines the bayesnet inference engine used by this class.
std::string	name () const override
	Returns the bayesnet inference engine used by this class.
Query methods.
void	posterior (const Chain &chain, Tensor< GUM_SCALAR > &m)
	Compute the posterior of the formal attribute pointed by chain and stores it in m.
void	joint (const std::vector< Chain > &chains, Tensor< GUM_SCALAR > &j)
	Compute the joint probability of the formals attributes pointed by chains and stores it in m.
Evidence handling.
EMap &	evidence (const PRMInstance< GUM_SCALAR > &i)
	Returns EMap of evidences over i.
EMap &	evidence (const PRMInstance< GUM_SCALAR > *i)
	Returns EMap of evidences over i.
const EMap &	evidence (const PRMInstance< GUM_SCALAR > &i) const
	Returns EMap of evidences over i.
const EMap &	evidence (const PRMInstance< GUM_SCALAR > *i) const
	Returns EMap of evidences over i.
bool	hasEvidence (const PRMInstance< GUM_SCALAR > &i) const
	Returns true if i has evidence.
bool	hasEvidence (const PRMInstance< GUM_SCALAR > *i) const
	Returns EMap of evidences over i.
bool	hasEvidence (const Chain &chain) const
	Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.
bool	hasEvidence () const
	Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.
void	addEvidence (const Chain &chain, const Tensor< GUM_SCALAR > &p)
	Add an evidence to the given instance's elt.
void	removeEvidence (const Chain &chain)
	Remove evidence on the given instance's elt.
void	clearEvidence ()
	Remove all evidences.

Protected Member Functions
Private evidence handling methods and members.
void	evidenceAdded_ (const typename PRMInference< GUM_SCALAR >::Chain &chain) override
	This method is called whenever an evidence is added, but AFTER any processing made by PRMInference.
void	evidenceRemoved_ (const typename PRMInference< GUM_SCALAR >::Chain &chain) override
	This method is called whenever an evidence is removed, but BEFORE any processing made by PRMInference.
void	posterior_ (const typename PRMInference< GUM_SCALAR >::Chain &chain, Tensor< GUM_SCALAR > &m) override
	Generic method to compute the marginal of given element.
void	joint_ (const std::vector< typename PRMInference< GUM_SCALAR >::Chain > &queries, Tensor< GUM_SCALAR > &j) override
	Generic method to compute the marginal of given element.

Private Member Functions
	GroundedInference (const GroundedInference &source)
	Copy constructor.
GroundedInference &	operator= (const GroundedInference &source)
	Copy operator.

Private Attributes
MarginalTargetedInference< GUM_SCALAR > *	_inf_
	The bayesnet inference engine used by this class.
List< const Tensor< GUM_SCALAR > * >	_obs_

Private evidence handling methods and members.
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * >	_evidences_
	Mapping of evidence over PRMInstance<GUM_SCALAR>'s nodes.
EMap &	_EMap_ (const PRMInstance< GUM_SCALAR > *i)
	Private getter over evidences, if necessary creates an EMap for i.
using	EvidenceIterator
	Code alias.
using	EvidenceConstIterator
	Code alias.

Protected members.
virtual void	evidenceAdded_ (const Chain &chain)=0
	This method is called whenever an evidence is added, but AFTER any processing made by PRMInference.
virtual void	evidenceRemoved_ (const Chain &chain)=0
	This method is called whenever an evidence is removed, but BEFORE any processing made by PRMInference.
virtual void	posterior_ (const Chain &chain, Tensor< GUM_SCALAR > &m)=0
	Generic method to compute the posterior of given element.
virtual void	joint_ (const std::vector< Chain > &queries, Tensor< GUM_SCALAR > &j)=0
	Generic method to compute the posterior of given element.
PRM< GUM_SCALAR > const *	prm_
	The PRM<GUM_SCALAR> on which inference is done.
PRMSystem< GUM_SCALAR > const *	sys_
	The Model on which inference is done.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::prm::GroundedInference< GUM_SCALAR >

<agrum/PRM/groundedInference.h>

This class is used to realise grounded inference in a PRM<GUM_SCALAR>.

The best way to build this class is to use the static creation methods.

Definition at line 66 of file groundedInference.h.

Member Typedef Documentation

Chain

template<GUM_Numeric GUM_SCALAR>

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

inherited

Code alias.

Definition at line 71 of file PRMInference.h.

EMap

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInference< GUM_SCALAR >::EMap = NodeProperty< const Tensor< GUM_SCALAR >* >

inherited

Code alias.

Definition at line 74 of file PRMInference.h.

EMapConstIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInference< GUM_SCALAR >::EMapConstIterator

inherited

Initial value:

 
typename NodeProperty< const Tensor< GUM_SCALAR >* >::const_iterator_safe

Code alias.

Definition at line 80 of file PRMInference.h.

EMapIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInference< GUM_SCALAR >::EMapIterator = typename NodeProperty< const Tensor< GUM_SCALAR >* >::iterator_safe

inherited

Code alias.

Definition at line 77 of file PRMInference.h.

EvidenceConstIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInference< GUM_SCALAR >::EvidenceConstIterator

privateinherited

Initial value:

 
typename HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::const_iterator_safe

Code alias.

Definition at line 241 of file PRMInference.h.

EvidenceIterator

template<GUM_Numeric GUM_SCALAR>

using gum::prm::PRMInference< GUM_SCALAR >::EvidenceIterator

privateinherited

Initial value:

 
typename HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::iterator_safe

Code alias.

Definition at line 238 of file PRMInference.h.

Constructor & Destructor Documentation

GroundedInference() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

Default constructor.

Definition at line 108 of file groundedInference_tpl.h.

                                                                                              :
        PRMInference< GUM_SCALAR >(prm, system), _inf_(0) {
      GUM_CONSTRUCTOR(GroundedInference);
    }

References GroundedInference(), gum::prm::PRMInference< GUM_SCALAR >::PRMInference(), and _inf_.

Referenced by GroundedInference(), GroundedInference(), ~GroundedInference(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

~GroundedInference()

template<GUM_Numeric GUM_SCALAR>

gum::prm::GroundedInference< GUM_SCALAR >::~GroundedInference ( )

override

Destructor.

Definition at line 57 of file groundedInference_tpl.h.

                                                        {
      GUM_DESTRUCTOR(GroundedInference);
 
      if (_inf_ != nullptr) delete _inf_;
 
      if (!_obs_.empty())
        for (const auto pot: _obs_)
          // We used const ptrs only because of
          // MarginalTargetedInference::addEvidence()
          // requires it
          delete const_cast< Tensor< GUM_SCALAR >* >(pot);
    }

References GroundedInference(), _inf_, and _obs_.

Here is the call graph for this function:

GroundedInference() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

private

Copy constructor.

Definition at line 115 of file groundedInference_tpl.h.

                                                       :
        PRMInference< GUM_SCALAR >(source), _inf_(0) {
      GUM_CONS_CPY(GroundedInference);
      GUM_ERROR(FatalError, "illegal to copy constructor")
    }

References GroundedInference(), gum::prm::PRMInference< GUM_SCALAR >::PRMInference(), _inf_, and GUM_ERROR.

Here is the call graph for this function:

Member Function Documentation

_EMap_()

template<GUM_Numeric GUM_SCALAR>

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

privateinherited

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

Definition at line 117 of file PRMInference_tpl.h.

                                                                             {
      if (auto p = _evidences_.tryGet(i)) {
        return **p;
      } else {
        auto* emap = new PRMInference< GUM_SCALAR >::EMap();
        _evidences_.insert(i, emap);
        return *emap;
      }
    }

References _evidences_.

Referenced by removeEvidence().

Here is the caller graph for this function:

addEvidence()

template<GUM_Numeric GUM_SCALAR>

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

inherited

Add an evidence to the given instance's elt.

Parameters

chain	The variable being observed.
p	The Tensor 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 128 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.")
 
        Tensor< GUM_SCALAR >* e = new Tensor< 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>.");
      }
    }

References gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

clearEvidence()

template<GUM_Numeric GUM_SCALAR>

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

inherited

Remove all evidences.

Definition at line 57 of file PRMInference_tpl.h.

                                                   {
      for (const auto& elt: _evidences_) {
        for (const auto& elt2: *elt.second)
          delete elt2.second;
 
        delete elt.second;
      }
 
      _evidences_.clear();
    }

References _evidences_.

Referenced by ~PRMInference(), and operator=().

Here is the caller graph for this function:

evidence() [1/4]

template<GUM_Numeric GUM_SCALAR>

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

                                                                               {
      if (!_evidences_.exists(&i)) GUM_ERROR(NotFound, "this instance has no evidence.")
      return *(_evidences_[&i]);
    }

References _evidences_, and GUM_ERROR.

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesWithEvidence_(), gum::prm::SVE< GUM_SCALAR >::_insertEvidence_(), gum::prm::SVED< GUM_SCALAR >::_insertEvidence_(), gum::prm::StructuredInference< GUM_SCALAR >::_reduceAloneInstances_(), evidence(), gum::prm::GroundedInference< GUM_SCALAR >::evidenceAdded_(), hasEvidence(), posterior(), and gum::prm::StructuredInference< GUM_SCALAR >::posterior_().

Here is the caller graph for this function:

evidence() [2/4]

template<GUM_Numeric GUM_SCALAR>

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

                                                                                     {
      if (!_evidences_.exists(&i)) GUM_ERROR(NotFound, "this instance has no evidence.")
      return *(_evidences_[&i]);
    }

References _evidences_, and GUM_ERROR.

evidence() [3/4]

template<GUM_Numeric GUM_SCALAR>

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

                                                                               {
      if (!_evidences_.exists(i)) GUM_ERROR(NotFound, "this instance has no evidence.")
      return *(_evidences_[i]);
    }

References PRMInference(), _evidences_, evidence(), and GUM_ERROR.

Here is the call graph for this function:

evidence() [4/4]

template<GUM_Numeric GUM_SCALAR>

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

                                                                                     {
      if (!_evidences_.exists(i)) GUM_ERROR(NotFound, "this instance has no evidence.")
      return *(_evidences_[i]);
    }

References _evidences_, and GUM_ERROR.

evidenceAdded_() [1/2]

template<GUM_Numeric GUM_SCALAR>

void gum::prm::GroundedInference< GUM_SCALAR >::evidenceAdded_ ( const typename PRMInference< GUM_SCALAR >::Chain & chain )

overrideprotected

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

Definition at line 71 of file groundedInference_tpl.h.

                                                               {
      Tensor< GUM_SCALAR >* bn_obs = new Tensor< GUM_SCALAR >();
      // Retrieving the BN's variable
      auto var_name = std::format("{}.{}", chain.first->name(), chain.second->safeName());
      bn_obs->add(_inf_->BN().variableFromName(var_name));
      // Retrievin the PRM<GUM_SCALAR>'s evidence and copying it in bn_obs
      const Tensor< GUM_SCALAR >* prm_obs = this->evidence(chain.first)[chain.second->id()];
      Instantiation               i(*bn_obs), j(*prm_obs);
 
      for (i.setFirst(), j.setFirst(); !i.end(); i.inc(), j.inc()) {
        bn_obs->set(i, prm_obs->get(j));
      }
 
      _obs_.insert(bn_obs);
    }

References _inf_, _obs_, gum::prm::PRMInference< GUM_SCALAR >::evidence(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

evidenceAdded_() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

protectedpure virtualinherited

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_() [1/2]

template<GUM_Numeric GUM_SCALAR>

void gum::prm::GroundedInference< GUM_SCALAR >::evidenceRemoved_ ( const typename PRMInference< GUM_SCALAR >::Chain & chain )

overrideprotected

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

Definition at line 89 of file groundedInference_tpl.h.

                                                               {
      std::stringstream var_name;
      var_name << chain.first->name() << "." << chain.second->safeName();
      const DiscreteVariable& var = _inf_->BN().variableFromName(var_name.str());
 
      for (auto iter = _obs_.beginSafe(); iter != _obs_.endSafe();
           ++iter) {   // safe iterator needed here
        if ((**iter).contains(var)) {
          _inf_->eraseEvidence(var_name.str());
          const Tensor< GUM_SCALAR >* e = *iter;
          _obs_.erase(iter);
          delete e;
          break;
        }
      }
    }

References _inf_, and _obs_.

evidenceRemoved_() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

protectedpure virtualinherited

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 >.

Referenced by removeEvidence().

Here is the caller graph for this function:

getBNInference()

template<GUM_Numeric GUM_SCALAR>

MarginalTargetedInference< GUM_SCALAR > & gum::prm::GroundedInference< GUM_SCALAR >::getBNInference

(

)

Returns the bayesnet inference engine used by this class.

Returns

the bayesnet inference engine used by this class.

Exceptions

NotFound

Raised if no inference engine have been defined for this class.

Definition at line 129 of file groundedInference_tpl.h.

                                                                                             {
      if (_inf_ != 0) {
        return *_inf_;
      } else {
        GUM_ERROR(NotFound, "the inference engine is not yet defined")
      }
    }

References _inf_, and GUM_ERROR.

hasEvidence() [1/4]

template<GUM_Numeric GUM_SCALAR>

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

inherited

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

Definition at line 215 of file PRMInference_tpl.h.

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

References _evidences_.

hasEvidence() [2/4]

template<GUM_Numeric GUM_SCALAR>

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

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

References evidence(), and hasEvidence().

Here is the call graph for this function:

hasEvidence() [3/4]

template<GUM_Numeric GUM_SCALAR>

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

inherited

Returns true if i has evidence.

Definition at line 200 of file PRMInference_tpl.h.

                                                                                         {
      return _evidences_.exists(&i);
    }

References _evidences_.

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodes_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesDownward_(), gum::prm::SVED< GUM_SCALAR >::_eliminateNodesUpward_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::prm::StructuredInference< GUM_SCALAR >::_reduceAloneInstances_(), gum::prm::SVE< GUM_SCALAR >::_variableElimination_(), hasEvidence(), posterior(), gum::prm::StructuredInference< GUM_SCALAR >::posterior_(), and removeEvidence().

Here is the caller graph for this function:

hasEvidence() [4/4]

template<GUM_Numeric GUM_SCALAR>

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

inherited

Returns EMap of evidences over i.

Definition at line 205 of file PRMInference_tpl.h.

                                                                                         {
      return _evidences_.exists(i);
    }

References _evidences_.

joint()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInference< GUM_SCALAR >::joint ( const std::vector< Chain > & chains, Tensor< 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 257 of file PRMInference_tpl.h.

                                                                            {
      if (j.nbrDim() > 0) { GUM_ERROR(OperationNotAllowed, "the given Tensor is not empty.") }
 
      for (auto chain = chains.begin(); chain != chains.end(); ++chain) {
        j.add(chain->second->type().variable());
      }
 
      joint_(chains, j);
    }

References GUM_ERROR, and joint_().

Here is the call graph for this function:

joint_() [1/2]

template<GUM_Numeric GUM_SCALAR>

void gum::prm::GroundedInference< GUM_SCALAR >::joint_ ( const std::vector< typename PRMInference< GUM_SCALAR >::Chain > & queries, Tensor< GUM_SCALAR > & j )

overrideprotected

Generic method to compute the marginal of given element.

Parameters

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

Definition at line 166 of file groundedInference_tpl.h.

                                                                            {
      GUM_ERROR(FatalError, "not yet implemented")
    }

References GUM_ERROR.

joint_() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

protectedpure virtualinherited

Generic method to compute the posterior 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 >.

Referenced by joint().

Here is the caller graph for this function:

name()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

Returns the bayesnet inference engine used by this class.

Returns

the bayesnet inference engine used by this class.

Exceptions

NotFound

Raised if no inference engine have been defined for this class.

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

Definition at line 173 of file groundedInference_tpl.h.

                                                          {
      return "grounded inference";
    }

operator=()

template<GUM_Numeric GUM_SCALAR>

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

private

Copy operator.

Definition at line 124 of file groundedInference_tpl.h.

                                                                                              {
      GUM_ERROR(FatalError, "illegal call to copy operator")
    }

References GroundedInference(), and GUM_ERROR.

Here is the call graph for this function:

posterior()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMInference< GUM_SCALAR >::posterior ( const Chain & chain, Tensor< 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 231 of file PRMInference_tpl.h.

                                                             {
      if (m.nbrDim() > 0) { GUM_ERROR(OperationNotAllowed, "the given Tensor is not empty.") }
 
      if (hasEvidence(chain)) {
        m.add(chain.second->type().variable());
        const Tensor< 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);
        }
      }
    }

References gum::prm::PRMInstance< GUM_SCALAR >::end(), evidence(), GUM_ERROR, hasEvidence(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

posterior_() [1/2]

template<GUM_Numeric GUM_SCALAR>

void gum::prm::GroundedInference< GUM_SCALAR >::posterior_ ( const typename PRMInference< GUM_SCALAR >::Chain & chain, Tensor< GUM_SCALAR > & m )

overrideprotected

Generic method to compute the marginal of given element.

Parameters

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

Definition at line 146 of file groundedInference_tpl.h.

                                                             {
      if (_inf_ == 0) { GUM_ERROR(OperationNotAllowed, "no inference engine defined") }
 
      std::stringstream sBuff;
 
      if (!_obs_.empty()) {
        for (auto e: _obs_) {
          try {
            _inf_->addEvidence(*e);
          } catch (InvalidArgument const&) { _inf_->chgEvidence(*e); }
        }
      }
 
      sBuff << chain.first->name() << "." << chain.second->safeName();
      m = _inf_->posterior(_inf_->BN().idFromName(sBuff.str()));
    }

References _inf_, _obs_, and GUM_ERROR.

posterior_() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

protectedpure virtualinherited

Generic method to compute the posterior of given element.

Parameters

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

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

removeEvidence()

template<GUM_Numeric GUM_SCALAR>

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

                                                                      {
      if (hasEvidence(chain.first)) {
        if (_EMap_(chain.first).exists(chain.second->id())) {
          evidenceRemoved_(chain);
          delete _EMap_(chain.first)[chain.second->id()];
          _EMap_(chain.first).erase(chain.second->id());
        }
      }
    }

References _EMap_(), evidenceRemoved_(), and hasEvidence().

Here is the call graph for this function:

setBNInference()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::GroundedInference< GUM_SCALAR >::setBNInference

(

MarginalTargetedInference< GUM_SCALAR > *

bn_inf

)

Defines the bayesnet inference engine used by this class.

The inference engine is given to this class, it will be deleted when ~GroundedInference() is called.

Parameters

bn_inf

The bayesnet inference engine used by this class.

Exceptions

OperationNotAllowed

If bn_inf does not inference over the SystemBayesNet of this class.

Todo

MarginalTargetedInference should have copy constructors.

Definition at line 138 of file groundedInference_tpl.h.

                                                         {
      if (_inf_ != 0) { delete _inf_; }
 
      _inf_ = bn_inf;
    }

References _inf_.

Member Data Documentation

_evidences_

template<GUM_Numeric GUM_SCALAR>

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

privateinherited

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

Definition at line 245 of file PRMInference.h.

Referenced by PRMInference(), _EMap_(), clearEvidence(), evidence(), evidence(), evidence(), evidence(), hasEvidence(), hasEvidence(), and hasEvidence().

_inf_

template<GUM_Numeric GUM_SCALAR>

MarginalTargetedInference< GUM_SCALAR >* gum::prm::GroundedInference< GUM_SCALAR >::_inf_

private

The bayesnet inference engine used by this class.

Definition at line 148 of file groundedInference.h.

Referenced by GroundedInference(), GroundedInference(), ~GroundedInference(), evidenceAdded_(), evidenceRemoved_(), getBNInference(), posterior_(), and setBNInference().

_obs_

template<GUM_Numeric GUM_SCALAR>

List< const Tensor< GUM_SCALAR >* > gum::prm::GroundedInference< GUM_SCALAR >::_obs_

private

Definition at line 150 of file groundedInference.h.

Referenced by ~GroundedInference(), evidenceAdded_(), evidenceRemoved_(), and posterior_().

prm_

template<GUM_Numeric 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 224 of file PRMInference.h.

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

sys_

template<GUM_Numeric GUM_SCALAR>

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

protectedinherited

The Model on which inference is done.

Definition at line 227 of file PRMInference.h.

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

---

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

• agrum/PRM/inference/groundedInference.h
• agrum/PRM/inference/groundedInference_tpl.h