aGrUM  0.14.1
gum::prm::PRMAttribute< GUM_SCALAR > Class Template Referenceabstract

PRMAttribute is a member of a Class in a PRM. More...

#include <PRMAttribute.h>

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

Public Member Functions

Constructors & destructor
 PRMAttribute (const std::string &name)
 Destructor. More...
 
virtual ~PRMAttribute ()
 Destructor. More...
 
Getters & setters
virtual PRMAttribute< GUM_SCALAR > * newFactory (const PRMClass< GUM_SCALAR > &c) const =0
 See gum::PRMClassElement::elt_type(). More...
 
virtual PRMAttribute< GUM_SCALAR > * copy (Bijection< const DiscreteVariable *, const DiscreteVariable * > bij) const =0
 See gum::PRMClassElement::elt_type(). More...
 
virtual void copyCpf (const Bijection< const DiscreteVariable *, const DiscreteVariable * > &bif, const PRMAttribute< GUM_SCALAR > &source)=0
 See gum::PRMClassElement::elt_type(). More...
 
virtual PRMClassElement< GUM_SCALAR >::ClassElementType elt_type () const =0
 See gum::PRMClassElement::elt_type(). More...
 
virtual PRMTypetype ()=0
 See gum::PRMClassElement::type(). More...
 
virtual const PRMTypetype () const =0
 See gum::PRMClassElement::type(). More...
 
virtual const Potential< GUM_SCALAR > & cpf () const =0
 See gum::PRMClassElement::cpf(). More...
 
virtual void addParent (const PRMClassElement< GUM_SCALAR > &elt)=0
 See gum::PRMClassElement::_addParent(). More...
 
virtual void addChild (const PRMClassElement< GUM_SCALAR > &elt)=0
 See gum::PRMClassElement::_addChild(). More...
 
virtual PRMAttribute< GUM_SCALAR > * getCastDescendant () const =0
 Returns a proper cast descendant of this PRMAttribute. More...
 
virtual void setAsCastDescendant (PRMAttribute< GUM_SCALAR > *attr)=0
 Define attr as a cast descendant of this PRMAttribute. More...
 
virtual void becomeCastDescendant (PRMType &subtype)=0
 Change this attribute to be a cast descendant of a an attribute with type subtype. More...
 
virtual void swap (const PRMType &old_type, const PRMType &new_type)=0
 Swap old_type with new_type in the PRMClassElement cpt. More...
 
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

 PRMAttribute (const PRMAttribute< GUM_SCALAR > &source)
 
virtual PRMType_type ()=0
 
virtual void _type (PRMType *t)=0
 

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::PRMAttribute< GUM_SCALAR >

PRMAttribute is a member of a Class in a PRM.

A PRMAttribute is defined by its name, its containing class, its type and by a Conditional Probability Function (aka CPF but represented by a Potential).

An attribute in a PRM is the equivalent of a random variable in a bayesian network.

This class is constructed by a gum::PRMFactory and is deleted by its gum::Class.

Built-in copies (copy constructor and copy operator) are illegal due to various problems raised by redondant information.

See also
PRM PRMFactory Class PRMClassElement PRMType Potential

Definition at line 58 of file PRMAttribute.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

◆ PRMAttribute() [1/2]

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

Destructor.

Definition at line 31 of file PRMAttribute_tpl.h.

31  :
32  PRMClassElement< GUM_SCALAR >(name) {
33  GUM_CONSTRUCTOR(PRMAttribute);
34  }
PRMAttribute(const std::string &name)
Destructor.
const std::string & name() const
Returns the name of this object.
Definition: PRMObject_inl.h:32

◆ ~PRMAttribute()

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

Destructor.

Definition at line 45 of file PRMAttribute_tpl.h.

45  {
46  GUM_DESTRUCTOR(PRMAttribute);
47  }
PRMAttribute(const std::string &name)
Destructor.

◆ PRMAttribute() [2/2]

template<typename GUM_SCALAR>
gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute ( const PRMAttribute< GUM_SCALAR > &  source)
protected

Definition at line 37 of file PRMAttribute_tpl.h.

38  :
39  PRMClassElement< GUM_SCALAR >(source) {
40  GUM_CONS_CPY(PRMAttribute);
41  GUM_ERROR(OperationNotAllowed, "Cannot copy Attributes");
42  }
PRMAttribute(const std::string &name)
Destructor.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:52

Member Function Documentation

◆ _type() [1/2]

template<typename GUM_SCALAR>
virtual PRMType* gum::prm::PRMAttribute< GUM_SCALAR >::_type ( )
protectedpure virtual

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

Referenced by gum::prm::PRMAttribute< double >::overload().

+ Here is the caller graph for this function:

◆ _type() [2/2]

template<typename GUM_SCALAR>
virtual void gum::prm::PRMAttribute< GUM_SCALAR >::_type ( PRMType t)
protectedpure virtual

◆ addChild()

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

◆ addParent()

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

See gum::PRMClassElement::_addParent().

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMFuncAttribute< GUM_SCALAR >.

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

+ Here is the caller graph for this function:

◆ becomeCastDescendant()

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

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

+ Here is the caller 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>
virtual PRMAttribute< GUM_SCALAR >* gum::prm::PRMAttribute< GUM_SCALAR >::copy ( Bijection< const DiscreteVariable *, const DiscreteVariable * >  bij) const
pure virtual

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ copyCpf()

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

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

Referenced by gum::prm::PRMInstance< GUM_SCALAR >::__copyAttributeCPF(), gum::prm::PRMClass< double >::__inheritClass(), and gum::prm::PRMClass< double >::completeInheritance().

+ Here is the caller graph for this function:

◆ cpf()

◆ elt_type()

template<typename GUM_SCALAR>
virtual PRMClassElement< GUM_SCALAR >::ClassElementType gum::prm::PRMAttribute< GUM_SCALAR >::elt_type ( ) const
pure 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.

◆ getCastDescendant()

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

Returns a proper cast descendant of this PRMAttribute.

A cast descendant is an PRMAttribute depending on this one which cast it in this->type().super().

The pointer is not deleted by this PRMAttribute, so delete it yourself after use.

A new cast descendant is created for each call of this method.

Returns
The cast descendant of this PRMAttribute.
Exceptions
OperationNotAllowedRaised if it is not possible to create a cast descendant for this PRMAttribute.

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

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

+ Here is the caller 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>
virtual PRMAttribute< GUM_SCALAR >* gum::prm::PRMAttribute< GUM_SCALAR >::newFactory ( const PRMClass< GUM_SCALAR > &  c) const
pure virtual

See gum::PRMClassElement::elt_type().

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ 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==()

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)
virtual

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>
virtual void gum::prm::PRMAttribute< GUM_SCALAR >::setAsCastDescendant ( PRMAttribute< GUM_SCALAR > *  attr)
pure virtual

Define attr as a cast descendant of this PRMAttribute.

When overloading an inherited PRMAttribute using of subtype of it, it is necessary to change the inherited PRMAttribute CPF to make it a proper cast descendant.

Furthermore it is necessary to change the DiscreteVariable used by this PRMAttribute's super PRMType in order to have the same pointers in both super PRMType (i.e. this->type().super().variable()) and the cast descendant CPF (i.e. attr->cpf()).

This can only be done if attr PRMType is a direct subtype of this PRMAttribute PRMType (i.e. this->type().super() == attr->type()).

Parameters
attrThe PRMAttribute which is transformed to be this PRMAttribute cast descendant.
Exceptions
OperationNotAllowedRaised if this PRMAttribute can not have any cast descendant.
TypeErrorRaised if attr's PRMType is not a direct descendant of this PRMAttribute's PRMType.

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

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

+ Here is the caller 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>
virtual void gum::prm::PRMAttribute< GUM_SCALAR >::swap ( const PRMType old_type,
const PRMType new_type 
)
pure virtual

Swap old_type with new_type in the PRMClassElement cpt.

Implemented in gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMFormAttribute< GUM_SCALAR >.

◆ type() [1/2]

◆ type() [2/2]

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

Member Data Documentation

◆ _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: