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

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

#include <PRMParameter.h>

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

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

Public Types
enum	ParameterType { INT , REAL }

Public Member Functions
Constructor & destructor.
	PRMParameter (std::string_view name, ParameterType type, GUM_SCALAR value)
	Constructor used by gum::Class.
	~PRMParameter () override
	Destructor.
Getters & setters
PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const override
	See gum::PRMClassElement::elt_type().
GUM_SCALAR	value () const
	See gum::PRMClassElement::elt_type().
void	value (GUM_SCALAR value)
	See gum::PRMClassElement::elt_type().
ParameterType	valueType () const
	See gum::PRMClassElement::elt_type().
PRMType &	type () override
	See gum::PRMClassElement::type().
const PRMType &	type () const override
	See gum::PRMClassElement::type().
virtual Tensor< GUM_SCALAR > &	cpf ()
	See gum::PRMClassElement::cpf().
const Tensor< GUM_SCALAR > &	cpf () const override
	See gum::PRMClassElement::cpf().
void	addParent (const gum::prm::PRMClassElement< GUM_SCALAR > &) override
	See gum::PRMClassElement::addParent().
void	addChild (const gum::prm::PRMClassElement< GUM_SCALAR > &) override
	See gum::PRMClassElement::addChild().
PRMAttribute< GUM_SCALAR > *	getCastDescendant () const override
	Raise a gum::OperationNotAllowed See gum::PRMClassElement::getCastDescendant().
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
	PRMParameter (const PRMParameter< GUM_SCALAR > &source)
	Copy constructor. Don't use it.
PRMParameter< GUM_SCALAR > &	operator= (const PRMParameter< GUM_SCALAR > &from)
	Copy operator. Don't use it.

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

Private Attributes
NodeId	_id_
	The node's id of this element.
Private members
ParameterType	_type_
GUM_SCALAR	_value_
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::PRMParameter< GUM_SCALAR >

PRMParameter is a member of a Class in a PRM.

See also

PRM PRMFactory Class PRMClassElement

Definition at line 68 of file PRMParameter.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_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

ParameterType

template<GUM_Numeric GUM_SCALAR>

enum gum::prm::PRMParameter::ParameterType

Enumerator
INT
REAL

Definition at line 70 of file PRMParameter.h.

{ INT, REAL };

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

PRMParameter() [1/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter	(	std::string_view	name,
		ParameterType	type,
		GUM_SCALAR	value )

Constructor used by gum::Class.

Parameters

name
type
value

Definition at line 56 of file PRMParameter_tpl.h.

                                                                     :
        PRMClassElement< GUM_SCALAR >(name), _type_(type), _value_(value) {
      GUM_CONSTRUCTOR(PRMParameter);
      this->safeName_ = name;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMParameter(), _type_, _value_, gum::prm::PRMObject::name(), gum::prm::PRMClassElement< GUM_SCALAR >::safeName_, type(), and value().

Referenced by PRMParameter(), PRMParameter(), ~PRMParameter(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

~PRMParameter()

template<GUM_Numeric GUM_SCALAR>

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

override

Destructor.

Definition at line 78 of file PRMParameter_tpl.h.

                                              {
      GUM_DESTRUCTOR(PRMParameter);
    }

References PRMParameter().

Here is the call graph for this function:

PRMParameter() [2/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::PRMParameter< GUM_SCALAR >::PRMParameter ( const PRMParameter< GUM_SCALAR > & source )

protected

Copy constructor. Don't use it.

Definition at line 65 of file PRMParameter_tpl.h.

                                                                                     :
        PRMClassElement< GUM_SCALAR >(source.name()), _type_(source.valueType()),
        _value_(source.value()) {
      GUM_ERROR(OperationNotAllowed, "cannot copy Paramter<GUM_SCALAR")
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::PRMClassElement(), PRMParameter(), _type_, _value_, GUM_ERROR, gum::prm::PRMObject::name(), value(), and valueType().

Here is the call graph for this function:

Member Function Documentation

addChild()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

See gum::PRMClassElement::addChild().

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

Definition at line 130 of file PRMParameter_tpl.h.

                                                                                        {
      GUM_ERROR(OperationNotAllowed, "Parameters can not have children")
    }

References GUM_ERROR.

addParent()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

See gum::PRMClassElement::addParent().

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

Definition at line 125 of file PRMParameter_tpl.h.

                                                                                         {
      GUM_ERROR(OperationNotAllowed, "Parameters can not have parents")
    }

References GUM_ERROR.

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

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() [1/2]

template<GUM_Numeric GUM_SCALAR>

Tensor< GUM_SCALAR > & gum::prm::PRMParameter< GUM_SCALAR >::cpf ( )

virtual

See gum::PRMClassElement::cpf().

Definition at line 115 of file PRMParameter_tpl.h.

                                                          {
      GUM_ERROR(OperationNotAllowed, "Parameters do not have a cpf")
    }

References GUM_ERROR.

cpf() [2/2]

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

See gum::PRMClassElement::cpf().

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

Definition at line 120 of file PRMParameter_tpl.h.

                                                                      {
      GUM_ERROR(OperationNotAllowed, "Parameters do not have a cpf")
    }

References GUM_ERROR.

elt_type()

template<GUM_Numeric GUM_SCALAR>

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

overridevirtual

See gum::PRMClassElement::elt_type().

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

Definition at line 84 of file PRMParameter_tpl.h.

                                                   {
      return PRMClassElement< GUM_SCALAR >::ClassElementType::prm_parameter;
    }

References gum::prm::PRMClassElement< GUM_SCALAR >::prm_parameter.

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.

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

PRMAttribute< GUM_SCALAR > * gum::prm::PRMParameter< GUM_SCALAR >::getCastDescendant ( ) const

overridevirtual

Raise a gum::OperationNotAllowed See gum::PRMClassElement::getCastDescendant().

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

Definition at line 135 of file PRMParameter_tpl.h.

                                                                                    {
      GUM_ERROR(OperationNotAllowed, "Parameters can have cast descendants")
    }

References GUM_ERROR.

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.

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

staticinherited

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 )

staticinherited

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 )

staticinherited

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 )

staticinherited

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 )

staticinherited

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

overridevirtualinherited

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

template<GUM_Numeric GUM_SCALAR>

PRMParameter< GUM_SCALAR > & gum::prm::PRMParameter< GUM_SCALAR >::operator= ( const PRMParameter< GUM_SCALAR > & from )

protected

Copy operator. Don't use it.

Definition at line 73 of file PRMParameter_tpl.h.

                                                                                  {
      GUM_ERROR(OperationNotAllowed, "cannot copy Paramter<GUM_SCALAR")
    }

References PRMParameter(), and GUM_ERROR.

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

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.

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

virtualinherited

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>

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

overridevirtual

See gum::PRMClassElement::type().

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

Definition at line 110 of file PRMParameter_tpl.h.

                                                          {
      GUM_ERROR(OperationNotAllowed, "Parameters do not have a type")
    }

References GUM_ERROR.

type() [2/2]

template<GUM_Numeric GUM_SCALAR>

PRMType & gum::prm::PRMParameter< GUM_SCALAR >::type ( )

overridevirtual

See gum::PRMClassElement::type().

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

Definition at line 105 of file PRMParameter_tpl.h.

                                              {
      GUM_ERROR(OperationNotAllowed, "Parameters do not have a type")
    }

References GUM_ERROR.

Referenced by PRMParameter().

Here is the caller graph for this function:

value() [1/2]

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::prm::PRMParameter< GUM_SCALAR >::value

(

)

const

See gum::PRMClassElement::elt_type().

Definition at line 89 of file PRMParameter_tpl.h.

                                                       {
      return _value_;
    }

References _value_.

Referenced by PRMParameter(), PRMParameter(), and value().

Here is the caller graph for this function:

value() [2/2]

template<GUM_Numeric GUM_SCALAR>

void gum::prm::PRMParameter< GUM_SCALAR >::value

(

GUM_SCALAR

value

)

See gum::PRMClassElement::elt_type().

Definition at line 94 of file PRMParameter_tpl.h.

                                                           {
      _value_ = value;
    }

References _value_, and value().

Here is the call graph for this function:

valueType()

template<GUM_Numeric GUM_SCALAR>

PRMParameter< GUM_SCALAR >::ParameterType gum::prm::PRMParameter< GUM_SCALAR >::valueType

(

)

const

See gum::PRMClassElement::elt_type().

Definition at line 100 of file PRMParameter_tpl.h.

                                                    {
      return _type_;
    }

References _type_.

Referenced by PRMParameter(), gum::prm::PRMClass< GUM_SCALAR >::_checkOverloadLegality_(), and gum::prm::PRMFactory< GUM_SCALAR >::addInstance().

Here is the caller graph for this function:

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

_type_

template<GUM_Numeric GUM_SCALAR>

ParameterType gum::prm::PRMParameter< GUM_SCALAR >::_type_

private

Definition at line 141 of file PRMParameter.h.

Referenced by PRMParameter(), PRMParameter(), and valueType().

_value_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::prm::PRMParameter< GUM_SCALAR >::_value_

private

Definition at line 143 of file PRMParameter.h.

Referenced by PRMParameter(), PRMParameter(), value(), and value().

safeName_

template<GUM_Numeric GUM_SCALAR>

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

protectedinherited

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/PRMParameter.h
• agrum/PRM/elements/PRMParameter_tpl.h