aGrUM  0.14.1
gum::prm::PRMFormAttribute< GUM_SCALAR > Class Template Reference

<agrum/PRM/elements/formAttribute.h> More...

#include <PRMFormAttribute.h>

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

Public Member Functions

 PRMFormAttribute (const PRMClass< GUM_SCALAR > &c, const std::string &name, const PRMType &type, MultiDimImplementation< std::string > *impl=new MultiDimArray< std::string >())
 
virtual ~PRMFormAttribute ()
 
virtual PRMAttribute< GUM_SCALAR > * newFactory (const PRMClass< GUM_SCALAR > &c) const
 See gum::prm::PRMAttribute. More...
 
virtual PRMAttribute< GUM_SCALAR > * copy (Bijection< const DiscreteVariable *, const DiscreteVariable * > bij) const
 See gum::prm::PRMAttribute. More...
 
virtual void copyCpf (const Bijection< const DiscreteVariable *, const DiscreteVariable * > &bif, const PRMAttribute< GUM_SCALAR > &source)
 See gum::prm::PRMAttribute. More...
 
virtual PRMClassElement< GUM_SCALAR >::ClassElementType elt_type () const
 See gum::prm::PRMAttribute. More...
 
virtual PRMTypetype ()
 See gum::prm::PRMAttribute. More...
 
virtual const PRMTypetype () const
 See gum::prm::PRMAttribute. More...
 
virtual const Potential< GUM_SCALAR > & cpf () const
 See gum::prm::PRMAttribute. More...
 
virtual void addParent (const PRMClassElement< GUM_SCALAR > &elt)
 See gum::prm::PRMAttribute. More...
 
virtual void addChild (const PRMClassElement< GUM_SCALAR > &elt)
 See gum::prm::PRMAttribute. More...
 
virtual PRMAttribute< GUM_SCALAR > * getCastDescendant () const
 See gum::prm::PRMAttribute. More...
 
virtual void setAsCastDescendant (PRMAttribute< GUM_SCALAR > *attr)
 See gum::prm::PRMAttribute. More...
 
virtual void becomeCastDescendant (PRMType &subtype)
 Change this attribute to be a cast descendant of a an attribute with type subtype. More...
 
virtual MultiDimImplementation< std::string > & formulas ()
 
virtual const MultiDimImplementation< std::string > & formulas () const
 
virtual void swap (const PRMType &old_type, const PRMType &new_type)
 Swap old_type with new_type in the PRMClassElement cpt. More...
 
Getters & setters
virtual void overload (PRMAttribute< GUM_SCALAR > *source)
 Set this as overload of source (necessayr to preserver internal pointers for MultiDims). More...
 
Getters & setters
NodeId id () const
 Returns the NodeId of this element in it's class DAG. More...
 
virtual void setId (NodeId id)
 Used to assign the id of this element. More...
 
virtual PRMObject::prm_type obj_type () const
 
Fast access to random variable's properties
const std::string & safeName () const
 Returns the safe name of this PRMClassElement, if any. More...
 
virtual std::string cast (const PRMType &t) const
 Returns the name of the cast descendant with PRMType t of this PRMClassElement. 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...
 

Protected Attributes

std::string _safeName
 The safe name of this PRMClassElement. More...
 

Protected Member Functions

virtual PRMType_type ()
 
virtual void _type (PRMType *t)
 

Built-in type

enum  ClassElementType {
  prm_attribute, prm_aggregate, prm_refslot, prm_slotchain,
  prm_parameter
}
 Returns true if obj_ptr is of type PRMReferenceSlot. More...
 
static std::string enum2str (ClassElementType type)
 Returns true if obj_ptr is of type PRMReferenceSlot. More...
 
static INLINE bool isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMReferenceSlot. More...
 
static INLINE bool isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMAttribute. More...
 
static INLINE bool isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMAggregate. More...
 
static INLINE bool isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMSlotChain. More...
 
static INLINE bool isParameter (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMParameter. 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 enum2str (prm_type type)
 Returns the string representation of a PRMObject. 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 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::PRMFormAttribute< GUM_SCALAR >

<agrum/PRM/elements/formAttribute.h>

PRMFormAttribute is a member of a Class in a PRM.

See also
PRM PRMFactory Class PRMClassElement PRMType<GUM_SCALAR> Potential PRMAttribute

Definition at line 47 of file PRMFormAttribute.h.

Member Enumeration Documentation

◆ ClassElementType

template<typename GUM_SCALAR>
enum gum::prm::PRMClassElement::ClassElementType
inherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Enumerator
prm_attribute 
prm_aggregate 
prm_refslot 
prm_slotchain 
prm_parameter 

Definition at line 92 of file PRMClassElement.h.

◆ 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 66 of file PRMObject.h.

66  : char {
67  ALL,
68  CLASS,
69  PRM_INTERFACE,
70  CLASS_ELT,
71  TYPE,
72  SYSTEM,
73  INSTANCE
74  };

Constructor & Destructor Documentation

◆ PRMFormAttribute() [1/2]

template<typename GUM_SCALAR >
gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute ( const PRMClass< GUM_SCALAR > &  c,
const std::string &  name,
const PRMType type,
MultiDimImplementation< std::string > *  impl = new MultiDimArray< std::string >() 
)

Definition at line 40 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::prm::PRMClassElement< GUM_SCALAR >::_safeName, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::prm::PRMObject::LEFT_CAST(), gum::Variable::name(), gum::prm::PRMObject::name(), and gum::prm::PRMObject::RIGHT_CAST().

44  :
45  PRMAttribute< GUM_SCALAR >(name),
46  __type(new PRMType(type)), __cpf(0), __formulas(impl), __class(&c) {
47  GUM_CONSTRUCTOR(PRMFormAttribute);
48  __formulas->add(__type->variable());
49  this->_safeName =
51  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
PRMFormAttribute(const PRMClass< GUM_SCALAR > &c, const std::string &name, const PRMType &type, MultiDimImplementation< std::string > *impl=new MultiDimArray< std::string >())
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
PRMType * __type
The random variable type of this attribute.
static std::string LEFT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:76
const PRMClass< GUM_SCALAR > * __class
A pointe toward the class of this attribute.
const std::string & name() const
returns the name of the variable
static std::string RIGHT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:77
virtual PRMType & type()
See gum::prm::PRMAttribute.
std::string _safeName
The safe name of this PRMClassElement.
+ Here is the call graph for this function:

◆ ~PRMFormAttribute()

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

Definition at line 54 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, and gum::prm::PRMFormAttribute< GUM_SCALAR >::__type.

54  {
55  GUM_DESTRUCTOR(PRMFormAttribute);
56  delete __type;
57  delete __cpf;
58  delete __formulas;
59  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
PRMFormAttribute(const PRMClass< GUM_SCALAR > &c, const std::string &name, const PRMType &type, MultiDimImplementation< std::string > *impl=new MultiDimArray< std::string >())
PRMType * __type
The random variable type of this attribute.

◆ PRMFormAttribute() [2/2]

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

Definition at line 254 of file PRMFormAttribute_tpl.h.

References GUM_ERROR, and gum::prm::PRMFormAttribute< GUM_SCALAR >::operator=().

255  :
256  PRMAttribute< GUM_SCALAR >(source.name()) {
257  GUM_CONS_CPY(PRMFormAttribute);
258  GUM_ERROR(OperationNotAllowed, "Cannot copy FormAttribute");
259  }
PRMFormAttribute(const PRMClass< GUM_SCALAR > &c, const std::string &name, const PRMType &type, MultiDimImplementation< std::string > *impl=new MultiDimArray< std::string >())
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

Member Function Documentation

◆ __fillCpf()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf ( ) const
private

Definition at line 268 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__class, gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::MultiDimImplementation< GUM_SCALAR >::contains(), gum::Instantiation::end(), gum::MultiDimContainer< GUM_SCALAR >::get(), GUM_ERROR, gum::Instantiation::inc(), gum::HashTable< Key, Val, Alloc >::insert(), gum::Formula::result(), gum::Instantiation::setFirst(), gum::Formula::variables(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::cpf().

268  {
269  try {
270  if (__cpf) { delete __cpf; }
271 
272  __cpf = new Potential< GUM_SCALAR >();
273 
274  for (auto var : __formulas->variablesSequence()) {
275  __cpf->add(*var);
276  }
277 
278  auto params = __class->scope();
279 
280  Instantiation inst(__formulas);
281  Instantiation jnst(__cpf);
282 
283  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
284  inst.inc(), jnst.inc()) {
285  // With CPT defined using rules, empty values can appear
286  auto val = __formulas->get(inst);
287  if (val == "") { val = "0.0"; }
288 
289  Formula f(val);
290 
291  for (auto item : params) {
292  f.variables().insert(item.first, item.second->value());
293  }
294 
295  __cpf->set(jnst, (GUM_SCALAR)f.result());
296  }
297 
298  GUM_ASSERT(inst.end() && jnst.end());
299 
300  } catch (Exception&) { GUM_ERROR(NotFound, "undefined value in cpt"); }
301  GUM_ASSERT(__formulas->contains(__type->variable()));
302  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
PRMType * __type
The random variable type of this attribute.
virtual const Sequence< const DiscreteVariable *> & variablesSequence() const override
Returns a const ref to the sequence of DiscreteVariable*.
const PRMClass< GUM_SCALAR > * __class
A pointe toward the class of this attribute.
virtual GUM_SCALAR get(const Instantiation &i) const
Returns the value pointed by i.
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _type() [1/2]

template<typename GUM_SCALAR >
PRMType * gum::prm::PRMFormAttribute< GUM_SCALAR >::_type ( )
protectedvirtual

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

Definition at line 367 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__type.

367  {
368  return __type;
369  }
PRMType * __type
The random variable type of this attribute.

◆ _type() [2/2]

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::_type ( PRMType t)
protectedvirtual

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

Definition at line 372 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::MultiDimImplementation< GUM_SCALAR >::contains(), gum::DiscreteVariable::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::inc(), gum::MultiDimContainer< GUM_SCALAR >::set(), and gum::Instantiation::setFirst().

372  {
373  if (__type->variable().domainSize() != t->variable().domainSize()) {
374  GUM_ERROR(OperationNotAllowed,
375  "Cannot replace types with difference domain size");
376  }
377  auto old = __formulas;
378 
379  __formulas = new MultiDimArray< std::string >();
380 
381  for (auto var : old->variablesSequence()) {
382  if (var != &(__type->variable())) {
383  __formulas->add(*var);
384  } else {
385  __formulas->add(t->variable());
386  }
387  }
388 
389  Instantiation inst(__formulas), jnst(old);
390 
391  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
392  inst.inc(), jnst.inc()) {
393  __formulas->set(inst, old->get(jnst));
394  }
395 
396  delete old;
397 
398  __type = t;
399 
400  if (__cpf) {
401  delete __cpf;
402  __cpf = 0;
403  }
404 
405  GUM_ASSERT(__formulas->contains(__type->variable()));
406  GUM_ASSERT(inst.end() && jnst.end());
407  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
virtual Size domainSize() const =0
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
Changes the value pointed by i.
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
PRMType * __type
The random variable type of this attribute.
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

◆ addChild()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::addChild ( const PRMClassElement< GUM_SCALAR > &  elt)
virtual

See gum::prm::PRMAttribute.

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

Definition at line 177 of file PRMFormAttribute_tpl.h.

178  {}

◆ addParent()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent ( const PRMClassElement< GUM_SCALAR > &  elt)
virtual

See gum::prm::PRMAttribute.

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

Definition at line 157 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::MultiDimImplementation< GUM_SCALAR >::contains(), GUM_ERROR, gum::prm::PRMObject::name(), and gum::prm::PRMClassElement< GUM_SCALAR >::type().

158  {
159  try {
160  if (__cpf) {
161  delete __cpf;
162  __cpf = 0;
163  }
164  __formulas->add(elt.type().variable());
165  } catch (DuplicateElement&) {
166  GUM_ERROR(DuplicateElement,
167  elt.name() << " as parent of " << this->name());
168  } catch (OperationNotAllowed&) {
169  GUM_ERROR(OperationNotAllowed,
170  elt.name() << " of wrong type as parent of " << this->name(););
171  }
172 
173  GUM_ASSERT(__formulas->contains(__type->variable()));
174  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
PRMType * __type
The random variable type of this attribute.
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

◆ becomeCastDescendant()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::becomeCastDescendant ( PRMType subtype)
virtual

Change this attribute to be a cast descendant of a an attribute with type subtype.

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

Definition at line 229 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::Instantiation::end(), gum::Instantiation::inc(), gum::prm::PRMType::label_map(), gum::Instantiation::pos(), gum::MultiDimContainer< GUM_SCALAR >::set(), gum::Instantiation::setFirst(), gum::prm::PRMFormAttribute< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

229  {
230  delete __formulas;
231 
232  __formulas = new MultiDimArray< std::string >();
233  __formulas->add(type().variable());
234  __formulas->add(subtype.variable());
235 
236  Instantiation inst(__formulas);
237 
238  for (inst.setFirst(); !inst.end(); inst.inc()) {
239  auto my_pos = inst.pos(subtype.variable());
240  if (subtype.label_map()[my_pos] == inst.pos(type().variable())) {
241  __formulas->set(inst, "1");
242  } else {
243  __formulas->set(inst, "0");
244  }
245  }
246 
247  if (__cpf) {
248  delete __cpf;
249  __cpf = nullptr;
250  }
251  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
Changes the value pointed by i.
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
virtual PRMType & type()
See gum::prm::PRMAttribute.
+ Here is the call graph for this function:

◆ cast()

template<typename GUM_SCALAR >
INLINE std::string gum::prm::PRMClassElement< GUM_SCALAR >::cast ( const PRMType t) const
virtualinherited

Returns the name of the cast descendant with PRMType t of this PRMClassElement.

Parameters
tThe type in which we want to cast this PRMClassElement.
Exceptions
OperationNotAllowedIf the cast is impossible.

Definition at line 73 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), and gum::prm::PRMClassElement< double >::isParameter().

73  {
74  if (type().isSubTypeOf(t)) {
75  return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST()
76  + name();
77  } else {
78  GUM_ERROR(OperationNotAllowed, "illegal cast");
79  }
80  }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
virtual PRMType & type()=0
Return a reference over the gum::PRMType of this class element.
static std::string LEFT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:76
static std::string RIGHT_CAST()
Enumeration of the different types of objects handled by a PRM.
Definition: PRMObject.h:77
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the caller graph for this function:

◆ copy()

template<typename GUM_SCALAR >
PRMAttribute< GUM_SCALAR > * gum::prm::PRMFormAttribute< GUM_SCALAR >::copy ( Bijection< const DiscreteVariable *, const DiscreteVariable * >  bij) const
virtual

See gum::prm::PRMAttribute.

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

Definition at line 71 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__class, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::Instantiation::end(), gum::MultiDimContainer< GUM_SCALAR >::get(), gum::Instantiation::inc(), gum::prm::PRMObject::name(), gum::Instantiation::setFirst(), gum::prm::PRMFormAttribute< GUM_SCALAR >::type(), and gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence().

72  {
73  auto copy =
74  new PRMFormAttribute< GUM_SCALAR >(*__class, this->name(), this->type());
75  for (auto var : __formulas->variablesSequence()) {
76  if (var != &(__type->variable())) { copy->__formulas->add(*var); }
77  }
78 
79  Instantiation inst(*(copy->__formulas)), jnst(*__formulas);
80  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
81  inst.inc(), jnst.inc()) {
82  copy->__formulas->set(inst, __formulas->get(jnst));
83  }
84 
85  GUM_ASSERT(copy->__formulas->contains(copy->__type->variable()));
86  return copy;
87  }
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
virtual PRMAttribute< GUM_SCALAR > * copy(Bijection< const DiscreteVariable *, const DiscreteVariable * > bij) const
See gum::prm::PRMAttribute.
PRMType * __type
The random variable type of this attribute.
virtual const Sequence< const DiscreteVariable *> & variablesSequence() const override
Returns a const ref to the sequence of DiscreteVariable*.
const PRMClass< GUM_SCALAR > * __class
A pointe toward the class of this attribute.
virtual GUM_SCALAR get(const Instantiation &i) const
Returns the value pointed by i.
virtual PRMType & type()
See gum::prm::PRMAttribute.
+ Here is the call graph for this function:

◆ copyCpf()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::copyCpf ( const Bijection< const DiscreteVariable *, const DiscreteVariable * > &  bif,
const PRMAttribute< GUM_SCALAR > &  source 
)
virtual

See gum::prm::PRMAttribute.

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

Definition at line 90 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::MultiDimImplementation< GUM_SCALAR >::contains(), gum::prm::PRMAttribute< GUM_SCALAR >::cpf(), gum::BijectionImplementation< T1, T2, Alloc, std::is_scalar< T1 >::value &&std::is_scalar< T2 >::value >::second(), gum::MultiDimContainer< GUM_SCALAR >::set(), gum::to_string(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

92  {
93  delete __formulas;
94  __formulas = new MultiDimArray< std::string >();
95 
96  for (const auto& var : source.cpf().variablesSequence()) {
97  __formulas->add(*(bij.second(var)));
98  }
99 
100  if (dynamic_cast< const PRMFormAttribute< GUM_SCALAR >* >(&source)) {
101  const auto& src =
102  static_cast< const PRMFormAttribute< GUM_SCALAR >& >(source);
103 
104  Instantiation inst(__formulas), jnst(src.__formulas);
105 
106  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
107  inst.inc(), jnst.inc()) {
108  __formulas->set(inst, src.__formulas->get(jnst));
109  }
110 
111  GUM_ASSERT(inst.end() && jnst.end());
112 
113  } else {
114  Instantiation inst(__formulas), jnst(source.cpf());
115 
116  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
117  inst.inc(), jnst.inc()) {
118  auto val = std::to_string(source.cpf().get(jnst));
119  __formulas->set(inst, val);
120  }
121 
122  GUM_ASSERT(inst.end() && jnst.end());
123  }
124 
125  if (__cpf) {
126  delete __cpf;
127  __cpf = 0;
128  }
129 
130  GUM_ASSERT(__formulas->contains(__type->variable()));
131  GUM_ASSERT(!__formulas->contains(source.type().variable()));
132  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
Changes the value pointed by i.
std::string to_string(const Formula &f)
Definition: formula_inl.h:479
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
PRMType * __type
The random variable type of this attribute.
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
+ Here is the call graph for this function:

◆ cpf()

template<typename GUM_SCALAR >
const Potential< GUM_SCALAR > & gum::prm::PRMFormAttribute< GUM_SCALAR >::cpf ( ) const
virtual

See gum::prm::PRMAttribute.

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

Definition at line 151 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, and gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf().

151  {
152  if (__cpf == 0) { __fillCpf(); }
153  return *__cpf;
154  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
+ Here is the call graph for this function:

◆ elt_type()

template<typename GUM_SCALAR >
PRMClassElement< GUM_SCALAR >::ClassElementType gum::prm::PRMFormAttribute< GUM_SCALAR >::elt_type ( ) const
virtual

◆ enum2str() [1/2]

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

Returns the string representation of a PRMObject.

Definition at line 80 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<<().

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

◆ enum2str() [2/2]

template<typename GUM_SCALAR>
static std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType  type)
inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 100 of file PRMClassElement.h.

100  {
101  switch (type) {
102  case prm_attribute: return "prm_attribute";
103 
104  case prm_aggregate: return "prm_aggregate";
105 
106  case prm_refslot: return "prm_refslot";
107 
108  case prm_slotchain: return "prm_slotchain";
109 
110  case prm_parameter: return "prm_parameter";
111 
112  default: return "unknown";
113  }
114  }
virtual PRMType & type()=0
Return a reference over the gum::PRMType of this class element.

◆ formulas() [1/2]

template<typename GUM_SCALAR >
MultiDimImplementation< std::string > & gum::prm::PRMFormAttribute< GUM_SCALAR >::formulas ( )
virtual

Definition at line 306 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, and gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas.

306  {
307  if (__cpf) {
308  delete __cpf;
309  __cpf = 0;
310  }
311  return *__formulas;
312  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.

◆ formulas() [2/2]

template<typename GUM_SCALAR >
const MultiDimImplementation< std::string > & gum::prm::PRMFormAttribute< GUM_SCALAR >::formulas ( ) const
virtual

Definition at line 316 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas.

316  {
317  return *__formulas;
318  }
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.

◆ getCastDescendant()

template<typename GUM_SCALAR >
PRMAttribute< GUM_SCALAR > * gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant ( ) const
virtual

See gum::prm::PRMAttribute.

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

Definition at line 182 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), gum::MultiDimImplementation< GUM_SCALAR >::contains(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::cpf(), GUM_ERROR, gum::prm::PRMType::label_map(), gum::prm::PRMObject::name(), gum::prm::PRMType::superType(), gum::prm::PRMFormAttribute< GUM_SCALAR >::type(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::type(), and gum::prm::PRMType::variable().

182  {
183  PRMScalarAttribute< GUM_SCALAR >* cast = 0;
184 
185  try {
186  cast =
187  new PRMScalarAttribute< GUM_SCALAR >(this->name(), type().superType());
188  } catch (NotFound&) {
189  GUM_ERROR(OperationNotAllowed,
190  "this ScalarAttribute can not have cast descendant");
191  }
192 
193  cast->addParent(*this);
194 
195  const DiscreteVariable& my_var = type().variable();
196  DiscreteVariable& cast_var = cast->type().variable();
197  Instantiation inst(cast->cpf());
198 
199  for (inst.setFirst(); !inst.end(); inst.inc()) {
200  if (type().label_map()[inst.val(my_var)] == inst.val(cast_var)) {
201  cast->cpf().set(inst, 1);
202  } else {
203  cast->cpf().set(inst, 0);
204  }
205  }
206 
207  GUM_ASSERT(__formulas->contains(__type->variable()));
208  return cast;
209  }
PRMType & superType()
Returns the super type of this type.
Definition: PRMType_inl.h:33
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
DiscreteVariable & variable()
Return a reference on the DiscreteVariable contained in this.
Definition: PRMType_inl.h:42
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
virtual std::string cast(const PRMType &t) const
Returns the name of the cast descendant with PRMType t of this PRMClassElement.
PRMType * __type
The random variable type of this attribute.
const std::vector< Idx > & label_map() const
Returns the vector in which the i-th element is the Idx of the super type&#39;s label for the i-th label ...
Definition: PRMType_inl.h:91
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
virtual PRMType & type()
See gum::prm::PRMAttribute.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

◆ id()

template<typename GUM_SCALAR >
INLINE NodeId gum::prm::PRMClassElement< GUM_SCALAR >::id ( ) const
inherited

Returns the NodeId of this element in it's class DAG.

Definition at line 52 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::SVE< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::InstanceBayesNet< GUM_SCALAR >::__init(), gum::prm::ClassBayesNet< GUM_SCALAR >::__init(), gum::prm::PRMInstance< GUM_SCALAR >::__instantiateSlotChain(), 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::SVED< GUM_SCALAR >::_marginal(), gum::prm::SVE< GUM_SCALAR >::_marginal(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::addArc(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClass< double >::overload(), gum::prm::PRMInterface< double >::overload(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

52  {
53  return __id;
54  }
NodeId __id
The node&#39;s id of this element.
+ Here is the caller graph for this function:

◆ isAggregate()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestaticinherited

Return true if obj is of type PRMAggregate.

Definition at line 128 of file PRMClassElement.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData().

128  {
129  return elt.elt_type() == prm_aggregate;
130  }
+ Here is the caller graph for this function:

◆ isAttribute()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestaticinherited

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 123 of file PRMClassElement.h.

123  {
124  return elt.elt_type() == prm_attribute;
125  }

◆ isClass()

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

Returns true if obj_ptr is of type Class.

Definition at line 99 of file PRMObject.h.

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

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

99  {
100  return obj.obj_type() == prm_type::CLASS;
101  }
+ 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 109 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().

109  {
110  return obj.obj_type() == prm_type::INSTANCE;
111  }
+ 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 104 of file PRMObject.h.

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

104  {
105  return obj.obj_type() == prm_type::PRM_INTERFACE;
106  }
+ Here is the call graph for this function:

◆ isParameter()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestaticinherited

Return true if obj is of type PRMParameter.

Definition at line 138 of file PRMClassElement.h.

138  {
139  return elt.elt_type() == prm_parameter;
140  }

◆ isReferenceSlot()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 118 of file PRMClassElement.h.

118  {
119  return elt.elt_type() == prm_refslot;
120  }

◆ isSlotChain()

template<typename GUM_SCALAR>
static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > &  elt)
inlinestaticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 133 of file PRMClassElement.h.

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

133  {
134  return elt.elt_type() == prm_slotchain;
135  }
+ Here is the caller 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 76 of file PRMObject.h.

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

76 { 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 32 of file PRMObject_inl.h.

References gum::prm::PRMObject::__name.

Referenced by gum::prm::SVE< GUM_SCALAR >::__addDelayedVariable(), gum::prm::PRMClass< double >::__addIOInterfaceFlags(), 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::PRMInstance< GUM_SCALAR >::__copyAggregates(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttribute(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMSystem< double >::__groundAttr(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMSystem< double >::__groundRef(), gum::prm::PRMClass< double >::__inheritClass(), 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::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMSystem< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMClass< double >::inheritAggregates(), 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::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(), and gum::prm::PRMAggregate< double >::str2enum().

32 { return __name; }
std::string __name
Definition: PRMObject.h:197

◆ 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 wath you are doing !

Definition at line 36 of file PRMObject_inl.h.

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

36 { __name = name; }
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
std::string __name
Definition: PRMObject.h:197
+ Here is the call graph for this function:

◆ newFactory()

template<typename GUM_SCALAR >
PRMAttribute< GUM_SCALAR > * gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory ( const PRMClass< GUM_SCALAR > &  c) const
virtual

See gum::prm::PRMAttribute.

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

Definition at line 62 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMObject::name(), gum::MultiDimImplementation< GUM_SCALAR >::newFactory(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::type().

63  {
64  auto impl = static_cast< MultiDimImplementation< std::string >* >(
65  this->__formulas->newFactory());
66  return new PRMFormAttribute< GUM_SCALAR >(
67  c, this->name(), this->type(), impl);
68  }
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32
virtual MultiDimContainer< GUM_SCALAR > * newFactory() const override=0
Creates an empty clone of this MultiDimContainer.
virtual PRMType & type()
See gum::prm::PRMAttribute.
+ Here is the call graph for this function:

◆ obj_type()

template<typename GUM_SCALAR >
INLINE PRMObject::prm_type gum::prm::PRMClassElement< GUM_SCALAR >::obj_type ( ) const
virtualinherited
See also
gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 57 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClassElement< double >::isParameter().

+ Here is the caller graph for this function:

◆ 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 46 of file PRMObject_inl.h.

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

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

46  {
47  return __name != obj.name();
48  }
std::string __name
Definition: PRMObject.h:197
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

template<typename GUM_SCALAR >
PRMFormAttribute< GUM_SCALAR > & gum::prm::PRMFormAttribute< GUM_SCALAR >::operator= ( const PRMFormAttribute< GUM_SCALAR > &  source)
private

Definition at line 263 of file PRMFormAttribute_tpl.h.

References GUM_ERROR.

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

263  {
264  GUM_ERROR(OperationNotAllowed, "Cannot copy FormAttribute");
265  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the caller graph for this function:

◆ 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 40 of file PRMObject_inl.h.

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

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

40  {
41  return __name == obj.name();
42  }
std::string __name
Definition: PRMObject.h:197
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ overload()

template<typename GUM_SCALAR>
void gum::prm::PRMAttribute< GUM_SCALAR >::overload ( PRMAttribute< GUM_SCALAR > *  source)
virtualinherited

Set this as overload of source (necessayr to preserver internal pointers for MultiDims).

Definition at line 50 of file PRMAttribute_tpl.h.

Referenced by gum::prm::PRMInterface< double >::__overloadAttribute(), and gum::prm::PRMClass< double >::__overloadAttribute().

50  {
51  auto old_type = this->_type();
52  this->_type(source->_type());
53  source->_type(old_type);
54  }
virtual PRMType * _type()=0
+ 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 77 of file PRMObject.h.

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

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

◆ safeName()

template<typename GUM_SCALAR >
INLINE const std::string & gum::prm::PRMClassElement< GUM_SCALAR >::safeName ( ) const
inherited

Returns the safe name of this PRMClassElement, if any.

This will only work if this PRMClassElement is an PRMAttribute or an PRMAggregate.

Returns
Returns the safe name of this PRMClassElement.
Exceptions
NotFound&Raised if this PRMClassElement does not have any safe name.

Definition at line 67 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMFactory< GUM_SCALAR >::__addParent(), gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::SVED< GUM_SCALAR >::__getAggPotential(), gum::prm::PRMSystem< double >::__groundPotential(), gum::prm::PRMSystem< double >::__groundRef(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMClass< double >::__overloadAggregate(), 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::__print_attribute__(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::__str(), gum::prm::StructuredInference< GUM_SCALAR >::__str(), gum::prm::PRMClassElementContainer< double >::_getIOFlag(), gum::prm::PRMClassElementContainer< double >::_setIOFlag(), gum::prm::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< double >::belongsTo(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClassElement< double >::isParameter(), gum::prm::PRMClassElementContainer< double >::setInputNode(), and gum::prm::PRMClassElementContainer< double >::setOutputNode().

67  {
68  return _safeName;
69  }
std::string _safeName
The safe name of this PRMClassElement.
+ Here is the caller graph for this function:

◆ setAsCastDescendant()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant ( PRMAttribute< GUM_SCALAR > *  attr)
virtual

See gum::prm::PRMAttribute.

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

Definition at line 212 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMAttribute< GUM_SCALAR >::becomeCastDescendant(), GUM_ERROR, gum::prm::PRMType::name(), gum::prm::PRMType::setSuper(), gum::prm::PRMFormAttribute< GUM_SCALAR >::type(), and gum::prm::PRMAttribute< GUM_SCALAR >::type().

213  {
214  try {
215  type().setSuper(cast->type());
216  } catch (OperationNotAllowed&) {
217  GUM_ERROR(OperationNotAllowed,
218  "this ScalarAttribute can not have cast descendant");
219  } catch (WrongType&) {
220  std::stringstream msg;
221  msg << type().name() << " is not a subtype of " << cast->type().name();
222  GUM_ERROR(WrongType, msg.str());
223  }
224 
225  cast->becomeCastDescendant(type());
226  }
const std::string & name() const
Returns the name of this object.
Definition: PRMType_inl.h:65
void setSuper(PRMType &t)
Changes the PRMType of this PRMType super.
Definition: PRMType_inl.h:77
virtual std::string cast(const PRMType &t) const
Returns the name of the cast descendant with PRMType t of this PRMClassElement.
virtual PRMType & type()
See gum::prm::PRMAttribute.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

◆ setId()

template<typename GUM_SCALAR >
INLINE void gum::prm::PRMClassElement< GUM_SCALAR >::setId ( NodeId  id)
virtualinherited

Used to assign the id of this element.

Definition at line 62 of file PRMClassElement_tpl.h.

Referenced by gum::prm::PRMClass< double >::__addCastDescendants(), gum::prm::PRMInterface< double >::__addCastDescendants(), gum::prm::PRMClass< double >::__checkInterface(), gum::prm::PRMClass< double >::__checkRefInterface(), gum::prm::PRMSlotChain< double >::__copyLastElt(), gum::prm::PRMClass< double >::__inheritClass(), gum::prm::PRMInterface< double >::__inheritInterface(), 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::PRMInterface< double >::add(), gum::prm::PRMClass< double >::add(), gum::prm::PRMClass< double >::inheritAggregates(), gum::prm::PRMClass< double >::inheritParameters(), gum::prm::PRMClass< double >::inheritReferenceSlots(), gum::prm::PRMClass< double >::inheritSlotChains(), and gum::prm::PRMClassElement< double >::isParameter().

62  {
63  __id = id;
64  }
NodeId id() const
Returns the NodeId of this element in it&#39;s class DAG.
NodeId __id
The node&#39;s id of this element.
+ Here is the caller graph for this function:

◆ swap()

template<typename GUM_SCALAR >
void gum::prm::PRMFormAttribute< GUM_SCALAR >::swap ( const PRMType old_type,
const PRMType new_type 
)
virtual

Swap old_type with new_type in the PRMClassElement cpt.

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

Definition at line 321 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__cpf, gum::prm::PRMFormAttribute< GUM_SCALAR >::__formulas, gum::prm::PRMFormAttribute< GUM_SCALAR >::__type, gum::MultiDimImplementation< GUM_SCALAR >::add(), gum::MultiDimImplementation< GUM_SCALAR >::contains(), gum::DiscreteVariable::domainSize(), gum::Instantiation::end(), GUM_ERROR, gum::Instantiation::inc(), gum::prm::PRMType::name(), gum::MultiDimContainer< GUM_SCALAR >::set(), gum::Instantiation::setFirst(), and gum::prm::PRMType::variable().

322  {
323  if (&(old_type) == __type) {
324  GUM_ERROR(OperationNotAllowed, "Cannot replace attribute own type");
325  }
326  if (old_type->domainSize() != new_type->domainSize()) {
327  GUM_ERROR(OperationNotAllowed,
328  "Cannot replace types with difference domain size");
329  }
330  if (!__formulas->contains(old_type.variable())) {
331  GUM_ERROR(NotFound, "could not find variable " + old_type.name());
332  }
333 
334  auto old = __formulas;
335 
336  __formulas = new MultiDimArray< std::string >();
337 
338  for (auto var : old->variablesSequence()) {
339  if (var != &(old_type.variable())) {
340  __formulas->add(*var);
341  } else {
342  __formulas->add(new_type.variable());
343  }
344  }
345 
346  Instantiation inst(__formulas), jnst(old);
347 
348  for (inst.setFirst(), jnst.setFirst(); !(inst.end() || jnst.end());
349  inst.inc(), jnst.inc()) {
350  __formulas->set(inst, old->get(jnst));
351  }
352 
353  delete old;
354 
355  if (__cpf) {
356  delete __cpf;
357  __cpf = 0;
358  }
359 
360  GUM_ASSERT(inst.end() && jnst.end());
361  GUM_ASSERT(__formulas->contains(__type->variable()));
362  GUM_ASSERT(!__formulas->contains(new_type.variable()));
363  GUM_ASSERT(__formulas->contains(new_type.variable()));
364  }
Potential< GUM_SCALAR > * __cpf
A pointer on the Potential of this attribute.
MultiDimImplementation< std::string > * __formulas
A pointer on the Potential of this attribute.
virtual void set(const Instantiation &i, const GUM_SCALAR &value) const
Changes the value pointed by i.
virtual void add(const DiscreteVariable &v) override
Adds a new var to the variables of the multidimensional matrix.
PRMType * __type
The random variable type of this attribute.
virtual bool contains(const DiscreteVariable &v) const override
Returns true if var is in *this.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52
+ Here is the call graph for this function:

◆ type() [1/2]

template<typename GUM_SCALAR >
PRMType & gum::prm::PRMFormAttribute< GUM_SCALAR >::type ( )
virtual

See gum::prm::PRMAttribute.

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

Definition at line 141 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__type.

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::becomeCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant().

141  {
142  return *__type;
143  }
PRMType * __type
The random variable type of this attribute.
+ Here is the caller graph for this function:

◆ type() [2/2]

template<typename GUM_SCALAR >
const PRMType & gum::prm::PRMFormAttribute< GUM_SCALAR >::type ( ) const
virtual

See gum::prm::PRMAttribute.

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

Definition at line 146 of file PRMFormAttribute_tpl.h.

References gum::prm::PRMFormAttribute< GUM_SCALAR >::__type.

146  {
147  return *__type;
148  }
PRMType * __type
The random variable type of this attribute.

Member Data Documentation

◆ __class

template<typename GUM_SCALAR>
const PRMClass< GUM_SCALAR >* gum::prm::PRMFormAttribute< GUM_SCALAR >::__class
private

A pointe toward the class of this attribute.

Definition at line 120 of file PRMFormAttribute.h.

Referenced by gum::prm::PRMFormAttribute< GUM_SCALAR >::__fillCpf(), and gum::prm::PRMFormAttribute< GUM_SCALAR >::copy().

◆ __cpf

◆ __formulas

◆ __type

◆ _safeName

template<typename GUM_SCALAR>
std::string gum::prm::PRMClassElement< GUM_SCALAR >::_safeName
protectedinherited

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