aGrUM  0.13.2
gum::prm::PRMInference< GUM_SCALAR > Class Template Referenceabstract

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...
 
PRMInferenceoperator= (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.
EMapevidence (const PRMInstance< GUM_SCALAR > &i)
 Returns EMap of evidences over i. More...
 
EMapevidence (const PRMInstance< GUM_SCALAR > *i)
 Returns EMap of evidences over i. More...
 
const EMapevidence (const PRMInstance< GUM_SCALAR > &i) const
 Returns EMap of evidences over i. More...
 
const EMapevidence (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

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.

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.

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.

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.

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.

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

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.

139  :
140  _prm(&prm),
141  _sys(&system) {
142  GUM_CONSTRUCTOR(PRMInference);
143  }
PRMInference(const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
Default constructor.
PRM< GUM_SCALAR > const * _prm
The PRM<GUM_SCALAR> on which inference is done.
Definition: PRMInference.h:210
PRMSystem< GUM_SCALAR > const * _sys
The Model on which inference is done.
Definition: PRMInference.h:213
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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, gum::MultiDimDecorator< GUM_SCALAR >::add(), gum::Instantiation::end(), gum::Instantiation::inc(), gum::prm::PRMInference< GUM_SCALAR >::operator=(), gum::MultiDimDecorator< GUM_SCALAR >::set(), and gum::Instantiation::setFirst().

46  :
47  _prm(source._prm),
48  _sys(source._sys) {
49  GUM_CONS_CPY(PRMInference);
50 
51  for (const auto& elt : source.__evidences) {
52  __evidences.insert(elt.first, new PRMInference< GUM_SCALAR >::EMap());
53 
54  for (const auto& elt2 : *elt.second) {
55  Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
56  e->add(*(elt2.second->variablesSequence().front()));
57  Instantiation i(*e);
58 
59  for (i.setFirst(); !i.end(); i.inc())
60  e->set(i, elt2.second->get(i));
61 
62  __evidences[elt.first]->insert(elt2.first, e);
63  }
64  }
65  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
PRMInference(const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
Default constructor.
PRM< GUM_SCALAR > const * _prm
The PRM<GUM_SCALAR> on which inference is done.
Definition: PRMInference.h:210
PRMSystem< GUM_SCALAR > const * _sys
The Model on which inference is done.
Definition: PRMInference.h:213
NodeProperty< const Potential< GUM_SCALAR > * > EMap
Code alias.
Definition: PRMInference.h:57

+ Here is the call graph for this function:

template<typename GUM_SCALAR >
INLINE gum::prm::PRMInference< GUM_SCALAR >::~PRMInference ( )
virtual

Destructor.

Definition at line 146 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::clearEvidence().

146  {
147  GUM_DESTRUCTOR(PRMInference);
148  clearEvidence();
149  }
PRMInference(const PRM< GUM_SCALAR > &prm, const PRMSystem< GUM_SCALAR > &system)
Default constructor.
void clearEvidence()
Remove all evidences.

+ Here is the call graph for this function:

Member Function Documentation

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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences.

Referenced by gum::prm::PRMInference< GUM_SCALAR >::addEvidence(), and gum::prm::PRMInference< GUM_SCALAR >::removeEvidence().

95  {
96  if (__evidences.exists(i)) {
97  return *(__evidences[i]);
98  } else {
100  return *(__evidences[i]);
101  }
102  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
NodeProperty< const Potential< GUM_SCALAR > * > EMap
Code alias.
Definition: PRMInference.h:57

+ Here is the caller graph for this function:

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

Referenced by gum::prm::PRMInference< GUM_SCALAR >::addEvidence().

+ Here is the caller graph for this function:

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

Referenced by gum::prm::PRMInference< GUM_SCALAR >::removeEvidence().

+ Here is the caller graph for this function:

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
queriesSet of pairs of PRMInstance<GUM_SCALAR> and PRMAttribute<GUM_SCALAR>.
jCPF 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 gum::prm::PRMInference< GUM_SCALAR >::joint().

+ Here is the caller graph for this function:

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
mCPF filled with the marginal of elt. It is initialized properly.

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

Referenced by gum::prm::PRMInference< GUM_SCALAR >::marginal().

+ Here is the caller graph for this function:

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
chainThe variable being observed.
pThe Potential added (by copy) as evidence.
Exceptions
NotFoundRaised if elt does not belong to i.
OperationNotAllowedRaised if p is inconsistent with elt.

Definition at line 106 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__EMap(), gum::prm::PRMInference< GUM_SCALAR >::_evidenceAdded(), gum::MultiDimDecorator< GUM_SCALAR >::add(), gum::MultiDimDecorator< GUM_SCALAR >::contains(), gum::Instantiation::end(), gum::HashTable< Key, Val, Alloc >::exists(), gum::MultiDimDecorator< GUM_SCALAR >::get(), GUM_ERROR, gum::Instantiation::inc(), gum::HashTable< Key, Val, Alloc >::insert(), gum::MultiDimDecorator< GUM_SCALAR >::nbrDim(), gum::MultiDimDecorator< GUM_SCALAR >::set(), and gum::Instantiation::setFirst().

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

107  {
108  if (chain.first->exists(chain.second->id())) {
109  if ((p.nbrDim() != 1) || (!p.contains(chain.second->type().variable())))
110  GUM_ERROR(OperationNotAllowed,
111  "illegal evidence for the given PRMAttribute.");
112 
113  Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
114  e->add(chain.second->type().variable());
115  Instantiation i(*e);
116 
117  for (i.setFirst(); !i.end(); i.inc())
118  e->set(i, p.get(i));
119 
120  PRMInference< GUM_SCALAR >::EMap& emap = __EMap(chain.first);
121 
122  if (emap.exists(chain.second->id())) {
123  delete emap[chain.second->id()];
124  emap[chain.second->id()] = e;
125  } else {
126  emap.insert(chain.second->id(), e);
127  }
128 
129  _evidenceAdded(chain);
130  } else {
131  GUM_ERROR(NotFound,
132  "the given PRMAttribute does not belong to this "
133  "Instance<GUM_SCALAR>.");
134  }
135  }
virtual void _evidenceAdded(const Chain &chain)=0
This method is called whenever an evidence is added, but AFTER any processing made by PRMInference...
EMap & __EMap(const PRMInstance< GUM_SCALAR > *i)
Private getter over __evidences, if necessary creates an EMap for i.
NodeProperty< const Potential< GUM_SCALAR > * > EMap
Code alias.
Definition: PRMInference.h:57
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Remove all evidences.

Definition at line 33 of file PRMInference_tpl.h.

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

33  {
34  for (const auto& elt : __evidences) {
35  for (const auto& elt2 : *elt.second)
36  delete elt2.second;
37 
38  delete elt.second;
39  }
40 
41  __evidences.clear();
42  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232

+ Here is the caller graph for this function:

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
NotFoundif i has no evidence.

Definition at line 153 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, and GUM_ERROR.

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

153  {
154  try {
155  return *(__evidences[&i]);
156  } catch (NotFound&) {
157  GUM_ERROR(NotFound, "this instance has no evidence.");
158  }
159  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the caller graph for this function:

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
NotFoundif i has no evidence.

Definition at line 174 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, and GUM_ERROR.

174  {
175  try {
176  return *(__evidences[i]);
177  } catch (NotFound&) {
178  GUM_ERROR(NotFound, "this instance has no evidence.");
179  }
180  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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
NotFoundif i has no evidence.

Definition at line 163 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, and GUM_ERROR.

164  {
165  try {
166  return *(__evidences[&i]);
167  } catch (NotFound&) {
168  GUM_ERROR(NotFound, "this instance has no evidence.");
169  }
170  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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
NotFoundif i has no evidence.

Definition at line 184 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, and GUM_ERROR.

185  {
186  try {
187  return *(__evidences[i]);
188  } catch (NotFound&) {
189  GUM_ERROR(NotFound, "this instance has no evidence.");
190  }
191  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66
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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences.

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

195  {
196  return __evidences.exists(&i);
197  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232

+ Here is the caller graph for this function:

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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences.

201  {
202  return __evidences.exists(i);
203  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
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.

References gum::prm::PRMInference< GUM_SCALAR >::evidence(), gum::HashTable< Key, Val, Alloc >::exists(), and gum::prm::PRMInference< GUM_SCALAR >::hasEvidence().

206  {
207  return (hasEvidence(chain.first))
208  ? evidence(chain.first).exists(chain.second->id())
209  : false;
210  }
bool hasEvidence() const
Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.
EMap & evidence(const PRMInstance< GUM_SCALAR > &i)
Returns EMap of evidences over i.
bool exists(const Key &key) const
Checks whether there exists an element with a given key in the hashtable.

+ Here is the call graph for this function:

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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences.

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

213  {
214  return (__evidences.size() != (Size)0);
215  }
unsigned long Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:50
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232

+ Here is the caller graph for this function:

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
chainsA Set of strings of the form instance.attribute.
jAn empty CPF which will be filed by the joint probability over chains.
Exceptions
NotFoundRaised if some chain in chains does not point to a formal attribute.
OperationNotAllowedRaise if m is not empty.

Definition at line 260 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::_joint(), gum::MultiDimDecorator< GUM_SCALAR >::add(), GUM_ERROR, and gum::MultiDimDecorator< GUM_SCALAR >::nbrDim().

262  {
263  if (j.nbrDim() > 0) {
264  GUM_ERROR(OperationNotAllowed, "the given Potential is not empty.");
265  }
266 
267  for (auto chain = chains.begin(); chain != chains.end(); ++chain) {
268  j.add(chain->second->type().variable());
269  }
270 
271  _joint(chains, j);
272  }
virtual void _joint(const std::vector< Chain > &queries, Potential< GUM_SCALAR > &j)=0
Generic method to compute the marginal of given element.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

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
chainA string of the form instance.attribute.
mAn empty CPF which will be filed by the marginal of chain.
Exceptions
NotFoundRaised if chain is invalid.
WrongTypeRaised if chain does not point to an PRMAttribute<GUM_SCALAR>.
OperationNotAllowedRaise if m is not empty.

Definition at line 231 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::_marginal(), gum::MultiDimDecorator< GUM_SCALAR >::add(), gum::prm::PRMInference< GUM_SCALAR >::evidence(), gum::MultiDimDecorator< GUM_SCALAR >::get(), GUM_ERROR, gum::prm::PRMInference< GUM_SCALAR >::hasEvidence(), gum::Instantiation::inc(), gum::MultiDimDecorator< GUM_SCALAR >::nbrDim(), gum::MultiDimDecorator< GUM_SCALAR >::set(), and gum::Instantiation::setFirst().

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

233  {
234  if (m.nbrDim() > 0) {
235  GUM_ERROR(OperationNotAllowed, "the given Potential is not empty.");
236  }
237 
238  if (hasEvidence(chain)) {
239  m.add(chain.second->type().variable());
240  const Potential< GUM_SCALAR >& e =
241  *(evidence(chain.first)[chain.second->id()]);
242  Instantiation i(m), j(e);
243 
244  for (i.setFirst(), j.setFirst(); !i.end(); i.inc(), j.inc())
245  m.set(i, e.get(j));
246  } else {
247  if (chain.second != &(chain.first->get(chain.second->safeName()))) {
248  typename PRMInference< GUM_SCALAR >::Chain good_chain = std::make_pair(
249  chain.first, &(chain.first->get(chain.second->safeName())));
250  m.add(good_chain.second->type().variable());
251  _marginal(good_chain, m);
252  } else {
253  m.add(chain.second->type().variable());
254  _marginal(chain, m);
255  }
256  }
257  }
bool hasEvidence() const
Returns true if i has evidence on PRMAttribute<GUM_SCALAR> a.
EMap & evidence(const PRMInstance< GUM_SCALAR > &i)
Returns EMap of evidences over i.
virtual void _marginal(const Chain &chain, Potential< GUM_SCALAR > &m)=0
Generic method to compute the marginal of given element.
std::pair< const PRMInstance< GUM_SCALAR > *, const PRMAttribute< GUM_SCALAR > * > Chain
Code alias.
Definition: PRMInference.h:54
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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:

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.

References gum::prm::PRMInference< GUM_SCALAR >::__evidences, gum::prm::PRMInference< GUM_SCALAR >::_prm, gum::prm::PRMInference< GUM_SCALAR >::_sys, gum::MultiDimDecorator< GUM_SCALAR >::add(), gum::prm::PRMInference< GUM_SCALAR >::clearEvidence(), gum::Instantiation::end(), gum::Instantiation::inc(), gum::MultiDimDecorator< GUM_SCALAR >::set(), and gum::Instantiation::setFirst().

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

69  {
70  clearEvidence();
71  _prm = source._prm;
72  _sys = source._sys;
73 
74  for (const auto& elt : source.__evidences) {
75  __evidences.insert(elt.first, new PRMInference< GUM_SCALAR >::EMap());
76 
77  for (const auto& elt2 : *elt.second) {
78  Potential< GUM_SCALAR >* e = new Potential< GUM_SCALAR >();
79  e->add(*(elt2.second->variablesSequence().front()));
80  Instantiation i(*e);
81 
82  for (i.setFirst(); !i.end(); i.inc()) {
83  e->set(i, elt2.second->get(i));
84  }
85 
86  __evidences[elt.first]->insert(elt2.first, e);
87  }
88  }
89 
90  return *this;
91  }
HashTable< const PRMInstance< GUM_SCALAR > *, EMap * > __evidences
Mapping of evidence over PRMInstance<GUM_SCALAR>&#39;s nodes.
Definition: PRMInference.h:232
PRM< GUM_SCALAR > const * _prm
The PRM<GUM_SCALAR> on which inference is done.
Definition: PRMInference.h:210
void clearEvidence()
Remove all evidences.
PRMSystem< GUM_SCALAR > const * _sys
The Model on which inference is done.
Definition: PRMInference.h:213
NodeProperty< const Potential< GUM_SCALAR > * > EMap
Code alias.
Definition: PRMInference.h:57

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Remove evidence on the given instance's elt.

Parameters
chainThe variable being observed.
Exceptions
NotFoundRaised if the given names are not found.
WrongTypeRaised if the elt is not an PRMAttribute<GUM_SCALAR>.

Definition at line 218 of file PRMInference_tpl.h.

References gum::prm::PRMInference< GUM_SCALAR >::__EMap(), gum::prm::PRMInference< GUM_SCALAR >::_evidenceRemoved(), gum::HashTable< Key, Val, Alloc >::erase(), and gum::HashTable< Key, Val, Alloc >::exists().

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

218  {
219  try {
220  if (__EMap(chain.first).exists(chain.second->id())) {
221  _evidenceRemoved(chain);
222  delete __EMap(chain.first)[chain.second->id()];
223  __EMap(chain.first).erase(chain.second->id());
224  }
225  } catch (NotFound&) {
226  // Ok, we are only removing
227  }
228  }
void erase(const Key &key)
Removes a given element from the hash table.
bool exists(const Key &key) const
Checks whether there exists an element with a given key in the hashtable.
virtual void _evidenceRemoved(const Chain &chain)=0
This method is called whenever an evidence is removed, but BEFORE any processing made by PRMInference...
EMap & __EMap(const PRMInstance< GUM_SCALAR > *i)
Private getter over __evidences, if necessary creates an EMap for i.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

template<typename GUM_SCALAR>
HashTable< const PRMInstance< GUM_SCALAR >*, EMap* > gum::prm::PRMInference< GUM_SCALAR >::__evidences
private
template<typename GUM_SCALAR>
PRM< GUM_SCALAR > const* gum::prm::PRMInference< GUM_SCALAR >::_prm
protected

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