aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
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 (std::string_view name)
 Destructor.
 ~PRMAttribute () override
 Destructor.
Getters & setters
virtual PRMAttribute< GUM_SCALAR > * newFactory (const PRMClass< GUM_SCALAR > &c) const =0
 See gum::PRMClassElement::elt_type().
virtual PRMAttribute< GUM_SCALAR > * copy (Bijection< const DiscreteVariable *, const DiscreteVariable * > bij) const =0
 See gum::PRMClassElement::elt_type().
virtual void copyCpf (const Bijection< const DiscreteVariable *, const DiscreteVariable * > &bif, const PRMAttribute< GUM_SCALAR > &source)=0
 See gum::PRMClassElement::elt_type().
PRMClassElement< GUM_SCALAR >::ClassElementType elt_type () const override=0
 See gum::PRMClassElement::elt_type().
PRMTypetype () override=0
 See gum::PRMClassElement::type().
const PRMTypetype () const override=0
 See gum::PRMClassElement::type().
const Tensor< GUM_SCALAR > & cpf () const override=0
 See gum::PRMClassElement::cpf().
void addParent (const PRMClassElement< GUM_SCALAR > &elt) override=0
 See gum::PRMClassElement::addParent_().
void addChild (const PRMClassElement< GUM_SCALAR > &elt) override=0
 See gum::PRMClassElement::addChild_().
PRMAttribute< GUM_SCALAR > * getCastDescendant () const override=0
 Returns a proper cast descendant of this PRMAttribute.
virtual void setAsCastDescendant (PRMAttribute< GUM_SCALAR > *attr)=0
 Define attr as a cast descendant of this PRMAttribute.
virtual void becomeCastDescendant (PRMType &subtype)=0
 Change this attribute to be a cast descendant of a an attribute with type subtype.
virtual void swap (const PRMType &old_type, const PRMType &new_type)=0
 Swap old_type with new_type in the PRMClassElement cpt.
virtual void overload (PRMAttribute< GUM_SCALAR > *source)
 Set this as overload of source (necessayr to preserver internal pointers for MultiDims).
Getters & setters
NodeId id () const
 Returns the NodeId of this element in it's class DAG.
virtual void setId (NodeId id)
 Used to assign the id of this element.
PRMObject::prm_type obj_type () const override
Fast access to random variable's properties
const std::string & safeName () const
 Returns the safe name of this PRMClassElement, if any.
virtual std::string cast (const PRMType &t) const
 Returns the name of the cast descendant with PRMType t of this PRMClassElement.
Getters & setters.
const std::string & name () const
 Returns the name of this object.
void name (std::string_view name)
 Change the name of the PRM Object.
Operators
bool operator== (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique).
bool operator!= (const PRMObject &obj) const
 To PRMObject are equal if they have the same name (which is unique).

Protected Member Functions

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

Protected Attributes

std::string safeName_
 The safe name of this PRMClassElement.

Private Attributes

NodeId _id_
 The node's id of this element.
Private members.
std::string _name_

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.
static INLINE bool isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMReferenceSlot.
static INLINE bool isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
 Returns true if obj_ptr is of type PRMAttribute.
static INLINE bool isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMAggregate.
static INLINE bool isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMSlotChain.
static INLINE bool isParameter (const PRMClassElement< GUM_SCALAR > &elt)
 Return true if obj is of type PRMParameter.

Built-in types.

enum class  prm_type : char {
  ALL , CLASS , PRM_INTERFACE , CLASS_ELT ,
  TYPE , SYSTEM , 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.
static std::string LEFT_CAST ()
 Enumeration of the different types of objects handled by a PRM.
static std::string RIGHT_CAST ()
 Enumeration of the different types of objects handled by a PRM.
static INLINE bool isClass (const PRMObject &obj)
 Returns true if obj_ptr is of type Class.
static INLINE bool isInterface (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInterface.
static INLINE bool isInstance (const PRMObject &obj)
 Returns true if obj_ptr is of type PRMInstance.

Detailed Description

template<GUM_Numeric 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 Tensor).

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

See also
PRM PRMFactory Class PRMClassElement PRMType Tensor

Definition at line 79 of file PRMAttribute.h.

Member Enumeration Documentation

◆ ClassElementType

template<GUM_Numeric 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 109 of file PRMClassElement.h.

◆ prm_type

enum class 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 90 of file PRMObject.h.

90: char { ALL, CLASS, PRM_INTERFACE, CLASS_ELT, TYPE, SYSTEM, INSTANCE };

Constructor & Destructor Documentation

◆ PRMAttribute() [1/2]

template<GUM_Numeric GUM_SCALAR>
gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute ( std::string_view name)
explicit

Destructor.

Definition at line 56 of file PRMAttribute_tpl.h.

56 :
59 }
PRMAttribute is a member of a Class in a PRM.
PRMAttribute(std::string_view name)
Destructor.
PRMClassElement(std::string_view name)
Default constructor of a PRMClassElement.
const std::string & name() const
Returns the name of this object.

References PRMAttribute(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), and gum::prm::PRMObject::name().

Referenced by PRMAttribute(), PRMAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), ~PRMAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), copyCpf(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copyCpf(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copyCpf(), getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), newFactory(), overload(), setAsCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant(), and swap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~PRMAttribute()

template<GUM_Numeric GUM_SCALAR>
gum::prm::PRMAttribute< GUM_SCALAR >::~PRMAttribute ( )
override

Destructor.

Definition at line 69 of file PRMAttribute_tpl.h.

69 {
71 }

References PRMAttribute().

Here is the call graph for this function:

◆ PRMAttribute() [2/2]

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

Definition at line 62 of file PRMAttribute_tpl.h.

62 :
65 GUM_ERROR(OperationNotAllowed, "Cannot copy Attributes")
66 }
#define GUM_ERROR(type, msg)
Definition exceptions.h:76

References PRMAttribute(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), and GUM_ERROR.

Here is the call graph for this function:

Member Function Documentation

◆ addChild()

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

See gum::PRMClassElement::addChild_().

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

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

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement().

Here is the call graph for this function:

◆ addParent()

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

See gum::PRMClassElement::addParent_().

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

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

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ becomeCastDescendant()

template<GUM_Numeric 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

◆ cast()

template<GUM_Numeric GUM_SCALAR>
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 93 of file PRMClassElement_tpl.h.

93 {
94 if (type().isSubTypeOf(t)) {
96 } else {
97 GUM_ERROR(OperationNotAllowed, "illegal cast")
98 }
99 }
Abstract class representing an element of PRM class.
virtual PRMType & type()=0
Return a reference over the gum::PRMType of this class element.
static std::string RIGHT_CAST()
Enumeration of the different types of objects handled by a PRM.
static std::string LEFT_CAST()
Enumeration of the different types of objects handled by a PRM.

References GUM_ERROR, gum::prm::PRMObject::LEFT_CAST(), gum::prm::PRMObject::name(), gum::prm::PRMType::name(), gum::prm::PRMObject::RIGHT_CAST(), and type().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ copy()

template<GUM_Numeric 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

◆ copyCpf()

template<GUM_Numeric 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

References PRMAttribute().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cpf()

◆ elt_type()

template<GUM_Numeric GUM_SCALAR>
PRMClassElement< GUM_SCALAR >::ClassElementType gum::prm::PRMAttribute< GUM_SCALAR >::elt_type ( ) const
overridepure virtual

◆ enum2str() [1/2]

template<GUM_Numeric GUM_SCALAR>
std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType type)
staticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 102 of file PRMClassElement_tpl.h.

102 {
103 switch (type) {
104 case prm_attribute : return "prm_attribute";
105
106 case prm_aggregate : return "prm_aggregate";
107
108 case prm_refslot : return "prm_refslot";
109
110 case prm_slotchain : return "prm_slotchain";
111
112 case prm_parameter : return "prm_parameter";
113
114 default : return "unknown";
115 }
116 }

References prm_aggregate, prm_attribute, prm_parameter, prm_refslot, prm_slotchain, and type().

Here is the call graph for this function:

◆ enum2str() [2/2]

INLINE std::string gum::prm::PRMObject::enum2str ( prm_type type)
staticinherited

Returns the string representation of a PRMObject.

Definition at line 75 of file PRMObject_inl.h.

75 {
76 switch (type) {
77 case prm_type::CLASS : return "PRMType::CLASS";
78
79 case prm_type::CLASS_ELT : return "PRMType::CLASS_ELT";
80
81 case prm_type::TYPE : return "PRMType::TYPE";
82
83 case prm_type::SYSTEM : return "PRMType::SYSTEM";
84
85 case prm_type::INSTANCE : return "PRMType::INSTANCE";
86
87 case prm_type::PRM_INTERFACE : return "PRMType::PRM_INTERFACE";
88
89 default : return "unknown";
90 }
91 }

References CLASS, CLASS_ELT, INSTANCE, PRM_INTERFACE, SYSTEM, and TYPE.

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

Here is the caller graph for this function:

◆ getCastDescendant()

template<GUM_Numeric GUM_SCALAR>
PRMAttribute< GUM_SCALAR > * gum::prm::PRMAttribute< GUM_SCALAR >::getCastDescendant ( ) const
overridepure 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

References PRMAttribute().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), and gum::prm::PRMInterface< GUM_SCALAR >::add().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ id()

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

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

Definition at line 73 of file PRMClassElement_tpl.h.

73 {
74 return _id_;
75 }
NodeId _id_
The node's id of this element.

References _id_.

Referenced by PRMClassElement(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::SVE< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::InstanceBayesNet< GUM_SCALAR >::_init_(), gum::prm::PRMInstance< GUM_SCALAR >::_instantiateSlotChain_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::addArc(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::SVE< GUM_SCALAR >::posterior_(), gum::prm::SVED< GUM_SCALAR >::posterior_(), setId(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

◆ isAggregate()

template<GUM_Numeric GUM_SCALAR>
bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > & elt)
staticinherited

Return true if obj is of type PRMAggregate.

Definition at line 129 of file PRMClassElement_tpl.h.

129 {
130 return elt.elt_type() == prm_aggregate;
131 }
virtual ClassElementType elt_type() const =0
Return the type of class element this object is.

References PRMClassElement(), elt_type(), and prm_aggregate.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAggregator(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isAttribute()

◆ isClass()

INLINE bool gum::prm::PRMObject::isClass ( const PRMObject & obj)
staticinherited

Returns true if obj_ptr is of type Class.

Definition at line 93 of file PRMObject_inl.h.

93 {
94 return obj.obj_type() == prm_type::CLASS;
95 }

References PRMObject().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::scope(), and gum::prm::PRMFactory< GUM_SCALAR >::startAttribute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isInstance()

INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject & obj)
staticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 101 of file PRMObject_inl.h.

101 {
102 return obj.obj_type() == prm_type::INSTANCE;
103 }

References PRMObject(), INSTANCE, and obj_type().

Here is the call graph for this function:

◆ isInterface()

INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject & obj)
staticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 97 of file PRMObject_inl.h.

97 {
98 return obj.obj_type() == prm_type::PRM_INTERFACE;
99 }

◆ isParameter()

template<GUM_Numeric GUM_SCALAR>
bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > & elt)
staticinherited

Return true if obj is of type PRMParameter.

Definition at line 139 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_parameter.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkParameters_(), and gum::prm::PRMClass< GUM_SCALAR >::add().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isReferenceSlot()

template<GUM_Numeric GUM_SCALAR>
bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > & elt)
staticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 119 of file PRMClassElement_tpl.h.

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

References PRMClassElement(), elt_type(), and prm_refslot.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkAssignments_(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::_checkIncrements_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkReferenceSlot_(), gum::prm::PRMInterface< GUM_SCALAR >::add(), and gum::prm::PRMFactory< GUM_SCALAR >::setReferenceSlot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isSlotChain()

template<GUM_Numeric GUM_SCALAR>
bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > & elt)
staticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 134 of file PRMClassElement_tpl.h.

134 {
135 return elt.elt_type() == prm_slotchain;
136 }

References PRMClassElement(), elt_type(), and prm_slotchain.

Referenced by gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::PRMFactory< GUM_SCALAR >::_retrieveInputs_(), gum::prm::PRMClass< GUM_SCALAR >::add(), and gum::prm::PRMFactory< GUM_SCALAR >::addNoisyOrCompound().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LEFT_CAST()

INLINE std::string gum::prm::PRMObject::LEFT_CAST ( )
staticinherited

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

71{ return "("; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

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

57{ return _name_; }
std::string _name_
Definition PRMObject.h:193

References _name_.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClass< GUM_SCALAR >::PRMClass(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainer(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMFuncAttribute< GUM_SCALAR >::PRMFuncAttribute(), gum::prm::PRMInstance< GUM_SCALAR >::PRMInstance(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), gum::prm::PRMInterface< GUM_SCALAR >::PRMInterface(), PRMObject(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSystem< GUM_SCALAR >::PRMSystem(), gum::prm::__print_attribute__(), gum::prm::__print_instance__(), gum::prm::SVE< GUM_SCALAR >::_addDelayedVariable_(), gum::prm::PRMClass< GUM_SCALAR >::_addIOInterfaceFlags_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_addReferingInstance_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMFactory< GUM_SCALAR >::_checkInterfaceImplementation_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRawCPT_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkRefInterfaces_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkRuleCPTSumsTo1_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAggregates_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttribute_(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundAgg_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundTensor_(), gum::prm::PRMSystem< double >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMSystem< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFormAttribute< GUM_SCALAR >::copy(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::copy(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists(), gum::prm::PRMInstance< GUM_SCALAR >::exists(), gum::prm::PRMSystem< GUM_SCALAR >::exists(), gum::prm::o3prmr::O3prmrInterpreter::findAttributeName(), gum::prm::o3prmr::O3prmrInterpreter::findInstanceName(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClass< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInstance< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMInterface< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::get(), gum::prm::PRMSystem< GUM_SCALAR >::getArray(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMSystem< GUM_SCALAR >::getArrayType(), gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMFormAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::getCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::groundedBN(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMSystem< GUM_SCALAR >::isArray(), gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant(), gum::prm::PRMSystem< GUM_SCALAR >::isInstance(), name(), gum::prm::PRMType::name(), gum::prm::PRMFormAttribute< GUM_SCALAR >::newFactory(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::newFactory(), operator!=(), operator<<(), gum::prm::PRMClass< GUM_SCALAR >::operator=(), operator==(), gum::prm::PRMType::operator==(), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMClassElementContainer< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMInterface< GUM_SCALAR >::operator[](), gum::prm::PRMClass< GUM_SCALAR >::overload(), gum::prm::PRMInterface< GUM_SCALAR >::overload(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::PRMClassElementContainterConstIterator, gum::prm::PRMFormAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::setAsCastDescendant(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode(), gum::prm::PRMFactory< GUM_SCALAR >::startClass(), gum::prm::PRMFactory< GUM_SCALAR >::startInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::startSystem().

◆ name() [2/2]

INLINE void gum::prm::PRMObject::name ( std::string_view name)
inherited

Change the name of the PRM Object.

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

Definition at line 61 of file PRMObject_inl.h.

61{ _name_ = name; }

References _name_, and name().

Here is the call graph for this function:

◆ newFactory()

template<GUM_Numeric 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

References PRMAttribute().

Here is the call graph for this function:

◆ obj_type()

template<GUM_Numeric GUM_SCALAR>
PRMObject::prm_type gum::prm::PRMClassElement< GUM_SCALAR >::obj_type ( ) const
overridevirtualinherited
See also
gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 78 of file PRMClassElement_tpl.h.

78 {
80 }

References gum::prm::PRMObject::CLASS_ELT.

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

69{ return _name_ != obj.name(); }

References PRMObject(), _name_, and name().

Here is the call 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 65 of file PRMObject_inl.h.

65{ return _name_ == obj.name(); }

References PRMObject(), _name_, and name().

Here is the call graph for this function:

◆ overload()

template<GUM_Numeric 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 74 of file PRMAttribute_tpl.h.

74 {
75 auto old_type = this->type_();
76 this->type_(source->type_());
78 }
virtual PRMType * type_()=0

References PRMAttribute(), and type_().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), and gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RIGHT_CAST()

INLINE std::string gum::prm::PRMObject::RIGHT_CAST ( )
staticinherited

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

73{ return ")"; }

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMClassElement< GUM_SCALAR >::cast(), and gum::prm::decomposePath().

Here is the caller graph for this function:

◆ safeName()

template<GUM_Numeric GUM_SCALAR>
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 88 of file PRMClassElement_tpl.h.

88 {
89 return safeName_;
90 }
std::string safeName_
The safe name of this PRMClassElement.

References safeName_.

Referenced by gum::prm::__print_attribute__(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMInstance< GUM_SCALAR >::_copyAttributeCPF_(), gum::prm::SVED< GUM_SCALAR >::_getAggTensor_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundRef_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundTensor_(), gum::prm::PRMClass< GUM_SCALAR >::_inheritClass_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAggregate_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadAttribute_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadParameter_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::_overloadReferenceSlot_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::gspan::StrictSearch< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::StructuredInference< GUM_SCALAR >::_str_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMFactory< GUM_SCALAR >::addAggregator(), gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::belongsTo(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::getIOFlag_(), gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInnerNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::isInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setInputNode(), gum::prm::PRMClassElementContainer< GUM_SCALAR >::setIOFlag_(), and gum::prm::PRMClassElementContainer< GUM_SCALAR >::setOutputNode().

◆ setAsCastDescendant()

template<GUM_Numeric 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.
PRMTypeErrorRaised if attr's PRMType is not a direct descendant of this PRMAttribute's PRMType.

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

References PRMAttribute().

Referenced by gum::prm::PRMClass< GUM_SCALAR >::_addCastDescendants_(), and gum::prm::PRMInterface< GUM_SCALAR >::_addCastDescendants_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setId()

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

◆ swap()

template<GUM_Numeric 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::PRMFormAttribute< GUM_SCALAR >, and gum::prm::PRMScalarAttribute< GUM_SCALAR >.

References PRMAttribute().

Here is the call graph for this function:

◆ type() [1/2]

template<GUM_Numeric GUM_SCALAR>
const PRMType & gum::prm::PRMAttribute< GUM_SCALAR >::type ( ) const
overridepure virtual

◆ type() [2/2]

◆ type_() [1/2]

template<GUM_Numeric GUM_SCALAR>
virtual PRMType * gum::prm::PRMAttribute< GUM_SCALAR >::type_ ( )
protectedpure virtual

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

Referenced by overload().

Here is the caller graph for this function:

◆ type_() [2/2]

template<GUM_Numeric GUM_SCALAR>
virtual void gum::prm::PRMAttribute< GUM_SCALAR >::type_ ( PRMType * t)
protectedpure virtual

Member Data Documentation

◆ _id_

template<GUM_Numeric GUM_SCALAR>
NodeId gum::prm::PRMClassElement< GUM_SCALAR >::_id_
privateinherited

The node's id of this element.

Definition at line 254 of file PRMClassElement.h.

Referenced by PRMClassElement(), id(), and setId().

◆ _name_

std::string gum::prm::PRMObject::_name_
privateinherited

Definition at line 193 of file PRMObject.h.

Referenced by PRMObject(), PRMObject(), PRMObject(), name(), name(), operator!=(), operator=(), and operator==().

◆ safeName_


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