aGrUM  0.18.1
a C++ library for (probabilistic) graphical models
gum::prm::PRMInstance< GUM_SCALAR > Class Template Reference

An PRMInstance is a Bayesian Network fragment defined by a Class and used in a PRMSystem. More...

#include <PRMInstance.h>

+ Inheritance diagram for gum::prm::PRMInstance< GUM_SCALAR >:
+ Collaboration diagram for gum::prm::PRMInstance< GUM_SCALAR >:

Public Member Functions

Constructors & private operators.
 PRMInstance (const std::string &name, PRMClass< GUM_SCALAR > &type)
 Default constructor of an PRMInstance<GUM_SCALAR>. More...
 
virtual ~PRMInstance ()
 Destructor. More...
 
Getters & setters.
virtual prm_type obj_type () const
 Returns the PRM type of this object. More...
 
PRMClass< GUM_SCALAR > & type ()
 Returns the type of this instance. More...
 
const PRMClass< GUM_SCALAR > & type () const
 Returns the type of this instance. More...
 
bool exists (NodeId id) const
 Returns true if id matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
bool exists (const std::string &name) const
 Returns true if name matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
PRMAttribute< GUM_SCALAR > & get (NodeId id)
 Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
 
PRMAttribute< GUM_SCALAR > & get (const std::string &name)
 Given a name returns the related PRMAttribute<GUM_SCALAR>. More...
 
const PRMAttribute< GUM_SCALAR > & get (NodeId id) const
 Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
 
const PRMAttribute< GUM_SCALAR > & get (const std::string &name) const
 Given a name returns the related PRMClassElement. More...
 
Size size () const
 Returns the number of attributes in this PRMInstance<GUM_SCALAR>. More...
 
Instantiation methods.
void instantiate ()
 Instantiate all nodes which requires it. More...
 
const Bijection< const DiscreteVariable *, const DiscreteVariable *> & bijection () const
 Returns a mapping between DiscreteVariable used in this and the ones used in this PRMInstance<GUM_SCALAR>'s Class<GUM_SCALAR>. More...
 
Reference handling.
void add (NodeId id, PRMInstance< GUM_SCALAR > &instance)
 Add an PRMInstance<GUM_SCALAR> to a given PRMReferenceSlot, PRMSlotChain<GUM_SCALAR> or output node. More...
 
const PRMInstance< GUM_SCALAR > & getInstance (NodeId id) const
 Fast access to the first instance in a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>. More...
 
const Set< PRMInstance< GUM_SCALAR > *> & getInstances (NodeId id) const
 Returns the Set of PRMInstance<GUM_SCALAR> referenced by id. More...
 
bool hasRefAttr (NodeId id) const
 Returns true if id has at least one referring PRMAttribute<GUM_SCALAR>. More...
 
std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & getRefAttr (NodeId id)
 Returns a vector of pairs of refering attributes of id. More...
 
const std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & getRefAttr (NodeId id) const
 Returns a vector of pairs of refering attributes of id. More...
 
Getters & setters.
const std::string & name () const
 Returns the name of this object. More...
 
void name (const std::string &name)
 Change the name of the PRM Object. More...
 
Operators
bool operator== (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique). More...
 
bool operator!= (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique). More...
 

Classes

class  RefConstIterator
 Nested class to iterate over PRMReferenceSlot and PRMSlotChain<GUM_SCALAR> instantiations. More...
 
class  RefIterator
 Nested class to iterate over PRMReferenceSlot and PRMSlotChain<GUM_SCALAR> instantiations. More...
 

Iterators

typedef NodeProperty< PRMAttribute< GUM_SCALAR > *>::iterator iterator
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
typedef NodeProperty< PRMAttribute< GUM_SCALAR > *>::const_iterator const_iterator
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > *>::iterator InvRefIterator
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > *>::const_iterator InvRefConstIterator
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
iterator begin ()
 Returns an iterator at the begining of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
const iteratorend ()
 Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
const_iterator begin () const
 Returns an iterator at the beginning of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
const const_iteratorend () const
 Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
RefIterator begin (NodeId id)
 Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>. More...
 
RefConstIterator begin (NodeId id) const
 Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>. More...
 
InvRefIterator beginInvRef ()
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
const InvRefIteratorendInvRef ()
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
InvRefConstIterator beginInvRef () const
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 
const InvRefConstIteratorendInvRef () const
 Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>. More...
 

Private members.

typedef std::pair< PRMInstance< GUM_SCALAR > *, std::string > pair
 Code alias. More...
 
bool instantiated__
 True if this instance has been instantiated. More...
 
PRMClass< GUM_SCALAR > * type__
 The type of this PRMInstance<GUM_SCALAR>. More...
 
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
 The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>. More...
 
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
 Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and the PRMInstance<GUM_SCALAR> associated with it. More...
 
NodeProperty< std::vector< pair > *> referingAttr__
 The set of pair (instance, attribute) referring an attribute of this instance. More...
 
Bijection< const DiscreteVariable *, const DiscreteVariable *> bijection__
 A bijection used for MultiDim handling. More...
 

Built-in types.

enum  prm_type : char {
  prm_type::ALL, prm_type::CLASS, prm_type::PRM_INTERFACE, prm_type::CLASS_ELT,
  prm_type::TYPE, prm_type::SYSTEM, prm_type::INSTANCE
}
 Enumeration of the different types of objects handled by a PRM. More...
 
static std::string LEFT_CAST ()
 Enumeration of the different types of objects handled by a PRM. More...
 
static std::string RIGHT_CAST ()
 Enumeration of the different types of objects handled by a PRM. More...
 
static std::string enum2str (prm_type type)
 Returns the string representation of a PRMObject. More...
 
static INLINE bool isClass (const PRMObject &obj)
 Returns true if obj_ptr is of type Class. More...
 
static INLINE bool isInterface (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInterface. More...
 
static INLINE bool isInstance (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInstance. More...
 

Detailed Description

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

An PRMInstance is a Bayesian Network fragment defined by a Class and used in a PRMSystem.

Before using an PRMInstance for inference YOU MUST call PRMInstance::instantiateSlotChains() and PRMInstance::instantiate() on it before, otherwise DiscreteVariable pointers will be inconsistent and inference will be erroneous. Of course, this must be done once you have set all reference in the current system.

See also
PRMClass PRM PRMClassElement

Definition at line 63 of file PRMInstance.h.

Member Typedef Documentation

◆ const_iterator

template<typename GUM_SCALAR>
typedef NodeProperty< PRMAttribute< GUM_SCALAR >* >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::const_iterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 329 of file PRMInstance.h.

◆ InvRefConstIterator

template<typename GUM_SCALAR>
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::InvRefConstIterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 447 of file PRMInstance.h.

◆ InvRefIterator

template<typename GUM_SCALAR>
typedef NodeProperty< std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::iterator gum::prm::PRMInstance< GUM_SCALAR >::InvRefIterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 444 of file PRMInstance.h.

◆ iterator

template<typename GUM_SCALAR>
typedef NodeProperty< PRMAttribute< GUM_SCALAR >* >::iterator gum::prm::PRMInstance< GUM_SCALAR >::iterator

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 315 of file PRMInstance.h.

◆ pair

template<typename GUM_SCALAR>
typedef std::pair< PRMInstance< GUM_SCALAR >*, std::string > gum::prm::PRMInstance< GUM_SCALAR >::pair
private

Code alias.

Definition at line 522 of file PRMInstance.h.

Member Enumeration Documentation

◆ prm_type

enum gum::prm::PRMObject::prm_type : char
stronginherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Enumerator
ALL 
CLASS 
PRM_INTERFACE 
CLASS_ELT 
TYPE 
SYSTEM 
INSTANCE 

Definition at line 69 of file PRMObject.h.

69  : char {
70  ALL,
71  CLASS,
72  PRM_INTERFACE,
73  CLASS_ELT,
74  TYPE,
75  SYSTEM,
76  INSTANCE
77  };

Constructor & Destructor Documentation

◆ PRMInstance() [1/2]

template<typename GUM_SCALAR >
gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance ( const std::string &  name,
PRMClass< GUM_SCALAR > &  type 
)

Default constructor of an PRMInstance<GUM_SCALAR>.

When you create an PRMInstance<GUM_SCALAR> all gum::prm::PRMAttribute<GUM_SCALAR> in it's type are added, except for gum::prm::PRMAggregate<GUM_SCALAR> and parameters which are instantiated.

However neither of their children or parents are updated (i.e. DiscreteVariable pointers are inconsistent).

Definition at line 36 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::copyAggregates__(), gum::prm::PRMInstance< GUM_SCALAR >::copyAttribute__(), and gum::prm::PRMInstance< GUM_SCALAR >::type__.

37  :
38  PRMObject(name),
39  instantiated__(false), type__(&type) {
40  GUM_CONSTRUCTOR(PRMInstance);
41 
42  // First we create attributes for each aggregate in type
43  for (const auto agg: type__->aggregates())
44  copyAggregates__(agg);
45 
46  // We add attributes in type by reference for inner ones and by copy for
47  // output ones
48  for (const auto attr: type__->attributes())
49  copyAttribute__(attr);
50  }
void copyAggregates__(PRMAggregate< GUM_SCALAR > *source)
Used at construction to instantiate aggregates.
PRMInstance(const std::string &name, PRMClass< GUM_SCALAR > &type)
Default constructor of an PRMInstance<GUM_SCALAR>.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
bool instantiated__
True if this instance has been instantiated.
Definition: PRMInstance.h:507
PRMClass< GUM_SCALAR > * type__
The type of this PRMInstance<GUM_SCALAR>.
Definition: PRMInstance.h:510
void copyAttribute__(PRMAttribute< GUM_SCALAR > *source)
Used at construction to instantiate attributes.
PRMObject(const std::string &name)
Constructor.
Definition: PRMObject.cpp:43
+ Here is the call graph for this function:

◆ ~PRMInstance()

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

Destructor.

Definition at line 53 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__, and gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

53  {
54  GUM_DESTRUCTOR(PRMInstance);
55 
56  for (const auto& elt: nodeIdMap__)
57  delete elt.second;
58 
59  for (const auto& elt: referenceMap__)
60  delete elt.second;
61 
62  for (const auto& elt: referingAttr__)
63  delete elt.second;
64  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526
PRMInstance(const std::string &name, PRMClass< GUM_SCALAR > &type)
Default constructor of an PRMInstance<GUM_SCALAR>.
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519

◆ PRMInstance() [2/2]

template<typename GUM_SCALAR >
INLINE gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance ( const PRMInstance< GUM_SCALAR > &  source)
private

Copy constructor.

Definition at line 259 of file PRMInstance_tpl.h.

References GUM_ERROR.

260  :
261  PRMObject(source),
262  type__(source.type__) {
263  GUM_CONS_CPY(PRMInstance);
264  GUM_ERROR(FatalError, "do not copy Instance");
265  }
PRMInstance(const std::string &name, PRMClass< GUM_SCALAR > &type)
Default constructor of an PRMInstance<GUM_SCALAR>.
PRMClass< GUM_SCALAR > * type__
The type of this PRMInstance<GUM_SCALAR>.
Definition: PRMInstance.h:510
PRMObject(const std::string &name)
Constructor.
Definition: PRMObject.cpp:43
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55

Member Function Documentation

◆ add()

template<typename GUM_SCALAR >
void gum::prm::PRMInstance< GUM_SCALAR >::add ( NodeId  id,
PRMInstance< GUM_SCALAR > &  instance 
)

Add an PRMInstance<GUM_SCALAR> to a given PRMReferenceSlot, PRMSlotChain<GUM_SCALAR> or output node.

Three type of nodes can be associated with an PRMInstance<GUM_SCALAR>. When an PRMInstance<GUM_SCALAR> is associated with a PRMReferenceSlot, it represents an arc in the relational skeleton. For a PRMSlotChain<GUM_SCALAR>, it is a placeholder of referenced PRMClassElement by this PRMInstance<GUM_SCALAR>. Finally, for an output node it indicates that an PRMInstance<GUM_SCALAR> has an PRMClassElement referring it.

Parameters
idThe NodeId of a PRMReferenceSlot of this PRMInstance<GUM_SCALAR>.
instanceThe instance added as references by id in this PRMInstance<GUM_SCALAR>.
Exceptions
WrongClassElementRaised if id is not a valid PRMClassElement.
OutOfUpperBoundRaised if no more PRMInstance<GUM_SCALAR> can be added to id.
TypeErrorRaised if instance's type isn't compatible with the reference's type.
NotFoundIf there is no PRMClassElement given id.

Definition at line 157 of file PRMInstance_tpl.h.

References gum::prm::PRMClassElement< GUM_SCALAR >::elt_type(), gum::prm::PRMSlotChain< GUM_SCALAR >::end(), GUM_ERROR, gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__, gum::prm::PRMInstance< GUM_SCALAR >::size(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::slotType(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addInstance__().

158  {
159  PRMClassElement< GUM_SCALAR >* elt = 0;
160 
161  try {
162  elt = &(type().get(id));
163  } catch (NotFound&) {
164  GUM_ERROR(NotFound, "no ClassElement<GUM_SCALAR> matches the given id");
165  }
166 
167  switch (elt->elt_type()) {
169  PRMReferenceSlot< GUM_SCALAR >* ref =
170  static_cast< PRMReferenceSlot< GUM_SCALAR >* >(elt);
171 
172  // Checking if instance's type is legal
173  if (!instance.type().isSubTypeOf(ref->slotType())) {
174  GUM_ERROR(TypeError,
175  "given Instance type is not a proper "
176  "subclass of the ReferenceSlot<GUM_SCALAR> slot type");
177  }
178 
179  // Checking the reference's size limit
180  if (referenceMap__.exists(id)
181  && (!static_cast< PRMReferenceSlot< GUM_SCALAR >& >(type().get(id))
182  .isArray())
183  && (referenceMap__[id]->size() == 1)) {
184  GUM_ERROR(OutOfUpperBound,
185  "ReferenceSlot<GUM_SCALAR> size limit reached");
186  }
187 
188  break;
189  }
190 
192  PRMSlotChain< GUM_SCALAR >& sc =
193  static_cast< PRMSlotChain< GUM_SCALAR >& >(type().get(id));
194 
195  // Checking if instance's type is legal
196  if (!instance.type().isSubTypeOf(sc.end())) {
197  GUM_ERROR(TypeError,
198  "given Instance type is not a proper "
199  "subclass of the ClassElementContainer pointed"
200  " by the SlotChain<GUM_SCALAR>");
201  }
202 
203  // Checking the reference's size limit
204  if (referenceMap__.exists(id)
205  && (!static_cast< PRMSlotChain< GUM_SCALAR >& >(type().get(id))
206  .isMultiple())
207  && (referenceMap__[id]->size() == 1)) {
208  GUM_ERROR(OutOfUpperBound, "SlotChain<GUM_SCALAR> size limit reached");
209  }
210 
211  break;
212  }
213 
214  default: {
215  if (!type().isOutputNode(*elt)) {
216  GUM_ERROR(WrongClassElement,
217  "given ClassElement<GUM_SCALAR> is not an output node");
218  }
219  }
220  }
221 
222  if (!referenceMap__.exists(id)) {
223  referenceMap__.insert(id, new Set< PRMInstance< GUM_SCALAR >* >());
224  }
225 
226  referenceMap__[id]->insert(&instance);
227  }
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
Size size() const
Returns the number of attributes in this PRMInstance<GUM_SCALAR>.
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addReferingInstance__()

template<typename GUM_SCALAR >
INLINE void gum::prm::PRMInstance< GUM_SCALAR >::addReferingInstance__ ( PRMSlotChain< GUM_SCALAR > *  sc,
PRMInstance< GUM_SCALAR > *  i 
)
private

Add this as a referring instance over the attribute pointed by sc in i.

Parameters
scA slot chain pointing over an attribute in i.
iAn instance holding an attribute pointed by sc.

Definition at line 338 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt(), gum::prm::PRMObject::name(), gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__, and gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::instantiateSlotChain__().

339  {
340  NodeId id = i->get(sc->lastElt().safeName()).id();
341  std::string name = sc->lastElt().safeName();
342 
343  try {
344  i->referenceMap__[id]->insert(this);
345  i->referingAttr__[id]->push_back(
346  std::make_pair(this, sc->lastElt().safeName()));
347  } catch (NotFound&) {
348  i->referenceMap__.insert(id, new Set< PRMInstance< GUM_SCALAR >* >());
349  i->referenceMap__[id]->insert(this);
350  i->referingAttr__.insert(id, new std::vector< pair >());
351  i->referingAttr__[id]->push_back(
352  std::make_pair(this, sc->lastElt().safeName()));
353  }
354  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
Size NodeId
Type for node ids.
Definition: graphElements.h:98
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ begin() [1/4]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::iterator gum::prm::PRMInstance< GUM_SCALAR >::begin ( )

Returns an iterator at the begining of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 393 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

Referenced by gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__(), and gum::prm::StructuredInference< GUM_SCALAR >::searchPatterns().

393  {
394  return nodeIdMap__.begin();
395  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the caller graph for this function:

◆ begin() [2/4]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::const_iterator gum::prm::PRMInstance< GUM_SCALAR >::begin ( ) const

Returns an iterator at the beginning of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 405 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

405  {
406  return nodeIdMap__.begin();
407  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514

◆ begin() [3/4]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::RefIterator gum::prm::PRMInstance< GUM_SCALAR >::begin ( NodeId  id)

Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>.

Parameters
idA gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR> type.
Exceptions
NotFoundRaised if no gum::prm::PRMClassElement in this PRMInstance<GUM_SCALAR> type matches id.
WrongClassElementRaised if id is neither a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Definition at line 417 of file PRMInstance_tpl.h.

References GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__.

417  {
418  try {
419  return PRMInstance< GUM_SCALAR >::RefIterator(*(referenceMap__[id]));
420  } catch (NotFound&) {
421  GUM_ERROR(NotFound, "no referred instances from this NodeId");
422  }
423  }
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55

◆ begin() [4/4]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::RefConstIterator gum::prm::PRMInstance< GUM_SCALAR >::begin ( NodeId  id) const

Returns an iterator at the beginning of the set of PRMInstance<GUM_SCALAR> associated to a given gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR>.

Parameters
idA gum::prm::PRMReferenceSlot or gum::prm::PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR> type.
Exceptions
NotFoundRaised if no gum::prm::PRMClassElement in this PRMInstance<GUM_SCALAR> type matches id.
WrongClassElementRaised if id is neither a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Definition at line 427 of file PRMInstance_tpl.h.

References GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__.

427  {
428  try {
429  return PRMInstance< GUM_SCALAR >::RefConstIterator(*(referenceMap__[id]));
430  } catch (NotFound&) {
431  GUM_ERROR(NotFound, "no referred instances from this NodeId");
432  }
433  }
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55

◆ beginInvRef() [1/2]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::InvRefIterator gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef ( )

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 566 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

Referenced by gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesDownward__(), and gum::prm::SVE< GUM_SCALAR >::eliminateNodesUpward__().

566  {
567  return referingAttr__.begin();
568  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526
+ Here is the caller graph for this function:

◆ beginInvRef() [2/2]

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR >::InvRefConstIterator gum::prm::PRMInstance< GUM_SCALAR >::beginInvRef ( ) const

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 578 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

578  {
579  return referingAttr__.begin();
580  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526

◆ bijection()

template<typename GUM_SCALAR >
INLINE const Bijection< const DiscreteVariable *, const DiscreteVariable *> & gum::prm::PRMInstance< GUM_SCALAR >::bijection ( ) const

Returns a mapping between DiscreteVariable used in this and the ones used in this PRMInstance<GUM_SCALAR>'s Class<GUM_SCALAR>.

MultiDims require distinctive DiscreteVariable pointers, thus interface attributes are always instantiated to prevent multiple insertion of the same DiscreteVariable pointer in a MultiDim.

Returns
Returns a bijection in which first elements are DiscreteVariable in this->type() and the second are in this.

Definition at line 358 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::bijection__.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::copyAttributeCPF__(), gum::prm::SVED< GUM_SCALAR >::insertLiftedNodes__(), gum::prm::SVE< GUM_SCALAR >::insertLiftedNodes__(), and gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__().

358  {
359  return bijection__;
360  }
Bijection< const DiscreteVariable *, const DiscreteVariable *> bijection__
A bijection used for MultiDim handling.
Definition: PRMInstance.h:529
+ Here is the caller graph for this function:

◆ copyAggregates__()

template<typename GUM_SCALAR >
INLINE void gum::prm::PRMInstance< GUM_SCALAR >::copyAggregates__ ( PRMAggregate< GUM_SCALAR > *  source)
private

Used at construction to instantiate aggregates.

Definition at line 235 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::bijection__, gum::prm::PRMAggregate< GUM_SCALAR >::buildImpl(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, and gum::prm::PRMAggregate< GUM_SCALAR >::type().

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

236  {
237  auto attr = new PRMScalarAttribute< GUM_SCALAR >(
238  source->name(), source->type(), source->buildImpl());
239  GUM_ASSERT(&(attr->type().variable()) != &(source->type().variable()));
240  attr->setId(source->id());
241  nodeIdMap__.insert(attr->id(), attr);
242  bijection__.insert(&(source->type().variable()), &(attr->type().variable()));
243  }
Bijection< const DiscreteVariable *, const DiscreteVariable *> bijection__
A bijection used for MultiDim handling.
Definition: PRMInstance.h:529
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copyAttribute__()

template<typename GUM_SCALAR >
INLINE void gum::prm::PRMInstance< GUM_SCALAR >::copyAttribute__ ( PRMAttribute< GUM_SCALAR > *  source)
private

Used at construction to instantiate attributes.

Parameters
sourceAn attribute in type__.

Definition at line 246 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::bijection__, gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::prm::PRMObject::name(), gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, and gum::prm::PRMAttribute< GUM_SCALAR >::type().

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

247  {
248  auto attr =
249  new PRMScalarAttribute< GUM_SCALAR >(source->name(), source->type());
250  GUM_ASSERT(&(attr->type().variable()) != &(source->type().variable()));
251  // The potential is copied when instantiate() is called
252  attr->cpf().fill((GUM_SCALAR)0);
253  attr->setId(source->id());
254  bijection__.insert(&(source->type().variable()), &(attr->type().variable()));
255  nodeIdMap__.insert(attr->id(), attr);
256  }
Bijection< const DiscreteVariable *, const DiscreteVariable *> bijection__
A bijection used for MultiDim handling.
Definition: PRMInstance.h:529
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copyAttributeCPF__()

template<typename GUM_SCALAR >
INLINE void gum::prm::PRMInstance< GUM_SCALAR >::copyAttributeCPF__ ( PRMAttribute< GUM_SCALAR > *  attr)
private

Copy the content of an PRMAttribute<GUM_SCALAR> from its Class<GUM_SCALAR> counterpart.

Parameters
attrAn PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.
Exceptions
OperationNotAllowedIf the MultiDimImplementation is of an unknown type.

Definition at line 607 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::bijection(), gum::prm::PRMAttribute< GUM_SCALAR >::copyCpf(), gum::prm::PRMAttribute< GUM_SCALAR >::cpf(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName(), gum::prm::PRMAttribute< GUM_SCALAR >::type(), and gum::prm::PRMInstance< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__().

608  {
609  const auto& type_attr = static_cast< const PRMAttribute< GUM_SCALAR >& >(
610  type().get(attr->safeName()));
611  attr->copyCpf(bijection(), type_attr);
612  GUM_ASSERT(attr->cpf().contains(attr->type().variable()));
613  }
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
const Bijection< const DiscreteVariable *, const DiscreteVariable *> & bijection() const
Returns a mapping between DiscreteVariable used in this and the ones used in this PRMInstance<GUM_SCA...
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doInstantiate__()

template<typename GUM_SCALAR >
void gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__ ( )
private

Starts this instance instantiations.

Definition at line 75 of file PRMInstance_tpl.h.

References gum::prm::PRMAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMInstance< GUM_SCALAR >::copyAttributeCPF__(), gum::prm::PRMInstance< GUM_SCALAR >::getInstances(), gum::prm::PRMInstance< GUM_SCALAR >::instantiateSlotChain__(), gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, and gum::prm::PRMInstance< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::instantiate().

75  {
76  // First retrieving any referenced instance
77  for (const auto chain: type().slotChains()) {
79  }
80 
81  // Now we need to add referred instance to each input node
82  // For Attributes we first add parents, then we initialize CPF
83  for (const auto attr: type().attributes()) {
84  copyAttributeCPF__(nodeIdMap__[(*attr).id()]);
85  }
86 
87  // For PRMAggregate<GUM_SCALAR> we add parents
88  for (const auto agg: type().aggregates()) {
89  PRMAttribute< GUM_SCALAR >& attr = get(agg->safeName());
90 
91  for (const auto node: type().containerDag().parents(agg->id())) {
92  try {
93  attr.addParent(get(node));
94  } catch (NotFound&) {
95  auto elt = &(type().get(node));
96  auto sc = static_cast< PRMSlotChain< GUM_SCALAR >* >(elt);
97 
98  try {
99  const auto& instances = getInstances(sc->id());
100 
101  for (const auto inst: instances) {
102  attr.addParent(inst->get(sc->lastElt().safeName()));
103  }
104  } catch (NotFound&) { // there is no parents for this agg
105  }
106  }
107  }
108  }
109  }
void instantiateSlotChain__(PRMSlotChain< GUM_SCALAR > *sc)
Retrieve all instances referred by sc.
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
void copyAttributeCPF__(PRMAttribute< GUM_SCALAR > *attr)
Copy the content of an PRMAttribute<GUM_SCALAR> from its Class<GUM_SCALAR> counterpart.
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
const Set< PRMInstance< GUM_SCALAR > *> & getInstances(NodeId id) const
Returns the Set of PRMInstance<GUM_SCALAR> referenced by id.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ end() [1/2]

template<typename GUM_SCALAR >
INLINE const PRMInstance< GUM_SCALAR >::iterator & gum::prm::PRMInstance< GUM_SCALAR >::end ( )

Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 399 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

Referenced by gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), and gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__().

399  {
400  return nodeIdMap__.end();
401  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the caller graph for this function:

◆ end() [2/2]

template<typename GUM_SCALAR >
INLINE const PRMInstance< GUM_SCALAR >::const_iterator & gum::prm::PRMInstance< GUM_SCALAR >::end ( ) const

Returns a reference over the iterator at the end of the list of gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 411 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

411  {
412  return nodeIdMap__.end();
413  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514

◆ endInvRef() [1/2]

template<typename GUM_SCALAR >
INLINE const PRMInstance< GUM_SCALAR >::InvRefIterator & gum::prm::PRMInstance< GUM_SCALAR >::endInvRef ( )

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 572 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

Referenced by gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesDownward__(), and gum::prm::SVE< GUM_SCALAR >::eliminateNodesUpward__().

572  {
573  return referingAttr__.end();
574  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526
+ Here is the caller graph for this function:

◆ endInvRef() [2/2]

template<typename GUM_SCALAR >
INLINE const PRMInstance< GUM_SCALAR >::InvRefConstIterator & gum::prm::PRMInstance< GUM_SCALAR >::endInvRef ( ) const

Alias to iterate over the gum::prm::PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 584 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

584  {
585  return referingAttr__.end();
586  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526

◆ enum2str()

static std::string gum::prm::PRMObject::enum2str ( prm_type  type)
inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, gum::prm::PRMObject::CLASS_ELT, gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::PRM_INTERFACE, gum::prm::PRMObject::SYSTEM, and gum::prm::PRMObject::TYPE.

Referenced by gum::prm::operator<<().

83  {
84  switch (type) {
85  case prm_type::CLASS: return "PRMType::CLASS";
86 
87  case prm_type::CLASS_ELT: return "PRMType::CLASS_ELT";
88 
89  case prm_type::TYPE: return "PRMType::TYPE";
90 
91  case prm_type::SYSTEM: return "PRMType::SYSTEM";
92 
93  case prm_type::INSTANCE: return "PRMType::INSTANCE";
94 
95  case prm_type::PRM_INTERFACE: return "PRMType::PRM_INTERFACE";
96 
97  default: return "unknown";
98  }
99  }
+ Here is the caller graph for this function:

◆ exists() [1/2]

template<typename GUM_SCALAR >
INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::exists ( NodeId  id) const

Returns true if id matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 289 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::exists(), and gum::prm::o3prmr::O3prmrInterpreter::findAttributeName().

289  {
290  return nodeIdMap__.exists(id);
291  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the caller graph for this function:

◆ exists() [2/2]

template<typename GUM_SCALAR >
INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::exists ( const std::string &  name) const

Returns true if name matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.

Definition at line 294 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::exists(), and gum::prm::PRMInstance< GUM_SCALAR >::type__.

294  {
295  return type__->exists(name) && exists(type__->get(name).id());
296  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
bool exists(NodeId id) const
Returns true if id matches an PRMAttribute<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.
PRMClass< GUM_SCALAR > * type__
The type of this PRMInstance<GUM_SCALAR>.
Definition: PRMInstance.h:510
+ Here is the call graph for this function:

◆ get() [1/4]

template<typename GUM_SCALAR >
INLINE PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get ( NodeId  id)

Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Recall that PRMAggregate<GUM_SCALAR> are instantiated as PRMAttribute<GUM_SCALAR> when an PRMInstance<GUM_SCALAR> is created. Thus any random variable contained in this PRMInstance<GUM_SCALAR> is mapped to an PRMAttribute<GUM_SCALAR>.

Parameters
idThe PRMAttribute<GUM_SCALAR> id.
Returns
Returns a constant reference on an PRMAttribute<GUM_SCALAR>.
Exceptions
NotFoundRaised if no PRMAttribute<GUM_SCALAR> matches name.

Definition at line 299 of file PRMInstance_tpl.h.

References GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

Referenced by gum::prm::SVE< GUM_SCALAR >::addDelayedVariable__(), gum::prm::PRMInstance< GUM_SCALAR >::addReferingInstance__(), gum::prm::o3prmr::O3prmrInterpreter::checkObserve(), gum::prm::o3prmr::O3prmrInterpreter::checkQuery(), gum::prm::o3prmr::O3prmrInterpreter::checkUnobserve(), gum::prm::SVED< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesWithEvidence__(), gum::prm::SVED< GUM_SCALAR >::getAggPotential__(), gum::prm::SVE< GUM_SCALAR >::getAggPotential__(), gum::prm::PRMSystem< double >::groundAttr__(), gum::prm::PRMSystem< double >::groundPotential__(), gum::prm::InstanceBayesNet< GUM_SCALAR >::init__(), gum::prm::StructuredInference< GUM_SCALAR >::insertNodeInElimLists__(), gum::prm::StructuredBayesBall< GUM_SCALAR >::isHardEvidence__(), and gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__().

299  {
300  try {
301  return *(nodeIdMap__[id]);
302  } catch (NotFound&) {
303  GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given NodeId");
304  }
305  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the caller graph for this function:

◆ get() [2/4]

template<typename GUM_SCALAR >
INLINE PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get ( const std::string &  name)

Given a name returns the related PRMAttribute<GUM_SCALAR>.

Parameters
nameThe PRMAttribute<GUM_SCALAR>'s name.
Returns
Returns a reference over the PRMAttribute<GUM_SCALAR>.
Exceptions
NotFoundRaised if there is no PRMAttribute<GUM_SCALAR> named n.

Definition at line 319 of file PRMInstance_tpl.h.

References GUM_ERROR, gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, and gum::prm::PRMInstance< GUM_SCALAR >::type().

319  {
320  try {
321  return *(nodeIdMap__[type().get(name).id()]);
322  } catch (NotFound&) {
323  GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given name");
324  }
325  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the call graph for this function:

◆ get() [3/4]

template<typename GUM_SCALAR >
INLINE const PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get ( NodeId  id) const

Getter on an PRMAttribute<GUM_SCALAR> of this PRMInstance<GUM_SCALAR>.

Recall that PRMAggregate<GUM_SCALAR> are instantiated has PRMAttribute<GUM_SCALAR> when an PRMInstance<GUM_SCALAR> is created. Thus any random variable contained in this PRMInstance<GUM_SCALAR> is mapped to an PRMAttribute<GUM_SCALAR>.

Parameters
idThe PRMAttribute<GUM_SCALAR> id.
Returns
Returns a constant reference on an PRMAttribute<GUM_SCALAR>.
Exceptions
NotFoundRaised if no PRMAttribute<GUM_SCALAR> matches name.

Definition at line 309 of file PRMInstance_tpl.h.

References GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

309  {
310  try {
311  return *(nodeIdMap__[id]);
312  } catch (NotFound&) {
313  GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given NodeId");
314  }
315  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55

◆ get() [4/4]

template<typename GUM_SCALAR >
INLINE const PRMAttribute< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::get ( const std::string &  name) const

Given a name returns the related PRMClassElement.

Parameters
nameThe PRMClassElement's name.
Returns
Returns a constant reference over the PRMClassElement.
Exceptions
NotFoundRaised if there is no PRMClassElement named n.

Definition at line 329 of file PRMInstance_tpl.h.

References GUM_ERROR, gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__, and gum::prm::PRMInstance< GUM_SCALAR >::type().

329  {
330  try {
331  return *(nodeIdMap__[type().get(name).id()]);
332  } catch (NotFound&) {
333  GUM_ERROR(NotFound, "no PRMAttribute<GUM_SCALAR> with the given name");
334  }
335  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
PRMClass< GUM_SCALAR > & type()
Returns the type of this instance.
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the call graph for this function:

◆ getInstance()

template<typename GUM_SCALAR >
INLINE const PRMInstance< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::getInstance ( NodeId  id) const

Fast access to the first instance in a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

This is equivalent to **(this->getInstance(id).begin()) and should be use when dealing with non multiple PRMReferenceSlot or PRMSlotChain<GUM_SCALAR>.

Parameters
idThe NodeId of a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR> in this PRMInstance<GUM_SCALAR>.
Exceptions
NotFoundRaised if there is no PRMClassElement given id.
UndefinedElementRaised if no PRMInstance<GUM_SCALAR> are referenced by id.

Definition at line 364 of file PRMInstance_tpl.h.

References GUM_ERROR, gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__, and gum::prm::PRMInstance< GUM_SCALAR >::size().

Referenced by gum::prm::PRMSystem< double >::groundPotential__().

364  {
365  try {
366  if (referenceMap__[id]->size() > 0) {
367  return **(referenceMap__[id]->begin());
368  } else {
369  GUM_ERROR(UndefinedElement,
370  "no Instance associated with the given NodeId");
371  }
372  } catch (NotFound&) {
373  GUM_ERROR(NotFound,
374  "no ReferenceSlot<GUM_SCALAR> or SlotChain<GUM_SCALAR> "
375  "matches the given NodeId");
376  }
377  }
Size size() const
Returns the number of attributes in this PRMInstance<GUM_SCALAR>.
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInstances()

template<typename GUM_SCALAR >
INLINE const Set< PRMInstance< GUM_SCALAR > *> & gum::prm::PRMInstance< GUM_SCALAR >::getInstances ( NodeId  id) const

Returns the Set of PRMInstance<GUM_SCALAR> referenced by id.

Parameters
idThe NodeId of a PRMReferenceSlot or PRMSlotChain<GUM_SCALAR> in this.
Returns
Returns the Set of PRMInstance<GUM_SCALAR> referenced by id.
Exceptions
NotFoundIf there is no PRMClassElement given id.

Definition at line 381 of file PRMInstance_tpl.h.

References GUM_ERROR, and gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesDownward__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesDownward__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesUpward__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesUpward__(), and gum::prm::StructuredBayesBall< GUM_SCALAR >::fromChild__().

381  {
382  try {
383  return *(referenceMap__[id]);
384  } catch (NotFound&) {
385  GUM_ERROR(NotFound,
386  "no ReferenceSlot<GUM_SCALAR> or SlotChain<GUM_SCALAR> "
387  "matches the given NodeId");
388  }
389  }
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55
+ Here is the caller graph for this function:

◆ getRefAttr() [1/2]

template<typename GUM_SCALAR >
INLINE std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr ( NodeId  id)

Returns a vector of pairs of refering attributes of id.

Definition at line 590 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

Referenced by gum::prm::SVED< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesDownward__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesUpward__(), gum::prm::StructuredBayesBall< GUM_SCALAR >::fromChild__(), gum::prm::StructuredBayesBall< GUM_SCALAR >::fromParent__(), and gum::prm::StructuredInference< GUM_SCALAR >::insertNodeInElimLists__().

590  {
591  return *(referingAttr__[id]);
592  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526
+ Here is the caller graph for this function:

◆ getRefAttr() [2/2]

template<typename GUM_SCALAR >
INLINE const std::vector< std::pair< PRMInstance< GUM_SCALAR > *, std::string > > & gum::prm::PRMInstance< GUM_SCALAR >::getRefAttr ( NodeId  id) const

Returns a vector of pairs of refering attributes of id.

Definition at line 597 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

597  {
598  return *(referingAttr__[id]);
599  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526

◆ hasRefAttr()

template<typename GUM_SCALAR >
INLINE bool gum::prm::PRMInstance< GUM_SCALAR >::hasRefAttr ( NodeId  id) const

Returns true if id has at least one referring PRMAttribute<GUM_SCALAR>.

Parameters
idA NodeId.
Returns
returns true if is has at least one referring PRMAttribute<GUM_SCALAR>.

Definition at line 602 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::referingAttr__.

602  {
603  return referingAttr__.exists(id) && (!referingAttr__[id]->empty());
604  }
NodeProperty< std::vector< pair > *> referingAttr__
The set of pair (instance, attribute) referring an attribute of this instance.
Definition: PRMInstance.h:526

◆ instantiate()

template<typename GUM_SCALAR >
void gum::prm::PRMInstance< GUM_SCALAR >::instantiate ( )

Instantiate all nodes which requires it.

All attributes are now instantiated, which means they have a different DiscreteVariable pointer. This methods however still connects attributes of different instance together.

Warning
Be aware that this method will delete a large part of this instance attribute's CPF. Furthermore, the instantiated attribute's type will change (but will not be deleted).

Definition at line 67 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__(), and gum::prm::PRMInstance< GUM_SCALAR >::instantiated__.

67  {
68  if (!instantiated__) {
69  instantiated__ = true;
71  }
72  }
void doInstantiate__()
Starts this instance instantiations.
bool instantiated__
True if this instance has been instantiated.
Definition: PRMInstance.h:507
+ Here is the call graph for this function:

◆ instantiateSlotChain__()

template<typename GUM_SCALAR >
void gum::prm::PRMInstance< GUM_SCALAR >::instantiateSlotChain__ ( PRMSlotChain< GUM_SCALAR > *  sc)
private

Retrieve all instances referred by sc.

Parameters
scA slot chain of this instance's type.
Exceptions
NotFoundRaised if a reference in sc is not instantiated.

Definition at line 112 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::addReferingInstance__(), gum::prm::PRMInstance< GUM_SCALAR >::bijection__, gum::prm::PRMSlotChain< GUM_SCALAR >::chain(), gum::prm::PRMClassElement< GUM_SCALAR >::id(), gum::Set< Key, Alloc >::insert(), gum::prm::PRMSlotChain< GUM_SCALAR >::isMultiple(), gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt(), gum::prm::PRMInstance< GUM_SCALAR >::referenceMap__, and gum::prm::PRMSlotChain< GUM_SCALAR >::type().

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__().

113  {
114  auto first_id = sc->chain()[0]->id();
115  if (!referenceMap__.exists(first_id)) { return; }
116  auto set =
117  new Set< PRMInstance< GUM_SCALAR >* >(*(referenceMap__[first_id]));
118  // We proceed with a width-first run of the slot chain
119  for (Size idx = 1; idx < sc->chain().size() - 1; ++idx) {
120  auto temp = new Set< PRMInstance< GUM_SCALAR >* >();
121  for (auto current: *set) {
122  auto& ref = current->type().get(sc->chain()[idx]->name());
123  for (auto next: *(current->referenceMap__[ref.id()])) {
124  temp->insert(next);
125  }
126  }
127  delete set;
128  set = temp;
129  }
130 
131  GUM_ASSERT(set->size() > 0);
132  // set contains all the instances references by sc
133  if (referenceMap__.exists(sc->id())) {
134  delete referenceMap__[sc->id()];
135  referenceMap__[sc->id()] = set;
136  } else {
137  referenceMap__.insert(sc->id(), set);
138  }
139 
140  // Add refering instances
141  for (auto i: *set) {
142  addReferingInstance__(sc, i);
143  }
144 
145  // If sc is not multiple so it can be added as a parent of an attribute
146  if (!sc->isMultiple()) {
147  // We should have only one instance
148  // Less ugly way to get the single instance in set
149  for (auto instance: *set) {
150  auto& attr = instance->get(sc->lastElt().safeName());
151  bijection__.insert(&(sc->type().variable()), &(attr.type().variable()));
152  }
153  }
154  }
Bijection< const DiscreteVariable *, const DiscreteVariable *> bijection__
A bijection used for MultiDim handling.
Definition: PRMInstance.h:529
void addReferingInstance__(PRMSlotChain< GUM_SCALAR > *sc, PRMInstance< GUM_SCALAR > *i)
Add this as a referring instance over the attribute pointed by sc in i.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:48
NodeProperty< Set< PRMInstance< GUM_SCALAR > *> *> referenceMap__
Mapping between the gum::prm::PRMReferenceSlot and gum::prm::PRMSlotChain<GUM_SCALAR> in type__ / and...
Definition: PRMInstance.h:519
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isClass()

static INLINE bool gum::prm::PRMObject::isClass ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 102 of file PRMObject.h.

References gum::prm::PRMObject::CLASS, and gum::prm::PRMObject::obj_type().

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

102  {
103  return obj.obj_type() == prm_type::CLASS;
104  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isInstance()

static INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 112 of file PRMObject.h.

References gum::prm::PRMObject::INSTANCE, gum::prm::PRMObject::name(), gum::prm::PRMObject::obj_type(), gum::prm::PRMObject::operator!=(), gum::prm::PRMObject::operator=(), gum::prm::PRMObject::operator==(), gum::prm::PRMObject::PRMObject(), and gum::prm::PRMObject::~PRMObject().

112  {
113  return obj.obj_type() == prm_type::INSTANCE;
114  }
+ Here is the call graph for this function:

◆ isInterface()

static INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject obj)
inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 107 of file PRMObject.h.

References gum::prm::PRMObject::obj_type(), and gum::prm::PRMObject::PRM_INTERFACE.

107  {
108  return obj.obj_type() == prm_type::PRM_INTERFACE;
109  }
+ Here is the call graph for this function:

◆ LEFT_CAST()

static std::string gum::prm::PRMObject::LEFT_CAST ( )
inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 79 of file PRMObject.h.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

79 { return "("; }
+ Here is the caller graph for this function:

◆ name() [1/2]

INLINE const std::string & gum::prm::PRMObject::name ( ) const
inherited

Returns the name of this object.

Definition at line 35 of file PRMObject_inl.h.

References gum::prm::PRMObject::name__.

Referenced by gum::prm::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::SVE< GUM_SCALAR >::addDelayedVariable__(), gum::prm::PRMClass< double >::addIOInterfaceFlags__(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMFactory< GUM_SCALAR >::addParent__(), gum::prm::PRMInstance< GUM_SCALAR >::addReferingInstance__(), gum::prm::PRMClass< double >::checkInterface__(), gum::prm::PRMFactory< GUM_SCALAR >::checkInterfaceImplementation__(), gum::prm::PRMClass< double >::checkInterfaces__(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::checkRawCPT__(), gum::prm::PRMClass< double >::checkRefInterface__(), gum::prm::PRMClass< double >::checkRefInterfaces__(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::checkRuleCPTSumsTo1__(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMInstance< GUM_SCALAR >::copyAggregates__(), gum::prm::PRMInstance< GUM_SCALAR >::copyAttribute__(), gum::prm::PRMSlotChain< double >::copyLastElt__(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMSystem< double >::groundAttr__(), gum::prm::PRMSystem< double >::groundPotential__(), gum::prm::PRMSystem< double >::groundRef__(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::inheritClass__(), gum::prm::PRMClass< double >::isCastDescendant(), gum::prm::PRMObject::isInstance(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMType::operator!=(), gum::prm::PRMObject::operator!=(), operator<<(), gum::prm::PRMType::operator==(), gum::prm::PRMObject::operator==(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), gum::prm::PRMInterface< double >::overloadAttribute__(), gum::prm::PRMClass< double >::overloadAttribute__(), gum::prm::PRMClass< double >::overloadParameter__(), gum::prm::PRMClass< double >::overloadReference__(), gum::prm::PRMInterface< double >::overloadReferenceSlot__(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< double >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), gum::prm::PRMFactory< GUM_SCALAR >::startSystem(), gum::prm::PRMAggregate< double >::str2enum(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::str__(), and gum::prm::StructuredInference< GUM_SCALAR >::str__().

35 { return name__; }
std::string name__
Definition: PRMObject.h:200

◆ name() [2/2]

INLINE void gum::prm::PRMObject::name ( const std::string &  name)
inherited

Change the name of the PRM Object.

Warning
Don't do this unless you know what you are doing !

Definition at line 39 of file PRMObject_inl.h.

References gum::prm::PRMObject::name(), and gum::prm::PRMObject::name__.

39 { name__ = name; }
std::string name__
Definition: PRMObject.h:200
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:35
+ Here is the call graph for this function:

◆ obj_type()

template<typename GUM_SCALAR >
INLINE PRMObject::prm_type gum::prm::PRMInstance< GUM_SCALAR >::obj_type ( ) const
virtual

Returns the PRM type of this object.

Implements gum::prm::PRMObject.

Definition at line 274 of file PRMInstance_tpl.h.

References gum::prm::PRMObject::INSTANCE.

◆ operator!=()

INLINE bool gum::prm::PRMObject::operator!= ( const PRMObject obj) const
inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 49 of file PRMObject_inl.h.

References gum::prm::PRMObject::name(), and gum::prm::PRMObject::name__.

Referenced by gum::prm::PRMObject::isInstance().

49  {
50  return name__ != obj.name();
51  }
std::string name__
Definition: PRMObject.h:200
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

template<typename GUM_SCALAR >
INLINE PRMInstance< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::operator= ( const PRMClass< GUM_SCALAR > &  from)
private

Copy operator. Don't use it.

Definition at line 269 of file PRMInstance_tpl.h.

References GUM_ERROR.

269  {
270  GUM_ERROR(FatalError, "do not copy Instance");
271  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:55

◆ operator==()

INLINE bool gum::prm::PRMObject::operator== ( const PRMObject obj) const
inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 43 of file PRMObject_inl.h.

References gum::prm::PRMObject::name(), and gum::prm::PRMObject::name__.

Referenced by gum::prm::PRMObject::isInstance().

43  {
44  return name__ == obj.name();
45  }
std::string name__
Definition: PRMObject.h:200
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RIGHT_CAST()

static std::string gum::prm::PRMObject::RIGHT_CAST ( )
inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 80 of file PRMObject.h.

Referenced by gum::prm::decomposePath(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), and gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute().

80 { return ")"; }
+ Here is the caller graph for this function:

◆ size()

template<typename GUM_SCALAR >
INLINE Size gum::prm::PRMInstance< GUM_SCALAR >::size ( ) const

Returns the number of attributes in this PRMInstance<GUM_SCALAR>.

Returns
the number of attributes in this PRMInstance<GUM_SCALAR>.

Definition at line 230 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::nodeIdMap__.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::PRMInstance< GUM_SCALAR >::getInstance(), and gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__().

230  {
231  return nodeIdMap__.size();
232  }
NodeProperty< PRMAttribute< GUM_SCALAR > *> nodeIdMap__
The gum::prm::PRMAttribute<GUM_SCALAR> and gum::prm::PRMAggregate<GUM_SCALAR> of this PRMInstance<GUM...
Definition: PRMInstance.h:514
+ Here is the caller graph for this function:

◆ type() [1/2]

template<typename GUM_SCALAR >
INLINE PRMClass< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::type ( )

Returns the type of this instance.

Definition at line 279 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::type__.

Referenced by gum::prm::__print_attribute__(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::StructuredBayesBall< GUM_SCALAR >::buildHashKey__(), gum::prm::SVED< GUM_SCALAR >::checkElimOrder__(), gum::prm::SVE< GUM_SCALAR >::checkElimOrder__(), gum::prm::PRMInstance< GUM_SCALAR >::copyAttributeCPF__(), gum::prm::PRMInstance< GUM_SCALAR >::doInstantiate__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodes__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesDownward__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesDownward__(), gum::prm::SVED< GUM_SCALAR >::eliminateNodesUpward__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesUpward__(), gum::prm::SVE< GUM_SCALAR >::eliminateNodesWithEvidence__(), gum::prm::StructuredBayesBall< GUM_SCALAR >::fromChild__(), gum::prm::StructuredBayesBall< GUM_SCALAR >::fromParent__(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::StructuredBayesBall< GUM_SCALAR >::getSC__(), gum::prm::PRMSystem< double >::groundAttr__(), gum::prm::PRMSystem< double >::groundPotential__(), gum::prm::InstanceBayesNet< GUM_SCALAR >::init__(), gum::prm::SVED< GUM_SCALAR >::initLiftedNodes__(), gum::prm::SVED< GUM_SCALAR >::initReqSets__(), gum::prm::SVE< GUM_SCALAR >::insertLiftedNodes__(), gum::prm::StructuredInference< GUM_SCALAR >::insertNodeInElimLists__(), gum::prm::StructuredInference< GUM_SCALAR >::reduceAloneInstances__(), and gum::prm::SVE< GUM_SCALAR >::variableElimination__().

279  {
280  return *type__;
281  }
PRMClass< GUM_SCALAR > * type__
The type of this PRMInstance<GUM_SCALAR>.
Definition: PRMInstance.h:510
+ Here is the caller graph for this function:

◆ type() [2/2]

template<typename GUM_SCALAR >
INLINE const PRMClass< GUM_SCALAR > & gum::prm::PRMInstance< GUM_SCALAR >::type ( ) const

Returns the type of this instance.

Definition at line 284 of file PRMInstance_tpl.h.

References gum::prm::PRMInstance< GUM_SCALAR >::type__.

284  {
285  return *type__;
286  }
PRMClass< GUM_SCALAR > * type__
The type of this PRMInstance<GUM_SCALAR>.
Definition: PRMInstance.h:510

Member Data Documentation

◆ bijection__

◆ instantiated__

template<typename GUM_SCALAR>
bool gum::prm::PRMInstance< GUM_SCALAR >::instantiated__
private

True if this instance has been instantiated.

Definition at line 507 of file PRMInstance.h.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::instantiate().

◆ nodeIdMap__

◆ referenceMap__

◆ referingAttr__

◆ type__

template<typename GUM_SCALAR>
PRMClass< GUM_SCALAR >* gum::prm::PRMInstance< GUM_SCALAR >::type__
private

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