gum::prm::PRMClassElement< GUM_SCALAR > Class Template Reference

Abstract class representing an element of PRM class. More...

#include <PRMClassElement.h>

Inheritance diagram for gum::prm::PRMClassElement< GUM_SCALAR >:

Collaboration diagram for gum::prm::PRMClassElement< GUM_SCALAR >:

Public Member Functions
Constructor & Destructor.
	PRMClassElement (std::string_view name)
	Default constructor of a PRMClassElement.
	PRMClassElement (const PRMClassElement< GUM_SCALAR > &source)
	Copy constructor.
	~PRMClassElement () override
	Destructor of this class.
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.
virtual void	addParent (const PRMClassElement< GUM_SCALAR > &elt)=0
	Add a parent to this element.
virtual void	addChild (const PRMClassElement< GUM_SCALAR > &elt)=0
	Add a child to this element.
PRMObject::prm_type	obj_type () const override
virtual ClassElementType	elt_type () const =0
	Return the type of class element this object is.
Fast access to random variable's properties
virtual PRMType &	type ()=0
	Return a reference over the gum::PRMType of this class element.
virtual const PRMType &	type () const =0
	Return a constant reference over the gum::PRMType of this class element.
virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const =0
	Returns a proper cast descendant of this PRMAttribute.
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.
virtual const Tensor< GUM_SCALAR > &	cpf () const =0
	Return a constant reference over the gum::Tensor of this class element.
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 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	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 std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject.
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::PRMClassElement< GUM_SCALAR >

Abstract class representing an element of PRM class.

All class elements are nodes in the class's DAG and a unique name in their class.

Definition at line 75 of file PRMClassElement.h.

Member Enumeration Documentation

ClassElementType

template<GUM_Numeric GUM_SCALAR>

enum gum::prm::PRMClassElement::ClassElementType

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_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

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.

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

Constructor & Destructor Documentation

PRMClassElement() [1/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement ( std::string_view name )

explicit

Default constructor of a PRMClassElement.

The PRMClassElement will automatically add itself to c.

Parameters

name	The name of this element, must be unique in it's class.

Exceptions

DupplicateElement

Raised if c contains already an element with the same name.

Definition at line 57 of file PRMClassElement_tpl.h.

                                                                      : PRMObject(name) {
      GUM_CONSTRUCTOR(PRMClassElement);
    }

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

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute(), gum::prm::PRMAttribute< GUM_SCALAR >::PRMAttribute(), PRMClassElement(), PRMClassElement(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), ~PRMClassElement(), gum::prm::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), gum::prm::PRMAggregate< GUM_SCALAR >::addChild(), gum::prm::PRMAttribute< GUM_SCALAR >::addChild(), addChild(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::addChild(), gum::prm::PRMSlotChain< GUM_SCALAR >::addChild(), gum::prm::PRMAggregate< GUM_SCALAR >::addParent(), gum::prm::PRMAttribute< GUM_SCALAR >::addParent(), addParent(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::addParent(), gum::prm::PRMSlotChain< GUM_SCALAR >::addParent(), isAggregate(), isAttribute(), isParameter(), isReferenceSlot(), isSlotChain(), gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt(), and gum::prm::PRMSlotChain< GUM_SCALAR >::lastElt().

Here is the call graph for this function:

PRMClassElement() [2/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement

(

const PRMClassElement< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 62 of file PRMClassElement_tpl.h.

                                                                                              :
        PRMObject(source.name()), _id_(source.id()) {
      GUM_CONS_CPY(PRMClassElement);
    }

References PRMClassElement(), gum::prm::PRMObject::PRMObject(), _id_, id(), and gum::prm::PRMObject::name().

Here is the call graph for this function:

~PRMClassElement()

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMClassElement< GUM_SCALAR >::~PRMClassElement ( )

override

Destructor of this class.

Definition at line 68 of file PRMClassElement_tpl.h.

                                                    {
      GUM_DESTRUCTOR(PRMClassElement);
    }

References PRMClassElement().

Here is the call graph for this function:

Member Function Documentation

addChild()

template<GUM_Numeric GUM_SCALAR>

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

pure virtual

Add a child to this element.

This methos is called by gum::Class when a child is added to this element.

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMFuncAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

References PRMClassElement().

Here is the call graph for this function:

addParent()

template<GUM_Numeric GUM_SCALAR>

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

pure virtual

Add a parent to this element.

This method is called by gum::Class when en parent is added to this elememnt.

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMFuncAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

References PRMClassElement().

Here is the call graph for this function:

cast()

template<GUM_Numeric GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::cast ( const PRMType & t ) const

virtual

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

Parameters

t	The type in which we want to cast this PRMClassElement.

Exceptions

OperationNotAllowed

If the cast is impossible.

Definition at line 93 of file PRMClassElement_tpl.h.

                                                                        {
      if (type().isSubTypeOf(t)) {
        return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST() + name();
      } else {
        GUM_ERROR(OperationNotAllowed, "illegal cast")
      }
    }

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:

cpf()

template<GUM_Numeric GUM_SCALAR>

virtual const Tensor< GUM_SCALAR > & gum::prm::PRMClassElement< GUM_SCALAR >::cpf ( ) const

pure virtual

Return a constant reference over the gum::Tensor of this class element.

        Return a reference over the gum::Tensor of this class element.
        @throw OperationNotAllowed Raised if this class element doesn't have
                                   any gum::Tensor (like a

gum::PRMReferenceSlot).

Exceptions

OperationNotAllowed

Raised if the class element doesn't have any gum::Tensor (like a gum::PRMReferenceSlot).

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

elt_type()

template<GUM_Numeric GUM_SCALAR>

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

pure virtual

Return the type of class element this object is.

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addNode_(), gum::prm::PRMFactory< GUM_SCALAR >::_addParent_(), gum::prm::PRMClass< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMInterface< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMFactory< GUM_SCALAR >::_checkStack_(), gum::prm::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInstance< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::addArc(), isAggregate(), isAttribute(), isParameter(), isReferenceSlot(), isSlotChain(), gum::prm::PRMClass< GUM_SCALAR >::overload(), and gum::prm::PRMInterface< GUM_SCALAR >::overload().

Here is the caller graph for this function:

enum2str() [1/2]

template<GUM_Numeric GUM_SCALAR>

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

static

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 102 of file PRMClassElement_tpl.h.

                                                                           {
      switch (type) {
        case prm_attribute : return "prm_attribute";
 
        case prm_aggregate : return "prm_aggregate";
 
        case prm_refslot : return "prm_refslot";
 
        case prm_slotchain : return "prm_slotchain";
 
        case prm_parameter : return "prm_parameter";
 
        default : return "unknown";
      }
    }

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.

                                                      {
      switch (type) {
        case prm_type::CLASS : return "PRMType::CLASS";
 
        case prm_type::CLASS_ELT : return "PRMType::CLASS_ELT";
 
        case prm_type::TYPE : return "PRMType::TYPE";
 
        case prm_type::SYSTEM : return "PRMType::SYSTEM";
 
        case prm_type::INSTANCE : return "PRMType::INSTANCE";
 
        case prm_type::PRM_INTERFACE : return "PRMType::PRM_INTERFACE";
 
        default : return "unknown";
      }
    }

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>

virtual PRMAttribute< GUM_SCALAR > * gum::prm::PRMClassElement< 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

OperationNotAllowed

Raised if it is not possible to create a cast descendant for this PRMAttribute.

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

id()

template<GUM_Numeric GUM_SCALAR>

NodeId gum::prm::PRMClassElement< GUM_SCALAR >::id

(

)

const

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

Definition at line 73 of file PRMClassElement_tpl.h.

                                                   {
      return _id_;
    }

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 )

static

Return true if obj is of type PRMAggregate.

Definition at line 129 of file PRMClassElement_tpl.h.

                                                                                            {
      return elt.elt_type() == prm_aggregate;
    }

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

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > & elt )

static

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 124 of file PRMClassElement_tpl.h.

                                                                                            {
      return elt.elt_type() == prm_attribute;
    }

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

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::CData::CData(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::o3prm::O3ClassFactory< GUM_SCALAR >::_checkLocalParent_(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMSystem< double >::_groundRef_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::SVE< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::SVED< GUM_SCALAR >::_initLiftedNodes_(), gum::prm::PRMClass< GUM_SCALAR >::_overloadReference_(), gum::prm::PRMInterface< GUM_SCALAR >::add(), gum::prm::PRMClass< GUM_SCALAR >::completeInheritance(), gum::prm::PRMFactory< GUM_SCALAR >::continueAttribute(), 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:

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.

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

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.

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

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.

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

isParameter()

template<GUM_Numeric GUM_SCALAR>

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

static

Return true if obj is of type PRMParameter.

Definition at line 139 of file PRMClassElement_tpl.h.

                                                                                            {
      return elt.elt_type() == prm_parameter;
    }

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 )

static

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 119 of file PRMClassElement_tpl.h.

                                                                                                {
      return elt.elt_type() == prm_refslot;
    }

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 )

static

Return true if obj is of type PRMSlotChain.

Definition at line 134 of file PRMClassElement_tpl.h.

                                                                                            {
      return elt.elt_type() == prm_slotchain;
    }

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.

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

{ return _name_; }

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.

{ _name_ = name; }

References _name_, and name().

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

overridevirtual

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 78 of file PRMClassElement_tpl.h.

                                                                    {
      return prm_type::CLASS_ELT;
    }

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.

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

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

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

Here is the call 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.

{ 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

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.

                                                                   {
      return safeName_;
    }

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

setId()

template<GUM_Numeric GUM_SCALAR>

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

virtual

Used to assign the id of this element.

Definition at line 83 of file PRMClassElement_tpl.h.

                                                       {
      _id_ = id;
    }

References _id_, and id().

Referenced by 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::PRMSlotChain< GUM_SCALAR >::_copyLastElt_(), 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::PRMClass< GUM_SCALAR >::add(), gum::prm::PRMInterface< GUM_SCALAR >::add(), and gum::prm::PRMClass< GUM_SCALAR >::inheritAggregates().

Here is the call graph for this function:

Here is the caller graph for this function:

type() [1/2]

template<GUM_Numeric GUM_SCALAR>

virtual const PRMType & gum::prm::PRMClassElement< GUM_SCALAR >::type ( ) const

pure virtual

Return a constant reference over the gum::PRMType of this class element.

Exceptions

OperationNotAllowed

Raised if this class element doesn't have any gum::Tensor (like a gum::PRMReferenceSlot).

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

type() [2/2]

template<GUM_Numeric GUM_SCALAR>

virtual PRMType & gum::prm::PRMClassElement< GUM_SCALAR >::type ( )

pure virtual

Return a reference over the gum::PRMType of this class element.

Exceptions

OperationNotAllowed

Raised if this class element doesn't have any gum::Tensor (like a gum::PRMReferenceSlot).

Implemented in gum::prm::PRMAggregate< GUM_SCALAR >, gum::prm::PRMAttribute< GUM_SCALAR >, gum::prm::PRMFormAttribute< GUM_SCALAR >, gum::prm::PRMParameter< GUM_SCALAR >, gum::prm::PRMReferenceSlot< GUM_SCALAR >, gum::prm::PRMScalarAttribute< GUM_SCALAR >, and gum::prm::PRMSlotChain< GUM_SCALAR >.

Referenced by gum::prm::ClassDependencyGraph< GUM_SCALAR >::_addNode_(), gum::prm::PRMClass< GUM_SCALAR >::_checkInterface_(), gum::prm::PRMClass< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMInterface< GUM_SCALAR >::_checkOverloadLegality_(), gum::prm::PRMSystem< GUM_SCALAR >::_groundAgg_(), gum::prm::ClassBayesNet< GUM_SCALAR >::_init_(), gum::prm::PRMFormAttribute< GUM_SCALAR >::addParent(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::addParent(), cast(), enum2str(), and gum::prm::PRMClass< GUM_SCALAR >::isCastDescendant().

Here is the caller graph for this function:

Member Data Documentation

_id_

template<GUM_Numeric GUM_SCALAR>

NodeId gum::prm::PRMClassElement< GUM_SCALAR >::_id_

private

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_

template<GUM_Numeric GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::safeName_

protected

The safe name of this PRMClassElement.

Definition at line 250 of file PRMClassElement.h.

Referenced by gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate(), gum::prm::PRMFormAttribute< GUM_SCALAR >::PRMFormAttribute(), gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter(), gum::prm::PRMReferenceSlot< GUM_SCALAR >::PRMReferenceSlot(), gum::prm::PRMScalarAttribute< GUM_SCALAR >::PRMScalarAttribute(), gum::prm::PRMSlotChain< GUM_SCALAR >::PRMSlotChain(), and safeName().

---

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

• agrum/PRM/elements/PRMClassElement.h
• agrum/PRM/elements/PRMClassElement_tpl.h